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[Union[ChannelTypeDef, ChannelOutputTypeDef]],  # (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: Union[datetime, str] = ...,
    frameMetrics: Sequence[Union[FrameMetricTypeDef, FrameMetricOutputTypeDef]] = ...,  # (1)
    period: str = ...,
    startTime: Union[datetime, str] = ...,
    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: Union[datetime, str] = ...,
    maxDepth: int = ...,
    period: str = ...,
    startTime: Union[datetime, str] = ...,
) -> GetProfileResponseTypeDef:  # (1)
    ...
  1. See GetProfileResponseTypeDef
# get_profile method usage example with argument unpacking

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

parent.get_profile(**kwargs)
  1. See