Skip to content

CodeGuruProfilerClient#

Index > CodeGuruProfiler > CodeGuruProfilerClient

Auto-generated documentation for CodeGuruProfiler type annotations stubs module mypy-boto3-codeguruprofiler.

CodeGuruProfilerClient#

Type annotations and code completion for boto3.client("codeguruprofiler"). boto3 documentation

# CodeGuruProfilerClient usage example

from boto3.session import Session
from mypy_boto3_codeguruprofiler.client import CodeGuruProfilerClient

def get_codeguruprofiler_client() -> CodeGuruProfilerClient:
    return Session().client("codeguruprofiler")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("codeguruprofiler").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("codeguruprofiler")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_codeguruprofiler.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

add_notification_channels#

Add up to 2 anomaly notifications channels for a profiling group.

Type annotations and code completion for boto3.client("codeguruprofiler").add_notification_channels method. boto3 documentation

# add_notification_channels method definition

def add_notification_channels(
    self,
    *,
    channels: Sequence[ChannelUnionTypeDef],  # (1)
    profilingGroupName: str,
) -> AddNotificationChannelsResponseTypeDef:  # (2)
    ...
  1. See ChannelTypeDef ChannelOutputTypeDef
  2. See AddNotificationChannelsResponseTypeDef 
# add_notification_channels method usage example with argument unpacking

kwargs: AddNotificationChannelsRequestRequestTypeDef = {  # (1)
    "channels": ...,
    "profilingGroupName": ...,
}

parent.add_notification_channels(**kwargs)
  1. See AddNotificationChannelsRequestRequestTypeDef

batch_get_frame_metric_data#

Returns the time series of values for a requested list of frame metrics from a time period.

Type annotations and code completion for boto3.client("codeguruprofiler").batch_get_frame_metric_data method. boto3 documentation

# batch_get_frame_metric_data method definition

def batch_get_frame_metric_data(
    self,
    *,
    profilingGroupName: str,
    endTime: TimestampTypeDef = ...,
    frameMetrics: Sequence[FrameMetricUnionTypeDef] = ...,  # (1)
    period: str = ...,
    startTime: TimestampTypeDef = ...,
    targetResolution: AggregationPeriodType = ...,  # (2)
) -> BatchGetFrameMetricDataResponseTypeDef:  # (3)
    ...
  1. See FrameMetricTypeDef FrameMetricOutputTypeDef
  2. See AggregationPeriodType
  3. See BatchGetFrameMetricDataResponseTypeDef 
# batch_get_frame_metric_data method usage example with argument unpacking

kwargs: BatchGetFrameMetricDataRequestRequestTypeDef = {  # (1)
    "profilingGroupName": ...,
}

parent.batch_get_frame_metric_data(**kwargs)
  1. See BatchGetFrameMetricDataRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("codeguruprofiler").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("codeguruprofiler").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

configure_agent#

Used by profiler agents to report their current state and to receive remote configuration updates.

Type annotations and code completion for boto3.client("codeguruprofiler").configure_agent method. boto3 documentation

# configure_agent method definition

def configure_agent(
    self,
    *,
    profilingGroupName: str,
    fleetInstanceId: str = ...,
    metadata: Mapping[MetadataFieldType, str] = ...,  # (1)
) -> ConfigureAgentResponseTypeDef:  # (2)
    ...
  1. See MetadataFieldType
  2. See ConfigureAgentResponseTypeDef 
# configure_agent method usage example with argument unpacking

kwargs: ConfigureAgentRequestRequestTypeDef = {  # (1)
    "profilingGroupName": ...,
}

parent.configure_agent(**kwargs)
  1. See ConfigureAgentRequestRequestTypeDef

create_profiling_group#

Creates a profiling group.

Type annotations and code completion for boto3.client("codeguruprofiler").create_profiling_group method. boto3 documentation

# create_profiling_group method definition

def create_profiling_group(
    self,
    *,
    clientToken: str,
    profilingGroupName: str,
    agentOrchestrationConfig: AgentOrchestrationConfigTypeDef = ...,  # (1)
    computePlatform: ComputePlatformType = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateProfilingGroupResponseTypeDef:  # (3)
    ...
  1. See AgentOrchestrationConfigTypeDef
  2. See ComputePlatformType
  3. See CreateProfilingGroupResponseTypeDef 
# create_profiling_group method usage example with argument unpacking

kwargs: CreateProfilingGroupRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
    "profilingGroupName": ...,
}

parent.create_profiling_group(**kwargs)
  1. See CreateProfilingGroupRequestRequestTypeDef

delete_profiling_group#

Deletes a profiling group.

Type annotations and code completion for boto3.client("codeguruprofiler").delete_profiling_group method. boto3 documentation

# delete_profiling_group method definition

def delete_profiling_group(
    self,
    *,
    profilingGroupName: str,
) -> Dict[str, Any]:
    ...
# delete_profiling_group method usage example with argument unpacking

kwargs: DeleteProfilingGroupRequestRequestTypeDef = {  # (1)
    "profilingGroupName": ...,
}

parent.delete_profiling_group(**kwargs)
  1. See DeleteProfilingGroupRequestRequestTypeDef

describe_profiling_group#

Returns a ProfilingGroupDescription object that contains information about the requested profiling group.

Type annotations and code completion for boto3.client("codeguruprofiler").describe_profiling_group method. boto3 documentation

# describe_profiling_group method definition

def describe_profiling_group(
    self,
    *,
    profilingGroupName: str,
) -> DescribeProfilingGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeProfilingGroupResponseTypeDef 
# describe_profiling_group method usage example with argument unpacking

kwargs: DescribeProfilingGroupRequestRequestTypeDef = {  # (1)
    "profilingGroupName": ...,
}

parent.describe_profiling_group(**kwargs)
  1. See DescribeProfilingGroupRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("codeguruprofiler").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_findings_report_account_summary#

Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.

Type annotations and code completion for boto3.client("codeguruprofiler").get_findings_report_account_summary method. boto3 documentation

# get_findings_report_account_summary method definition

def get_findings_report_account_summary(
    self,
    *,
    dailyReportsOnly: bool = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetFindingsReportAccountSummaryResponseTypeDef:  # (1)
    ...
  1. See GetFindingsReportAccountSummaryResponseTypeDef 
# get_findings_report_account_summary method usage example with argument unpacking

kwargs: GetFindingsReportAccountSummaryRequestRequestTypeDef = {  # (1)
    "dailyReportsOnly": ...,
}

parent.get_findings_report_account_summary(**kwargs)
  1. See GetFindingsReportAccountSummaryRequestRequestTypeDef

get_notification_configuration#

Get the current configuration for anomaly notifications for a profiling group.

Type annotations and code completion for boto3.client("codeguruprofiler").get_notification_configuration method. boto3 documentation

# get_notification_configuration method definition

def get_notification_configuration(
    self,
    *,
    profilingGroupName: str,
) -> GetNotificationConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetNotificationConfigurationResponseTypeDef 
# get_notification_configuration method usage example with argument unpacking

kwargs: GetNotificationConfigurationRequestRequestTypeDef = {  # (1)
    "profilingGroupName": ...,
}

parent.get_notification_configuration(**kwargs)
  1. See GetNotificationConfigurationRequestRequestTypeDef

get_policy#

Returns the JSON-formatted resource-based policy on a profiling group.

Type annotations and code completion for boto3.client("codeguruprofiler").get_policy method. boto3 documentation

# get_policy method definition

def get_policy(
    self,
    *,
    profilingGroupName: str,
) -> GetPolicyResponseTypeDef:  # (1)
    ...
  1. See GetPolicyResponseTypeDef 
# get_policy method usage example with argument unpacking

kwargs: GetPolicyRequestRequestTypeDef = {  # (1)
    "profilingGroupName": ...,
}

parent.get_policy(**kwargs)
  1. See GetPolicyRequestRequestTypeDef

get_profile#

Gets the aggregated profile of a profiling group for a specified time range.

Type annotations and code completion for boto3.client("codeguruprofiler").get_profile method. boto3 documentation

# get_profile method definition

def get_profile(
    self,
    *,
    profilingGroupName: str,
    accept: str = ...,
    endTime: TimestampTypeDef = ...,
    maxDepth: int = ...,
    period: str = ...,
    startTime: TimestampTypeDef = ...,
) -> GetProfileResponseTypeDef:  # (1)
    ...
  1. See GetProfileResponseTypeDef 
# get_profile method usage example with argument unpacking

kwargs: GetProfileRequestRequestTypeDef = {  # (1)
    "profilingGroupName": ...,
}

parent.get_profile(**kwargs)
  1. See GetProfileRequestRequestTypeDef

get_recommendations#

Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period.

Type annotations and code completion for boto3.client("codeguruprofiler").get_recommendations method. boto3 documentation

# get_recommendations method definition

def get_recommendations(
    self,
    *,
    endTime: TimestampTypeDef,
    profilingGroupName: str,
    startTime: TimestampTypeDef,
    locale: str = ...,
) -> GetRecommendationsResponseTypeDef:  # (1)
    ...
  1. See GetRecommendationsResponseTypeDef 
# get_recommendations method usage example with argument unpacking

kwargs: GetRecommendationsRequestRequestTypeDef = {  # (1)
    "endTime": ...,
    "profilingGroupName": ...,
    "startTime": ...,
}

parent.get_recommendations(**kwargs)
  1. See GetRecommendationsRequestRequestTypeDef

list_findings_reports#

List the available reports for a given profiling group and time range.

Type annotations and code completion for boto3.client("codeguruprofiler").list_findings_reports method. boto3 documentation

# list_findings_reports method definition

def list_findings_reports(
    self,
    *,
    endTime: TimestampTypeDef,
    profilingGroupName: str,
    startTime: TimestampTypeDef,
    dailyReportsOnly: bool = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFindingsReportsResponseTypeDef:  # (1)
    ...
  1. See ListFindingsReportsResponseTypeDef 
# list_findings_reports method usage example with argument unpacking

kwargs: ListFindingsReportsRequestRequestTypeDef = {  # (1)
    "endTime": ...,
    "profilingGroupName": ...,
    "startTime": ...,
}

parent.list_findings_reports(**kwargs)
  1. See ListFindingsReportsRequestRequestTypeDef

list_profile_times#

Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

Type annotations and code completion for boto3.client("codeguruprofiler").list_profile_times method. boto3 documentation

# list_profile_times method definition

def list_profile_times(
    self,
    *,
    endTime: TimestampTypeDef,
    period: AggregationPeriodType,  # (1)
    profilingGroupName: str,
    startTime: TimestampTypeDef,
    maxResults: int = ...,
    nextToken: str = ...,
    orderBy: OrderByType = ...,  # (2)
) -> ListProfileTimesResponseTypeDef:  # (3)
    ...
  1. See AggregationPeriodType
  2. See OrderByType
  3. See ListProfileTimesResponseTypeDef 
# list_profile_times method usage example with argument unpacking

kwargs: ListProfileTimesRequestRequestTypeDef = {  # (1)
    "endTime": ...,
    "period": ...,
    "profilingGroupName": ...,
    "startTime": ...,
}

parent.list_profile_times(**kwargs)
  1. See ListProfileTimesRequestRequestTypeDef

list_profiling_groups#

Returns a list of profiling groups.

Type annotations and code completion for boto3.client("codeguruprofiler").list_profiling_groups method. boto3 documentation

# list_profiling_groups method definition

def list_profiling_groups(
    self,
    *,
    includeDescription: bool = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListProfilingGroupsResponseTypeDef:  # (1)
    ...
  1. See ListProfilingGroupsResponseTypeDef 
# list_profiling_groups method usage example with argument unpacking

kwargs: ListProfilingGroupsRequestRequestTypeDef = {  # (1)
    "includeDescription": ...,
}

parent.list_profiling_groups(**kwargs)
  1. See ListProfilingGroupsRequestRequestTypeDef

list_tags_for_resource#

Returns a list of the tags that are assigned to a specified resource.

Type annotations and code completion for boto3.client("codeguruprofiler").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

post_agent_profile#

Submits profiling data to an aggregated profile of a profiling group.

Type annotations and code completion for boto3.client("codeguruprofiler").post_agent_profile method. boto3 documentation

# post_agent_profile method definition

def post_agent_profile(
    self,
    *,
    agentProfile: BlobTypeDef,
    contentType: str,
    profilingGroupName: str,
    profileToken: str = ...,
) -> Dict[str, Any]:
    ...
# post_agent_profile method usage example with argument unpacking

kwargs: PostAgentProfileRequestRequestTypeDef = {  # (1)
    "agentProfile": ...,
    "contentType": ...,
    "profilingGroupName": ...,
}

parent.post_agent_profile(**kwargs)
  1. See PostAgentProfileRequestRequestTypeDef

put_permission#

Adds permissions to a profiling group's resource-based policy that are provided using an action group.

Type annotations and code completion for boto3.client("codeguruprofiler").put_permission method. boto3 documentation

# put_permission method definition

def put_permission(
    self,
    *,
    actionGroup: ActionGroupType,  # (1)
    principals: Sequence[str],
    profilingGroupName: str,
    revisionId: str = ...,
) -> PutPermissionResponseTypeDef:  # (2)
    ...
  1. See ActionGroupType
  2. See PutPermissionResponseTypeDef 
# put_permission method usage example with argument unpacking

kwargs: PutPermissionRequestRequestTypeDef = {  # (1)
    "actionGroup": ...,
    "principals": ...,
    "profilingGroupName": ...,
}

parent.put_permission(**kwargs)
  1. See PutPermissionRequestRequestTypeDef

remove_notification_channel#

Remove one anomaly notifications channel for a profiling group.

Type annotations and code completion for boto3.client("codeguruprofiler").remove_notification_channel method. boto3 documentation

# remove_notification_channel method definition

def remove_notification_channel(
    self,
    *,
    channelId: str,
    profilingGroupName: str,
) -> RemoveNotificationChannelResponseTypeDef:  # (1)
    ...
  1. See RemoveNotificationChannelResponseTypeDef 
# remove_notification_channel method usage example with argument unpacking

kwargs: RemoveNotificationChannelRequestRequestTypeDef = {  # (1)
    "channelId": ...,
    "profilingGroupName": ...,
}

parent.remove_notification_channel(**kwargs)
  1. See RemoveNotificationChannelRequestRequestTypeDef

remove_permission#

Removes permissions from a profiling group's resource-based policy that are provided using an action group.

Type annotations and code completion for boto3.client("codeguruprofiler").remove_permission method. boto3 documentation

# remove_permission method definition

def remove_permission(
    self,
    *,
    actionGroup: ActionGroupType,  # (1)
    profilingGroupName: str,
    revisionId: str,
) -> RemovePermissionResponseTypeDef:  # (2)
    ...
  1. See ActionGroupType
  2. See RemovePermissionResponseTypeDef 
# remove_permission method usage example with argument unpacking

kwargs: RemovePermissionRequestRequestTypeDef = {  # (1)
    "actionGroup": ...,
    "profilingGroupName": ...,
    "revisionId": ...,
}

parent.remove_permission(**kwargs)
  1. See RemovePermissionRequestRequestTypeDef

submit_feedback#

Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.

Type annotations and code completion for boto3.client("codeguruprofiler").submit_feedback method. boto3 documentation

# submit_feedback method definition

def submit_feedback(
    self,
    *,
    anomalyInstanceId: str,
    profilingGroupName: str,
    type: FeedbackTypeType,  # (1)
    comment: str = ...,
) -> Dict[str, Any]:
    ...
  1. See FeedbackTypeType 
# submit_feedback method usage example with argument unpacking

kwargs: SubmitFeedbackRequestRequestTypeDef = {  # (1)
    "anomalyInstanceId": ...,
    "profilingGroupName": ...,
    "type": ...,
}

parent.submit_feedback(**kwargs)
  1. See SubmitFeedbackRequestRequestTypeDef

tag_resource#

Use to assign one or more tags to a resource.

Type annotations and code completion for boto3.client("codeguruprofiler").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Use to remove one or more tags from a resource.

Type annotations and code completion for boto3.client("codeguruprofiler").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_profiling_group#

Updates a profiling group.

Type annotations and code completion for boto3.client("codeguruprofiler").update_profiling_group method. boto3 documentation

# update_profiling_group method definition

def update_profiling_group(
    self,
    *,
    agentOrchestrationConfig: AgentOrchestrationConfigTypeDef,  # (1)
    profilingGroupName: str,
) -> UpdateProfilingGroupResponseTypeDef:  # (2)
    ...
  1. See AgentOrchestrationConfigTypeDef
  2. See UpdateProfilingGroupResponseTypeDef 
# update_profiling_group method usage example with argument unpacking

kwargs: UpdateProfilingGroupRequestRequestTypeDef = {  # (1)
    "agentOrchestrationConfig": ...,
    "profilingGroupName": ...,
}

parent.update_profiling_group(**kwargs)
  1. See UpdateProfilingGroupRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("codeguruprofiler").get_paginator method with overloads.