Skip to content

Type definitions#

Index > CodeGuruProfiler > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

ChannelUnionTypeDef#

# ChannelUnionTypeDef definition

ChannelUnionTypeDef = Union[
    ChannelTypeDef,  # (1)
    ChannelOutputTypeDef,  # (2)
]
  1. See ChannelTypeDef
  2. See ChannelOutputTypeDef

FrameMetricUnionTypeDef#

# FrameMetricUnionTypeDef definition

FrameMetricUnionTypeDef = Union[
    FrameMetricTypeDef,  # (1)
    FrameMetricOutputTypeDef,  # (2)
]
  1. See FrameMetricTypeDef
  2. See FrameMetricOutputTypeDef

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

AgentConfigurationTypeDef#

# AgentConfigurationTypeDef definition

class AgentConfigurationTypeDef(TypedDict):
    periodInSeconds: int,
    shouldProfile: bool,
    agentParameters: NotRequired[dict[AgentParameterFieldType, str]],  # (1)
  1. See AgentParameterFieldType

AgentOrchestrationConfigTypeDef#

# AgentOrchestrationConfigTypeDef definition

class AgentOrchestrationConfigTypeDef(TypedDict):
    profilingEnabled: bool,

AggregatedProfileTimeTypeDef#

# AggregatedProfileTimeTypeDef definition

class AggregatedProfileTimeTypeDef(TypedDict):
    period: NotRequired[AggregationPeriodType],  # (1)
    start: NotRequired[datetime],
  1. See AggregationPeriodType

UserFeedbackTypeDef#

# UserFeedbackTypeDef definition

class UserFeedbackTypeDef(TypedDict):
    type: FeedbackTypeType,  # (1)
  1. See FeedbackTypeType

MetricTypeDef#

# MetricTypeDef definition

class MetricTypeDef(TypedDict):
    frameName: str,
    threadStates: list[str],
    type: MetricTypeType,  # (1)
  1. See MetricTypeType

TimestampStructureTypeDef#

# TimestampStructureTypeDef definition

class TimestampStructureTypeDef(TypedDict):
    value: datetime,

ChannelOutputTypeDef#

# ChannelOutputTypeDef definition

class ChannelOutputTypeDef(TypedDict):
    eventPublishers: list[EventPublisherType],  # (1)
    uri: str,
    id: NotRequired[str],
  1. See EventPublisherType

ChannelTypeDef#

# ChannelTypeDef definition

class ChannelTypeDef(TypedDict):
    eventPublishers: Sequence[EventPublisherType],  # (1)
    uri: str,
    id: NotRequired[str],
  1. See EventPublisherType

ConfigureAgentRequestRequestTypeDef#

# ConfigureAgentRequestRequestTypeDef definition

class ConfigureAgentRequestRequestTypeDef(TypedDict):
    profilingGroupName: str,
    fleetInstanceId: NotRequired[str],
    metadata: NotRequired[Mapping[MetadataFieldType, str]],  # (1)
  1. See MetadataFieldType

DeleteProfilingGroupRequestRequestTypeDef#

# DeleteProfilingGroupRequestRequestTypeDef definition

class DeleteProfilingGroupRequestRequestTypeDef(TypedDict):
    profilingGroupName: str,

DescribeProfilingGroupRequestRequestTypeDef#

# DescribeProfilingGroupRequestRequestTypeDef definition

class DescribeProfilingGroupRequestRequestTypeDef(TypedDict):
    profilingGroupName: str,

FindingsReportSummaryTypeDef#

# FindingsReportSummaryTypeDef definition

class FindingsReportSummaryTypeDef(TypedDict):
    id: NotRequired[str],
    profileEndTime: NotRequired[datetime],
    profileStartTime: NotRequired[datetime],
    profilingGroupName: NotRequired[str],
    totalNumberOfFindings: NotRequired[int],

FrameMetricOutputTypeDef#

# FrameMetricOutputTypeDef definition

class FrameMetricOutputTypeDef(TypedDict):
    frameName: str,
    threadStates: list[str],
    type: MetricTypeType,  # (1)
  1. See MetricTypeType

FrameMetricTypeDef#

# FrameMetricTypeDef definition

class FrameMetricTypeDef(TypedDict):
    frameName: str,
    threadStates: Sequence[str],
    type: MetricTypeType,  # (1)
  1. See MetricTypeType

GetFindingsReportAccountSummaryRequestRequestTypeDef#

# GetFindingsReportAccountSummaryRequestRequestTypeDef definition

class GetFindingsReportAccountSummaryRequestRequestTypeDef(TypedDict):
    dailyReportsOnly: NotRequired[bool],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

GetNotificationConfigurationRequestRequestTypeDef#

# GetNotificationConfigurationRequestRequestTypeDef definition

class GetNotificationConfigurationRequestRequestTypeDef(TypedDict):
    profilingGroupName: str,

GetPolicyRequestRequestTypeDef#

# GetPolicyRequestRequestTypeDef definition

class GetPolicyRequestRequestTypeDef(TypedDict):
    profilingGroupName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ProfileTimeTypeDef#

# ProfileTimeTypeDef definition

class ProfileTimeTypeDef(TypedDict):
    start: NotRequired[datetime],

ListProfilingGroupsRequestRequestTypeDef#

# ListProfilingGroupsRequestRequestTypeDef definition

class ListProfilingGroupsRequestRequestTypeDef(TypedDict):
    includeDescription: NotRequired[bool],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

MatchTypeDef#

# MatchTypeDef definition

class MatchTypeDef(TypedDict):
    frameAddress: NotRequired[str],
    targetFramesIndex: NotRequired[int],
    thresholdBreachValue: NotRequired[float],

PatternTypeDef#

# PatternTypeDef definition

class PatternTypeDef(TypedDict):
    countersToAggregate: NotRequired[list[str]],
    description: NotRequired[str],
    id: NotRequired[str],
    name: NotRequired[str],
    resolutionSteps: NotRequired[str],
    targetFrames: NotRequired[list[list[str]]],
    thresholdPercent: NotRequired[float],

PutPermissionRequestRequestTypeDef#

# PutPermissionRequestRequestTypeDef definition

class PutPermissionRequestRequestTypeDef(TypedDict):
    actionGroup: ActionGroupType,  # (1)
    principals: Sequence[str],
    profilingGroupName: str,
    revisionId: NotRequired[str],
  1. See ActionGroupType

RemoveNotificationChannelRequestRequestTypeDef#

# RemoveNotificationChannelRequestRequestTypeDef definition

class RemoveNotificationChannelRequestRequestTypeDef(TypedDict):
    channelId: str,
    profilingGroupName: str,

RemovePermissionRequestRequestTypeDef#

# RemovePermissionRequestRequestTypeDef definition

class RemovePermissionRequestRequestTypeDef(TypedDict):
    actionGroup: ActionGroupType,  # (1)
    profilingGroupName: str,
    revisionId: str,
  1. See ActionGroupType

SubmitFeedbackRequestRequestTypeDef#

# SubmitFeedbackRequestRequestTypeDef definition

class SubmitFeedbackRequestRequestTypeDef(TypedDict):
    anomalyInstanceId: str,
    profilingGroupName: str,
    type: FeedbackTypeType,  # (1)
    comment: NotRequired[str],
  1. See FeedbackTypeType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

GetPolicyResponseTypeDef#

# GetPolicyResponseTypeDef definition

class GetPolicyResponseTypeDef(TypedDict):
    policy: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetProfileResponseTypeDef#

# GetProfileResponseTypeDef definition

class GetProfileResponseTypeDef(TypedDict):
    contentEncoding: str,
    contentType: str,
    profile: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutPermissionResponseTypeDef#

# PutPermissionResponseTypeDef definition

class PutPermissionResponseTypeDef(TypedDict):
    policy: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RemovePermissionResponseTypeDef#

# RemovePermissionResponseTypeDef definition

class RemovePermissionResponseTypeDef(TypedDict):
    policy: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ConfigureAgentResponseTypeDef#

# ConfigureAgentResponseTypeDef definition

class ConfigureAgentResponseTypeDef(TypedDict):
    configuration: AgentConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentConfigurationTypeDef
  2. See ResponseMetadataTypeDef

CreateProfilingGroupRequestRequestTypeDef#

# CreateProfilingGroupRequestRequestTypeDef definition

class CreateProfilingGroupRequestRequestTypeDef(TypedDict):
    clientToken: str,
    profilingGroupName: str,
    agentOrchestrationConfig: NotRequired[AgentOrchestrationConfigTypeDef],  # (1)
    computePlatform: NotRequired[ComputePlatformType],  # (2)
    tags: NotRequired[Mapping[str, str]],
  1. See AgentOrchestrationConfigTypeDef
  2. See ComputePlatformType

UpdateProfilingGroupRequestRequestTypeDef#

# UpdateProfilingGroupRequestRequestTypeDef definition

class UpdateProfilingGroupRequestRequestTypeDef(TypedDict):
    agentOrchestrationConfig: AgentOrchestrationConfigTypeDef,  # (1)
    profilingGroupName: str,
  1. See AgentOrchestrationConfigTypeDef

ProfilingStatusTypeDef#

# ProfilingStatusTypeDef definition

class ProfilingStatusTypeDef(TypedDict):
    latestAgentOrchestratedAt: NotRequired[datetime],
    latestAgentProfileReportedAt: NotRequired[datetime],
    latestAggregatedProfile: NotRequired[AggregatedProfileTimeTypeDef],  # (1)
  1. See AggregatedProfileTimeTypeDef

AnomalyInstanceTypeDef#

# AnomalyInstanceTypeDef definition

class AnomalyInstanceTypeDef(TypedDict):
    id: str,
    startTime: datetime,
    endTime: NotRequired[datetime],
    userFeedback: NotRequired[UserFeedbackTypeDef],  # (1)
  1. See UserFeedbackTypeDef

GetProfileRequestRequestTypeDef#

# GetProfileRequestRequestTypeDef definition

class GetProfileRequestRequestTypeDef(TypedDict):
    profilingGroupName: str,
    accept: NotRequired[str],
    endTime: NotRequired[TimestampTypeDef],
    maxDepth: NotRequired[int],
    period: NotRequired[str],
    startTime: NotRequired[TimestampTypeDef],

GetRecommendationsRequestRequestTypeDef#

# GetRecommendationsRequestRequestTypeDef definition

class GetRecommendationsRequestRequestTypeDef(TypedDict):
    endTime: TimestampTypeDef,
    profilingGroupName: str,
    startTime: TimestampTypeDef,
    locale: NotRequired[str],

ListFindingsReportsRequestRequestTypeDef#

# ListFindingsReportsRequestRequestTypeDef definition

class ListFindingsReportsRequestRequestTypeDef(TypedDict):
    endTime: TimestampTypeDef,
    profilingGroupName: str,
    startTime: TimestampTypeDef,
    dailyReportsOnly: NotRequired[bool],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListProfileTimesRequestRequestTypeDef#

# ListProfileTimesRequestRequestTypeDef definition

class ListProfileTimesRequestRequestTypeDef(TypedDict):
    endTime: TimestampTypeDef,
    period: AggregationPeriodType,  # (1)
    profilingGroupName: str,
    startTime: TimestampTypeDef,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    orderBy: NotRequired[OrderByType],  # (2)
  1. See AggregationPeriodType
  2. See OrderByType

PostAgentProfileRequestRequestTypeDef#

# PostAgentProfileRequestRequestTypeDef definition

class PostAgentProfileRequestRequestTypeDef(TypedDict):
    agentProfile: BlobTypeDef,
    contentType: str,
    profilingGroupName: str,
    profileToken: NotRequired[str],

NotificationConfigurationTypeDef#

# NotificationConfigurationTypeDef definition

class NotificationConfigurationTypeDef(TypedDict):
    channels: NotRequired[list[ChannelOutputTypeDef]],  # (1)
  1. See ChannelOutputTypeDef

GetFindingsReportAccountSummaryResponseTypeDef#

# GetFindingsReportAccountSummaryResponseTypeDef definition

class GetFindingsReportAccountSummaryResponseTypeDef(TypedDict):
    reportSummaries: list[FindingsReportSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FindingsReportSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListFindingsReportsResponseTypeDef#

# ListFindingsReportsResponseTypeDef definition

class ListFindingsReportsResponseTypeDef(TypedDict):
    findingsReportSummaries: list[FindingsReportSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FindingsReportSummaryTypeDef
  2. See ResponseMetadataTypeDef

FrameMetricDatumTypeDef#

# FrameMetricDatumTypeDef definition

class FrameMetricDatumTypeDef(TypedDict):
    frameMetric: FrameMetricOutputTypeDef,  # (1)
    values: list[float],
  1. See FrameMetricOutputTypeDef

ListProfileTimesRequestPaginateTypeDef#

# ListProfileTimesRequestPaginateTypeDef definition

class ListProfileTimesRequestPaginateTypeDef(TypedDict):
    endTime: TimestampTypeDef,
    period: AggregationPeriodType,  # (1)
    profilingGroupName: str,
    startTime: TimestampTypeDef,
    orderBy: NotRequired[OrderByType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See AggregationPeriodType
  2. See OrderByType
  3. See PaginatorConfigTypeDef

ListProfileTimesResponseTypeDef#

# ListProfileTimesResponseTypeDef definition

class ListProfileTimesResponseTypeDef(TypedDict):
    profileTimes: list[ProfileTimeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ProfileTimeTypeDef
  2. See ResponseMetadataTypeDef

RecommendationTypeDef#

# RecommendationTypeDef definition

class RecommendationTypeDef(TypedDict):
    allMatchesCount: int,
    allMatchesSum: float,
    endTime: datetime,
    pattern: PatternTypeDef,  # (1)
    startTime: datetime,
    topMatches: list[MatchTypeDef],  # (2)
  1. See PatternTypeDef
  2. See MatchTypeDef

ProfilingGroupDescriptionTypeDef#

# ProfilingGroupDescriptionTypeDef definition

class ProfilingGroupDescriptionTypeDef(TypedDict):
    agentOrchestrationConfig: NotRequired[AgentOrchestrationConfigTypeDef],  # (1)
    arn: NotRequired[str],
    computePlatform: NotRequired[ComputePlatformType],  # (2)
    createdAt: NotRequired[datetime],
    name: NotRequired[str],
    profilingStatus: NotRequired[ProfilingStatusTypeDef],  # (3)
    tags: NotRequired[dict[str, str]],
    updatedAt: NotRequired[datetime],
  1. See AgentOrchestrationConfigTypeDef
  2. See ComputePlatformType
  3. See ProfilingStatusTypeDef

AnomalyTypeDef#

# AnomalyTypeDef definition

class AnomalyTypeDef(TypedDict):
    instances: list[AnomalyInstanceTypeDef],  # (1)
    metric: MetricTypeDef,  # (2)
    reason: str,
  1. See AnomalyInstanceTypeDef
  2. See MetricTypeDef

AddNotificationChannelsResponseTypeDef#

# AddNotificationChannelsResponseTypeDef definition

class AddNotificationChannelsResponseTypeDef(TypedDict):
    notificationConfiguration: NotificationConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotificationConfigurationTypeDef
  2. See ResponseMetadataTypeDef

GetNotificationConfigurationResponseTypeDef#

# GetNotificationConfigurationResponseTypeDef definition

class GetNotificationConfigurationResponseTypeDef(TypedDict):
    notificationConfiguration: NotificationConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotificationConfigurationTypeDef
  2. See ResponseMetadataTypeDef

RemoveNotificationChannelResponseTypeDef#

# RemoveNotificationChannelResponseTypeDef definition

class RemoveNotificationChannelResponseTypeDef(TypedDict):
    notificationConfiguration: NotificationConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotificationConfigurationTypeDef
  2. See ResponseMetadataTypeDef

AddNotificationChannelsRequestRequestTypeDef#

# AddNotificationChannelsRequestRequestTypeDef definition

class AddNotificationChannelsRequestRequestTypeDef(TypedDict):
    channels: Sequence[ChannelUnionTypeDef],  # (1)
    profilingGroupName: str,
  1. See ChannelTypeDef ChannelOutputTypeDef

BatchGetFrameMetricDataResponseTypeDef#

# BatchGetFrameMetricDataResponseTypeDef definition

class BatchGetFrameMetricDataResponseTypeDef(TypedDict):
    endTime: datetime,
    endTimes: list[TimestampStructureTypeDef],  # (1)
    frameMetricData: list[FrameMetricDatumTypeDef],  # (2)
    resolution: AggregationPeriodType,  # (3)
    startTime: datetime,
    unprocessedEndTimes: dict[str, list[TimestampStructureTypeDef]],  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See TimestampStructureTypeDef
  2. See FrameMetricDatumTypeDef
  3. See AggregationPeriodType
  4. See TimestampStructureTypeDef
  5. See ResponseMetadataTypeDef

BatchGetFrameMetricDataRequestRequestTypeDef#

# BatchGetFrameMetricDataRequestRequestTypeDef definition

class BatchGetFrameMetricDataRequestRequestTypeDef(TypedDict):
    profilingGroupName: str,
    endTime: NotRequired[TimestampTypeDef],
    frameMetrics: NotRequired[Sequence[FrameMetricUnionTypeDef]],  # (1)
    period: NotRequired[str],
    startTime: NotRequired[TimestampTypeDef],
    targetResolution: NotRequired[AggregationPeriodType],  # (2)
  1. See FrameMetricTypeDef FrameMetricOutputTypeDef
  2. See AggregationPeriodType

CreateProfilingGroupResponseTypeDef#

# CreateProfilingGroupResponseTypeDef definition

class CreateProfilingGroupResponseTypeDef(TypedDict):
    profilingGroup: ProfilingGroupDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProfilingGroupDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DescribeProfilingGroupResponseTypeDef#

# DescribeProfilingGroupResponseTypeDef definition

class DescribeProfilingGroupResponseTypeDef(TypedDict):
    profilingGroup: ProfilingGroupDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProfilingGroupDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListProfilingGroupsResponseTypeDef#

# ListProfilingGroupsResponseTypeDef definition

class ListProfilingGroupsResponseTypeDef(TypedDict):
    profilingGroupNames: list[str],
    profilingGroups: list[ProfilingGroupDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ProfilingGroupDescriptionTypeDef
  2. See ResponseMetadataTypeDef

UpdateProfilingGroupResponseTypeDef#

# UpdateProfilingGroupResponseTypeDef definition

class UpdateProfilingGroupResponseTypeDef(TypedDict):
    profilingGroup: ProfilingGroupDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProfilingGroupDescriptionTypeDef
  2. See ResponseMetadataTypeDef

GetRecommendationsResponseTypeDef#

# GetRecommendationsResponseTypeDef definition

class GetRecommendationsResponseTypeDef(TypedDict):
    anomalies: list[AnomalyTypeDef],  # (1)
    profileEndTime: datetime,
    profileStartTime: datetime,
    profilingGroupName: str,
    recommendations: list[RecommendationTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AnomalyTypeDef
  2. See RecommendationTypeDef
  3. See ResponseMetadataTypeDef