Type definitions#
Auto-generated documentation for XRay type annotations stubs module mypy-boto3-xray.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AliasTypeDef#
# AliasTypeDef definition
class AliasTypeDef(TypedDict):
Name: NotRequired[str],
Names: NotRequired[list[str]],
Type: NotRequired[str],
AnnotationValueTypeDef#
# AnnotationValueTypeDef definition
class AnnotationValueTypeDef(TypedDict):
NumberValue: NotRequired[float],
BooleanValue: NotRequired[bool],
StringValue: NotRequired[str],
ServiceIdTypeDef#
# ServiceIdTypeDef definition
class ServiceIdTypeDef(TypedDict):
Name: NotRequired[str],
Names: NotRequired[list[str]],
AccountId: NotRequired[str],
Type: NotRequired[str],
AvailabilityZoneDetailTypeDef#
# AvailabilityZoneDetailTypeDef definition
class AvailabilityZoneDetailTypeDef(TypedDict):
Name: NotRequired[str],
BackendConnectionErrorsTypeDef#
# BackendConnectionErrorsTypeDef definition
class BackendConnectionErrorsTypeDef(TypedDict):
TimeoutCount: NotRequired[int],
ConnectionRefusedCount: NotRequired[int],
HTTPCode4XXCount: NotRequired[int],
HTTPCode5XXCount: NotRequired[int],
UnknownHostCount: NotRequired[int],
OtherCount: NotRequired[int],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
BatchGetTracesRequestRequestTypeDef#
# BatchGetTracesRequestRequestTypeDef definition
class BatchGetTracesRequestRequestTypeDef(TypedDict):
TraceIds: Sequence[str],
NextToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
CancelTraceRetrievalRequestRequestTypeDef#
# CancelTraceRetrievalRequestRequestTypeDef definition
class CancelTraceRetrievalRequestRequestTypeDef(TypedDict):
RetrievalToken: str,
InsightsConfigurationTypeDef#
# InsightsConfigurationTypeDef definition
class InsightsConfigurationTypeDef(TypedDict):
InsightsEnabled: NotRequired[bool],
NotificationsEnabled: NotRequired[bool],
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
SamplingRuleTypeDef#
# SamplingRuleTypeDef definition
class SamplingRuleTypeDef(TypedDict):
ResourceARN: str,
Priority: int,
FixedRate: float,
ReservoirSize: int,
ServiceName: str,
ServiceType: str,
Host: str,
HTTPMethod: str,
URLPath: str,
Version: int,
RuleName: NotRequired[str],
RuleARN: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
DeleteGroupRequestRequestTypeDef#
# DeleteGroupRequestRequestTypeDef definition
class DeleteGroupRequestRequestTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
DeleteResourcePolicyRequestRequestTypeDef#
# DeleteResourcePolicyRequestRequestTypeDef definition
class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
PolicyName: str,
PolicyRevisionId: NotRequired[str],
DeleteSamplingRuleRequestRequestTypeDef#
# DeleteSamplingRuleRequestRequestTypeDef definition
class DeleteSamplingRuleRequestRequestTypeDef(TypedDict):
RuleName: NotRequired[str],
RuleARN: NotRequired[str],
ErrorStatisticsTypeDef#
# ErrorStatisticsTypeDef definition
class ErrorStatisticsTypeDef(TypedDict):
ThrottleCount: NotRequired[int],
OtherCount: NotRequired[int],
TotalCount: NotRequired[int],
FaultStatisticsTypeDef#
# FaultStatisticsTypeDef definition
class FaultStatisticsTypeDef(TypedDict):
OtherCount: NotRequired[int],
TotalCount: NotRequired[int],
HistogramEntryTypeDef#
# HistogramEntryTypeDef definition
class HistogramEntryTypeDef(TypedDict):
Value: NotRequired[float],
Count: NotRequired[int],
EncryptionConfigTypeDef#
# EncryptionConfigTypeDef definition
class EncryptionConfigTypeDef(TypedDict):
KeyId: NotRequired[str],
Status: NotRequired[EncryptionStatusType], # (1)
Type: NotRequired[EncryptionTypeType], # (2)
RootCauseExceptionTypeDef#
# RootCauseExceptionTypeDef definition
class RootCauseExceptionTypeDef(TypedDict):
Name: NotRequired[str],
Message: NotRequired[str],
ForecastStatisticsTypeDef#
# ForecastStatisticsTypeDef definition
class ForecastStatisticsTypeDef(TypedDict):
FaultCountHigh: NotRequired[int],
FaultCountLow: NotRequired[int],
GetGroupRequestRequestTypeDef#
# GetGroupRequestRequestTypeDef definition
class GetGroupRequestRequestTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
GetGroupsRequestRequestTypeDef#
# GetGroupsRequestRequestTypeDef definition
class GetGroupsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
GetIndexingRulesRequestRequestTypeDef#
# GetIndexingRulesRequestRequestTypeDef definition
class GetIndexingRulesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
GetInsightEventsRequestRequestTypeDef#
# GetInsightEventsRequestRequestTypeDef definition
class GetInsightEventsRequestRequestTypeDef(TypedDict):
InsightId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetInsightRequestRequestTypeDef#
# GetInsightRequestRequestTypeDef definition
class GetInsightRequestRequestTypeDef(TypedDict):
InsightId: str,
GetRetrievedTracesGraphRequestRequestTypeDef#
# GetRetrievedTracesGraphRequestRequestTypeDef definition
class GetRetrievedTracesGraphRequestRequestTypeDef(TypedDict):
RetrievalToken: str,
NextToken: NotRequired[str],
GetSamplingRulesRequestRequestTypeDef#
# GetSamplingRulesRequestRequestTypeDef definition
class GetSamplingRulesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
GetSamplingStatisticSummariesRequestRequestTypeDef#
# GetSamplingStatisticSummariesRequestRequestTypeDef definition
class GetSamplingStatisticSummariesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
SamplingStatisticSummaryTypeDef#
# SamplingStatisticSummaryTypeDef definition
class SamplingStatisticSummaryTypeDef(TypedDict):
RuleName: NotRequired[str],
Timestamp: NotRequired[datetime],
RequestCount: NotRequired[int],
BorrowCount: NotRequired[int],
SampledCount: NotRequired[int],
SamplingTargetDocumentTypeDef#
# SamplingTargetDocumentTypeDef definition
class SamplingTargetDocumentTypeDef(TypedDict):
RuleName: NotRequired[str],
FixedRate: NotRequired[float],
ReservoirQuota: NotRequired[int],
ReservoirQuotaTTL: NotRequired[datetime],
Interval: NotRequired[int],
UnprocessedStatisticsTypeDef#
# UnprocessedStatisticsTypeDef definition
class UnprocessedStatisticsTypeDef(TypedDict):
RuleName: NotRequired[str],
ErrorCode: NotRequired[str],
Message: NotRequired[str],
GetTraceGraphRequestRequestTypeDef#
# GetTraceGraphRequestRequestTypeDef definition
class GetTraceGraphRequestRequestTypeDef(TypedDict):
TraceIds: Sequence[str],
NextToken: NotRequired[str],
SamplingStrategyTypeDef#
# SamplingStrategyTypeDef definition
class SamplingStrategyTypeDef(TypedDict):
Name: NotRequired[SamplingStrategyNameType], # (1)
Value: NotRequired[float],
GraphLinkTypeDef#
# GraphLinkTypeDef definition
class GraphLinkTypeDef(TypedDict):
ReferenceType: NotRequired[str],
SourceTraceId: NotRequired[str],
DestinationTraceIds: NotRequired[list[str]],
HttpTypeDef#
# HttpTypeDef definition
class HttpTypeDef(TypedDict):
HttpURL: NotRequired[str],
HttpStatus: NotRequired[int],
HttpMethod: NotRequired[str],
UserAgent: NotRequired[str],
ClientIp: NotRequired[str],
ProbabilisticRuleValueTypeDef#
# ProbabilisticRuleValueTypeDef definition
class ProbabilisticRuleValueTypeDef(TypedDict):
DesiredSamplingPercentage: float,
ActualSamplingPercentage: NotRequired[float],
ProbabilisticRuleValueUpdateTypeDef#
# ProbabilisticRuleValueUpdateTypeDef definition
class ProbabilisticRuleValueUpdateTypeDef(TypedDict):
DesiredSamplingPercentage: float,
RequestImpactStatisticsTypeDef#
# RequestImpactStatisticsTypeDef definition
class RequestImpactStatisticsTypeDef(TypedDict):
FaultCount: NotRequired[int],
OkCount: NotRequired[int],
TotalCount: NotRequired[int],
InsightImpactGraphEdgeTypeDef#
# InsightImpactGraphEdgeTypeDef definition
class InsightImpactGraphEdgeTypeDef(TypedDict):
ReferenceId: NotRequired[int],
InstanceIdDetailTypeDef#
# InstanceIdDetailTypeDef definition
class InstanceIdDetailTypeDef(TypedDict):
Id: NotRequired[str],
ListResourcePoliciesRequestRequestTypeDef#
# ListResourcePoliciesRequestRequestTypeDef definition
class ListResourcePoliciesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
ResourcePolicyTypeDef#
# ResourcePolicyTypeDef definition
class ResourcePolicyTypeDef(TypedDict):
PolicyName: NotRequired[str],
PolicyDocument: NotRequired[str],
PolicyRevisionId: NotRequired[str],
LastUpdatedTime: NotRequired[datetime],
ListRetrievedTracesRequestRequestTypeDef#
# ListRetrievedTracesRequestRequestTypeDef definition
class ListRetrievedTracesRequestRequestTypeDef(TypedDict):
RetrievalToken: str,
TraceFormat: NotRequired[TraceFormatTypeType], # (1)
NextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
NextToken: NotRequired[str],
PutEncryptionConfigRequestRequestTypeDef#
# PutEncryptionConfigRequestRequestTypeDef definition
class PutEncryptionConfigRequestRequestTypeDef(TypedDict):
Type: EncryptionTypeType, # (1)
KeyId: NotRequired[str],
PutResourcePolicyRequestRequestTypeDef#
# PutResourcePolicyRequestRequestTypeDef definition
class PutResourcePolicyRequestRequestTypeDef(TypedDict):
PolicyName: str,
PolicyDocument: str,
PolicyRevisionId: NotRequired[str],
BypassPolicyLockoutCheck: NotRequired[bool],
PutTraceSegmentsRequestRequestTypeDef#
# PutTraceSegmentsRequestRequestTypeDef definition
class PutTraceSegmentsRequestRequestTypeDef(TypedDict):
TraceSegmentDocuments: Sequence[str],
UnprocessedTraceSegmentTypeDef#
# UnprocessedTraceSegmentTypeDef definition
class UnprocessedTraceSegmentTypeDef(TypedDict):
Id: NotRequired[str],
ErrorCode: NotRequired[str],
Message: NotRequired[str],
ResourceARNDetailTypeDef#
# ResourceARNDetailTypeDef definition
class ResourceARNDetailTypeDef(TypedDict):
ARN: NotRequired[str],
ResponseTimeRootCauseEntityTypeDef#
# ResponseTimeRootCauseEntityTypeDef definition
class ResponseTimeRootCauseEntityTypeDef(TypedDict):
Name: NotRequired[str],
Coverage: NotRequired[float],
Remote: NotRequired[bool],
SpanTypeDef#
# SpanTypeDef definition
class SpanTypeDef(TypedDict):
Id: NotRequired[str],
Document: NotRequired[str],
SamplingRuleOutputTypeDef#
# SamplingRuleOutputTypeDef definition
class SamplingRuleOutputTypeDef(TypedDict):
ResourceARN: str,
Priority: int,
FixedRate: float,
ReservoirSize: int,
ServiceName: str,
ServiceType: str,
Host: str,
HTTPMethod: str,
URLPath: str,
Version: int,
RuleName: NotRequired[str],
RuleARN: NotRequired[str],
Attributes: NotRequired[dict[str, str]],
SamplingRuleUpdateTypeDef#
# SamplingRuleUpdateTypeDef definition
class SamplingRuleUpdateTypeDef(TypedDict):
RuleName: NotRequired[str],
RuleARN: NotRequired[str],
ResourceARN: NotRequired[str],
Priority: NotRequired[int],
FixedRate: NotRequired[float],
ReservoirSize: NotRequired[int],
Host: NotRequired[str],
ServiceName: NotRequired[str],
ServiceType: NotRequired[str],
HTTPMethod: NotRequired[str],
URLPath: NotRequired[str],
Attributes: NotRequired[Mapping[str, str]],
SegmentTypeDef#
# SegmentTypeDef definition
class SegmentTypeDef(TypedDict):
Id: NotRequired[str],
Document: NotRequired[str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateTraceSegmentDestinationRequestRequestTypeDef#
# UpdateTraceSegmentDestinationRequestRequestTypeDef definition
class UpdateTraceSegmentDestinationRequestRequestTypeDef(TypedDict):
Destination: NotRequired[TraceSegmentDestinationType], # (1)
AnomalousServiceTypeDef#
# AnomalousServiceTypeDef definition
class AnomalousServiceTypeDef(TypedDict):
ServiceId: NotRequired[ServiceIdTypeDef], # (1)
- See ServiceIdTypeDef
TraceUserTypeDef#
# TraceUserTypeDef definition
class TraceUserTypeDef(TypedDict):
UserName: NotRequired[str],
ServiceIds: NotRequired[list[ServiceIdTypeDef]], # (1)
- See ServiceIdTypeDef
ValueWithServiceIdsTypeDef#
# ValueWithServiceIdsTypeDef definition
class ValueWithServiceIdsTypeDef(TypedDict):
AnnotationValue: NotRequired[AnnotationValueTypeDef], # (1)
ServiceIds: NotRequired[list[ServiceIdTypeDef]], # (2)
BatchGetTracesRequestPaginateTypeDef#
# BatchGetTracesRequestPaginateTypeDef definition
class BatchGetTracesRequestPaginateTypeDef(TypedDict):
TraceIds: Sequence[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetGroupsRequestPaginateTypeDef#
# GetGroupsRequestPaginateTypeDef definition
class GetGroupsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSamplingRulesRequestPaginateTypeDef#
# GetSamplingRulesRequestPaginateTypeDef definition
class GetSamplingRulesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSamplingStatisticSummariesRequestPaginateTypeDef#
# GetSamplingStatisticSummariesRequestPaginateTypeDef definition
class GetSamplingStatisticSummariesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetTraceGraphRequestPaginateTypeDef#
# GetTraceGraphRequestPaginateTypeDef definition
class GetTraceGraphRequestPaginateTypeDef(TypedDict):
TraceIds: Sequence[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListResourcePoliciesRequestPaginateTypeDef#
# ListResourcePoliciesRequestPaginateTypeDef definition
class ListResourcePoliciesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceRequestPaginateTypeDef#
# ListTagsForResourceRequestPaginateTypeDef definition
class ListTagsForResourceRequestPaginateTypeDef(TypedDict):
ResourceARN: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetTraceSegmentDestinationResultTypeDef#
# GetTraceSegmentDestinationResultTypeDef definition
class GetTraceSegmentDestinationResultTypeDef(TypedDict):
Destination: TraceSegmentDestinationType, # (1)
Status: TraceSegmentDestinationStatusType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
StartTraceRetrievalResultTypeDef#
# StartTraceRetrievalResultTypeDef definition
class StartTraceRetrievalResultTypeDef(TypedDict):
RetrievalToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateTraceSegmentDestinationResultTypeDef#
# UpdateTraceSegmentDestinationResultTypeDef definition
class UpdateTraceSegmentDestinationResultTypeDef(TypedDict):
Destination: TraceSegmentDestinationType, # (1)
Status: TraceSegmentDestinationStatusType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GroupSummaryTypeDef#
# GroupSummaryTypeDef definition
class GroupSummaryTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
FilterExpression: NotRequired[str],
InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef], # (1)
GroupTypeDef#
# GroupTypeDef definition
class GroupTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
FilterExpression: NotRequired[str],
InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef], # (1)
UpdateGroupRequestRequestTypeDef#
# UpdateGroupRequestRequestTypeDef definition
class UpdateGroupRequestRequestTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
FilterExpression: NotRequired[str],
InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef], # (1)
CreateGroupRequestRequestTypeDef#
# CreateGroupRequestRequestTypeDef definition
class CreateGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
FilterExpression: NotRequired[str],
InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: list[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateSamplingRuleRequestRequestTypeDef#
# CreateSamplingRuleRequestRequestTypeDef definition
class CreateSamplingRuleRequestRequestTypeDef(TypedDict):
SamplingRule: SamplingRuleTypeDef, # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See SamplingRuleTypeDef
- See TagTypeDef
EdgeStatisticsTypeDef#
# EdgeStatisticsTypeDef definition
class EdgeStatisticsTypeDef(TypedDict):
OkCount: NotRequired[int],
ErrorStatistics: NotRequired[ErrorStatisticsTypeDef], # (1)
FaultStatistics: NotRequired[FaultStatisticsTypeDef], # (2)
TotalCount: NotRequired[int],
TotalResponseTime: NotRequired[float],
ServiceStatisticsTypeDef#
# ServiceStatisticsTypeDef definition
class ServiceStatisticsTypeDef(TypedDict):
OkCount: NotRequired[int],
ErrorStatistics: NotRequired[ErrorStatisticsTypeDef], # (1)
FaultStatistics: NotRequired[FaultStatisticsTypeDef], # (2)
TotalCount: NotRequired[int],
TotalResponseTime: NotRequired[float],
GetEncryptionConfigResultTypeDef#
# GetEncryptionConfigResultTypeDef definition
class GetEncryptionConfigResultTypeDef(TypedDict):
EncryptionConfig: EncryptionConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutEncryptionConfigResultTypeDef#
# PutEncryptionConfigResultTypeDef definition
class PutEncryptionConfigResultTypeDef(TypedDict):
EncryptionConfig: EncryptionConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ErrorRootCauseEntityTypeDef#
# ErrorRootCauseEntityTypeDef definition
class ErrorRootCauseEntityTypeDef(TypedDict):
Name: NotRequired[str],
Exceptions: NotRequired[list[RootCauseExceptionTypeDef]], # (1)
Remote: NotRequired[bool],
FaultRootCauseEntityTypeDef#
# FaultRootCauseEntityTypeDef definition
class FaultRootCauseEntityTypeDef(TypedDict):
Name: NotRequired[str],
Exceptions: NotRequired[list[RootCauseExceptionTypeDef]], # (1)
Remote: NotRequired[bool],
GetInsightImpactGraphRequestRequestTypeDef#
# GetInsightImpactGraphRequestRequestTypeDef definition
class GetInsightImpactGraphRequestRequestTypeDef(TypedDict):
InsightId: str,
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
NextToken: NotRequired[str],
GetInsightSummariesRequestRequestTypeDef#
# GetInsightSummariesRequestRequestTypeDef definition
class GetInsightSummariesRequestRequestTypeDef(TypedDict):
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
States: NotRequired[Sequence[InsightStateType]], # (1)
GroupARN: NotRequired[str],
GroupName: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
- See InsightStateType
GetServiceGraphRequestPaginateTypeDef#
# GetServiceGraphRequestPaginateTypeDef definition
class GetServiceGraphRequestPaginateTypeDef(TypedDict):
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetServiceGraphRequestRequestTypeDef#
# GetServiceGraphRequestRequestTypeDef definition
class GetServiceGraphRequestRequestTypeDef(TypedDict):
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
NextToken: NotRequired[str],
GetTimeSeriesServiceStatisticsRequestPaginateTypeDef#
# GetTimeSeriesServiceStatisticsRequestPaginateTypeDef definition
class GetTimeSeriesServiceStatisticsRequestPaginateTypeDef(TypedDict):
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
EntitySelectorExpression: NotRequired[str],
Period: NotRequired[int],
ForecastStatistics: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetTimeSeriesServiceStatisticsRequestRequestTypeDef#
# GetTimeSeriesServiceStatisticsRequestRequestTypeDef definition
class GetTimeSeriesServiceStatisticsRequestRequestTypeDef(TypedDict):
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
EntitySelectorExpression: NotRequired[str],
Period: NotRequired[int],
ForecastStatistics: NotRequired[bool],
NextToken: NotRequired[str],
SamplingStatisticsDocumentTypeDef#
# SamplingStatisticsDocumentTypeDef definition
class SamplingStatisticsDocumentTypeDef(TypedDict):
RuleName: str,
ClientID: str,
Timestamp: TimestampTypeDef,
RequestCount: int,
SampledCount: int,
BorrowCount: NotRequired[int],
StartTraceRetrievalRequestRequestTypeDef#
# StartTraceRetrievalRequestRequestTypeDef definition
class StartTraceRetrievalRequestRequestTypeDef(TypedDict):
TraceIds: Sequence[str],
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
TelemetryRecordTypeDef#
# TelemetryRecordTypeDef definition
class TelemetryRecordTypeDef(TypedDict):
Timestamp: TimestampTypeDef,
SegmentsReceivedCount: NotRequired[int],
SegmentsSentCount: NotRequired[int],
SegmentsSpilloverCount: NotRequired[int],
SegmentsRejectedCount: NotRequired[int],
BackendConnectionErrors: NotRequired[BackendConnectionErrorsTypeDef], # (1)
GetSamplingStatisticSummariesResultTypeDef#
# GetSamplingStatisticSummariesResultTypeDef definition
class GetSamplingStatisticSummariesResultTypeDef(TypedDict):
SamplingStatisticSummaries: list[SamplingStatisticSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
GetSamplingTargetsResultTypeDef#
# GetSamplingTargetsResultTypeDef definition
class GetSamplingTargetsResultTypeDef(TypedDict):
SamplingTargetDocuments: list[SamplingTargetDocumentTypeDef], # (1)
LastRuleModification: datetime,
UnprocessedStatistics: list[UnprocessedStatisticsTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetTraceSummariesRequestPaginateTypeDef#
# GetTraceSummariesRequestPaginateTypeDef definition
class GetTraceSummariesRequestPaginateTypeDef(TypedDict):
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
TimeRangeType: NotRequired[TimeRangeTypeType], # (1)
Sampling: NotRequired[bool],
SamplingStrategy: NotRequired[SamplingStrategyTypeDef], # (2)
FilterExpression: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
GetTraceSummariesRequestRequestTypeDef#
# GetTraceSummariesRequestRequestTypeDef definition
class GetTraceSummariesRequestRequestTypeDef(TypedDict):
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
TimeRangeType: NotRequired[TimeRangeTypeType], # (1)
Sampling: NotRequired[bool],
SamplingStrategy: NotRequired[SamplingStrategyTypeDef], # (2)
FilterExpression: NotRequired[str],
NextToken: NotRequired[str],
IndexingRuleValueTypeDef#
# IndexingRuleValueTypeDef definition
class IndexingRuleValueTypeDef(TypedDict):
Probabilistic: NotRequired[ProbabilisticRuleValueTypeDef], # (1)
IndexingRuleValueUpdateTypeDef#
# IndexingRuleValueUpdateTypeDef definition
class IndexingRuleValueUpdateTypeDef(TypedDict):
Probabilistic: NotRequired[ProbabilisticRuleValueUpdateTypeDef], # (1)
InsightImpactGraphServiceTypeDef#
# InsightImpactGraphServiceTypeDef definition
class InsightImpactGraphServiceTypeDef(TypedDict):
ReferenceId: NotRequired[int],
Type: NotRequired[str],
Name: NotRequired[str],
Names: NotRequired[list[str]],
AccountId: NotRequired[str],
Edges: NotRequired[list[InsightImpactGraphEdgeTypeDef]], # (1)
ListResourcePoliciesResultTypeDef#
# ListResourcePoliciesResultTypeDef definition
class ListResourcePoliciesResultTypeDef(TypedDict):
ResourcePolicies: list[ResourcePolicyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
PutResourcePolicyResultTypeDef#
# PutResourcePolicyResultTypeDef definition
class PutResourcePolicyResultTypeDef(TypedDict):
ResourcePolicy: ResourcePolicyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutTraceSegmentsResultTypeDef#
# PutTraceSegmentsResultTypeDef definition
class PutTraceSegmentsResultTypeDef(TypedDict):
UnprocessedTraceSegments: list[UnprocessedTraceSegmentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ResponseTimeRootCauseServiceTypeDef#
# ResponseTimeRootCauseServiceTypeDef definition
class ResponseTimeRootCauseServiceTypeDef(TypedDict):
Name: NotRequired[str],
Names: NotRequired[list[str]],
Type: NotRequired[str],
AccountId: NotRequired[str],
EntityPath: NotRequired[list[ResponseTimeRootCauseEntityTypeDef]], # (1)
Inferred: NotRequired[bool],
RetrievedTraceTypeDef#
# RetrievedTraceTypeDef definition
class RetrievedTraceTypeDef(TypedDict):
Id: NotRequired[str],
Duration: NotRequired[float],
Spans: NotRequired[list[SpanTypeDef]], # (1)
- See SpanTypeDef
SamplingRuleRecordTypeDef#
# SamplingRuleRecordTypeDef definition
class SamplingRuleRecordTypeDef(TypedDict):
SamplingRule: NotRequired[SamplingRuleOutputTypeDef], # (1)
CreatedAt: NotRequired[datetime],
ModifiedAt: NotRequired[datetime],
UpdateSamplingRuleRequestRequestTypeDef#
# UpdateSamplingRuleRequestRequestTypeDef definition
class UpdateSamplingRuleRequestRequestTypeDef(TypedDict):
SamplingRuleUpdate: SamplingRuleUpdateTypeDef, # (1)
TraceTypeDef#
# TraceTypeDef definition
class TraceTypeDef(TypedDict):
Id: NotRequired[str],
Duration: NotRequired[float],
LimitExceeded: NotRequired[bool],
Segments: NotRequired[list[SegmentTypeDef]], # (1)
- See SegmentTypeDef
InsightEventTypeDef#
# InsightEventTypeDef definition
class InsightEventTypeDef(TypedDict):
Summary: NotRequired[str],
EventTime: NotRequired[datetime],
ClientRequestImpactStatistics: NotRequired[RequestImpactStatisticsTypeDef], # (1)
RootCauseServiceRequestImpactStatistics: NotRequired[RequestImpactStatisticsTypeDef], # (1)
TopAnomalousServices: NotRequired[list[AnomalousServiceTypeDef]], # (3)
InsightSummaryTypeDef#
# InsightSummaryTypeDef definition
class InsightSummaryTypeDef(TypedDict):
InsightId: NotRequired[str],
GroupARN: NotRequired[str],
GroupName: NotRequired[str],
RootCauseServiceId: NotRequired[ServiceIdTypeDef], # (1)
Categories: NotRequired[list[InsightCategoryType]], # (2)
State: NotRequired[InsightStateType], # (3)
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
Summary: NotRequired[str],
ClientRequestImpactStatistics: NotRequired[RequestImpactStatisticsTypeDef], # (4)
RootCauseServiceRequestImpactStatistics: NotRequired[RequestImpactStatisticsTypeDef], # (4)
TopAnomalousServices: NotRequired[list[AnomalousServiceTypeDef]], # (6)
LastUpdateTime: NotRequired[datetime],
- See ServiceIdTypeDef
- See InsightCategoryType
- See InsightStateType
- See RequestImpactStatisticsTypeDef
- See RequestImpactStatisticsTypeDef
- See AnomalousServiceTypeDef
InsightTypeDef#
# InsightTypeDef definition
class InsightTypeDef(TypedDict):
InsightId: NotRequired[str],
GroupARN: NotRequired[str],
GroupName: NotRequired[str],
RootCauseServiceId: NotRequired[ServiceIdTypeDef], # (1)
Categories: NotRequired[list[InsightCategoryType]], # (2)
State: NotRequired[InsightStateType], # (3)
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
Summary: NotRequired[str],
ClientRequestImpactStatistics: NotRequired[RequestImpactStatisticsTypeDef], # (4)
RootCauseServiceRequestImpactStatistics: NotRequired[RequestImpactStatisticsTypeDef], # (4)
TopAnomalousServices: NotRequired[list[AnomalousServiceTypeDef]], # (6)
- See ServiceIdTypeDef
- See InsightCategoryType
- See InsightStateType
- See RequestImpactStatisticsTypeDef
- See RequestImpactStatisticsTypeDef
- See AnomalousServiceTypeDef
GetGroupsResultTypeDef#
# GetGroupsResultTypeDef definition
class GetGroupsResultTypeDef(TypedDict):
Groups: list[GroupSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
CreateGroupResultTypeDef#
# CreateGroupResultTypeDef definition
class CreateGroupResultTypeDef(TypedDict):
Group: GroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
GetGroupResultTypeDef#
# GetGroupResultTypeDef definition
class GetGroupResultTypeDef(TypedDict):
Group: GroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
UpdateGroupResultTypeDef#
# UpdateGroupResultTypeDef definition
class UpdateGroupResultTypeDef(TypedDict):
Group: GroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
EdgeTypeDef#
# EdgeTypeDef definition
class EdgeTypeDef(TypedDict):
ReferenceId: NotRequired[int],
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
SummaryStatistics: NotRequired[EdgeStatisticsTypeDef], # (1)
ResponseTimeHistogram: NotRequired[list[HistogramEntryTypeDef]], # (2)
Aliases: NotRequired[list[AliasTypeDef]], # (3)
EdgeType: NotRequired[str],
ReceivedEventAgeHistogram: NotRequired[list[HistogramEntryTypeDef]], # (2)
- See EdgeStatisticsTypeDef
- See HistogramEntryTypeDef
- See AliasTypeDef
- See HistogramEntryTypeDef
TimeSeriesServiceStatisticsTypeDef#
# TimeSeriesServiceStatisticsTypeDef definition
class TimeSeriesServiceStatisticsTypeDef(TypedDict):
Timestamp: NotRequired[datetime],
EdgeSummaryStatistics: NotRequired[EdgeStatisticsTypeDef], # (1)
ServiceSummaryStatistics: NotRequired[ServiceStatisticsTypeDef], # (2)
ServiceForecastStatistics: NotRequired[ForecastStatisticsTypeDef], # (3)
ResponseTimeHistogram: NotRequired[list[HistogramEntryTypeDef]], # (4)
- See EdgeStatisticsTypeDef
- See ServiceStatisticsTypeDef
- See ForecastStatisticsTypeDef
- See HistogramEntryTypeDef
ErrorRootCauseServiceTypeDef#
# ErrorRootCauseServiceTypeDef definition
class ErrorRootCauseServiceTypeDef(TypedDict):
Name: NotRequired[str],
Names: NotRequired[list[str]],
Type: NotRequired[str],
AccountId: NotRequired[str],
EntityPath: NotRequired[list[ErrorRootCauseEntityTypeDef]], # (1)
Inferred: NotRequired[bool],
FaultRootCauseServiceTypeDef#
# FaultRootCauseServiceTypeDef definition
class FaultRootCauseServiceTypeDef(TypedDict):
Name: NotRequired[str],
Names: NotRequired[list[str]],
Type: NotRequired[str],
AccountId: NotRequired[str],
EntityPath: NotRequired[list[FaultRootCauseEntityTypeDef]], # (1)
Inferred: NotRequired[bool],
GetSamplingTargetsRequestRequestTypeDef#
# GetSamplingTargetsRequestRequestTypeDef definition
class GetSamplingTargetsRequestRequestTypeDef(TypedDict):
SamplingStatisticsDocuments: Sequence[SamplingStatisticsDocumentTypeDef], # (1)
PutTelemetryRecordsRequestRequestTypeDef#
# PutTelemetryRecordsRequestRequestTypeDef definition
class PutTelemetryRecordsRequestRequestTypeDef(TypedDict):
TelemetryRecords: Sequence[TelemetryRecordTypeDef], # (1)
EC2InstanceId: NotRequired[str],
Hostname: NotRequired[str],
ResourceARN: NotRequired[str],
IndexingRuleTypeDef#
# IndexingRuleTypeDef definition
class IndexingRuleTypeDef(TypedDict):
Name: NotRequired[str],
ModifiedAt: NotRequired[datetime],
Rule: NotRequired[IndexingRuleValueTypeDef], # (1)
UpdateIndexingRuleRequestRequestTypeDef#
# UpdateIndexingRuleRequestRequestTypeDef definition
class UpdateIndexingRuleRequestRequestTypeDef(TypedDict):
Name: str,
Rule: IndexingRuleValueUpdateTypeDef, # (1)
GetInsightImpactGraphResultTypeDef#
# GetInsightImpactGraphResultTypeDef definition
class GetInsightImpactGraphResultTypeDef(TypedDict):
InsightId: str,
StartTime: datetime,
EndTime: datetime,
ServiceGraphStartTime: datetime,
ServiceGraphEndTime: datetime,
Services: list[InsightImpactGraphServiceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ResponseTimeRootCauseTypeDef#
# ResponseTimeRootCauseTypeDef definition
class ResponseTimeRootCauseTypeDef(TypedDict):
Services: NotRequired[list[ResponseTimeRootCauseServiceTypeDef]], # (1)
ClientImpacting: NotRequired[bool],
ListRetrievedTracesResultTypeDef#
# ListRetrievedTracesResultTypeDef definition
class ListRetrievedTracesResultTypeDef(TypedDict):
RetrievalStatus: RetrievalStatusType, # (1)
TraceFormat: TraceFormatTypeType, # (2)
Traces: list[RetrievedTraceTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
NextToken: NotRequired[str],
- See RetrievalStatusType
- See TraceFormatTypeType
- See RetrievedTraceTypeDef
- See ResponseMetadataTypeDef
CreateSamplingRuleResultTypeDef#
# CreateSamplingRuleResultTypeDef definition
class CreateSamplingRuleResultTypeDef(TypedDict):
SamplingRuleRecord: SamplingRuleRecordTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteSamplingRuleResultTypeDef#
# DeleteSamplingRuleResultTypeDef definition
class DeleteSamplingRuleResultTypeDef(TypedDict):
SamplingRuleRecord: SamplingRuleRecordTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSamplingRulesResultTypeDef#
# GetSamplingRulesResultTypeDef definition
class GetSamplingRulesResultTypeDef(TypedDict):
SamplingRuleRecords: list[SamplingRuleRecordTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
UpdateSamplingRuleResultTypeDef#
# UpdateSamplingRuleResultTypeDef definition
class UpdateSamplingRuleResultTypeDef(TypedDict):
SamplingRuleRecord: SamplingRuleRecordTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetTracesResultTypeDef#
# BatchGetTracesResultTypeDef definition
class BatchGetTracesResultTypeDef(TypedDict):
Traces: list[TraceTypeDef], # (1)
UnprocessedTraceIds: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See TraceTypeDef
- See ResponseMetadataTypeDef
GetInsightEventsResultTypeDef#
# GetInsightEventsResultTypeDef definition
class GetInsightEventsResultTypeDef(TypedDict):
InsightEvents: list[InsightEventTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
GetInsightSummariesResultTypeDef#
# GetInsightSummariesResultTypeDef definition
class GetInsightSummariesResultTypeDef(TypedDict):
InsightSummaries: list[InsightSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
GetInsightResultTypeDef#
# GetInsightResultTypeDef definition
class GetInsightResultTypeDef(TypedDict):
Insight: InsightTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ServiceTypeDef#
# ServiceTypeDef definition
class ServiceTypeDef(TypedDict):
ReferenceId: NotRequired[int],
Name: NotRequired[str],
Names: NotRequired[list[str]],
Root: NotRequired[bool],
AccountId: NotRequired[str],
Type: NotRequired[str],
State: NotRequired[str],
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
Edges: NotRequired[list[EdgeTypeDef]], # (1)
SummaryStatistics: NotRequired[ServiceStatisticsTypeDef], # (2)
DurationHistogram: NotRequired[list[HistogramEntryTypeDef]], # (3)
ResponseTimeHistogram: NotRequired[list[HistogramEntryTypeDef]], # (3)
GetTimeSeriesServiceStatisticsResultTypeDef#
# GetTimeSeriesServiceStatisticsResultTypeDef definition
class GetTimeSeriesServiceStatisticsResultTypeDef(TypedDict):
TimeSeriesServiceStatistics: list[TimeSeriesServiceStatisticsTypeDef], # (1)
ContainsOldGroupVersions: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ErrorRootCauseTypeDef#
# ErrorRootCauseTypeDef definition
class ErrorRootCauseTypeDef(TypedDict):
Services: NotRequired[list[ErrorRootCauseServiceTypeDef]], # (1)
ClientImpacting: NotRequired[bool],
FaultRootCauseTypeDef#
# FaultRootCauseTypeDef definition
class FaultRootCauseTypeDef(TypedDict):
Services: NotRequired[list[FaultRootCauseServiceTypeDef]], # (1)
ClientImpacting: NotRequired[bool],
GetIndexingRulesResultTypeDef#
# GetIndexingRulesResultTypeDef definition
class GetIndexingRulesResultTypeDef(TypedDict):
IndexingRules: list[IndexingRuleTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
UpdateIndexingRuleResultTypeDef#
# UpdateIndexingRuleResultTypeDef definition
class UpdateIndexingRuleResultTypeDef(TypedDict):
IndexingRule: IndexingRuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetServiceGraphResultTypeDef#
# GetServiceGraphResultTypeDef definition
class GetServiceGraphResultTypeDef(TypedDict):
StartTime: datetime,
EndTime: datetime,
Services: list[ServiceTypeDef], # (1)
ContainsOldGroupVersions: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
GetTraceGraphResultTypeDef#
# GetTraceGraphResultTypeDef definition
class GetTraceGraphResultTypeDef(TypedDict):
Services: list[ServiceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
RetrievedServiceTypeDef#
# RetrievedServiceTypeDef definition
class RetrievedServiceTypeDef(TypedDict):
Service: NotRequired[ServiceTypeDef], # (1)
Links: NotRequired[list[GraphLinkTypeDef]], # (2)
- See ServiceTypeDef
- See GraphLinkTypeDef
TraceSummaryTypeDef#
# TraceSummaryTypeDef definition
class TraceSummaryTypeDef(TypedDict):
Id: NotRequired[str],
StartTime: NotRequired[datetime],
Duration: NotRequired[float],
ResponseTime: NotRequired[float],
HasFault: NotRequired[bool],
HasError: NotRequired[bool],
HasThrottle: NotRequired[bool],
IsPartial: NotRequired[bool],
Http: NotRequired[HttpTypeDef], # (1)
Annotations: NotRequired[dict[str, list[ValueWithServiceIdsTypeDef]]], # (2)
Users: NotRequired[list[TraceUserTypeDef]], # (3)
ServiceIds: NotRequired[list[ServiceIdTypeDef]], # (4)
ResourceARNs: NotRequired[list[ResourceARNDetailTypeDef]], # (5)
InstanceIds: NotRequired[list[InstanceIdDetailTypeDef]], # (6)
AvailabilityZones: NotRequired[list[AvailabilityZoneDetailTypeDef]], # (7)
EntryPoint: NotRequired[ServiceIdTypeDef], # (8)
FaultRootCauses: NotRequired[list[FaultRootCauseTypeDef]], # (9)
ErrorRootCauses: NotRequired[list[ErrorRootCauseTypeDef]], # (10)
ResponseTimeRootCauses: NotRequired[list[ResponseTimeRootCauseTypeDef]], # (11)
Revision: NotRequired[int],
MatchedEventTime: NotRequired[datetime],
- See HttpTypeDef
- See ValueWithServiceIdsTypeDef
- See TraceUserTypeDef
- See ServiceIdTypeDef
- See ResourceARNDetailTypeDef
- See InstanceIdDetailTypeDef
- See AvailabilityZoneDetailTypeDef
- See ServiceIdTypeDef
- See FaultRootCauseTypeDef
- See ErrorRootCauseTypeDef
- See ResponseTimeRootCauseTypeDef
GetRetrievedTracesGraphResultTypeDef#
# GetRetrievedTracesGraphResultTypeDef definition
class GetRetrievedTracesGraphResultTypeDef(TypedDict):
RetrievalStatus: RetrievalStatusType, # (1)
Services: list[RetrievedServiceTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
NextToken: NotRequired[str],
GetTraceSummariesResultTypeDef#
# GetTraceSummariesResultTypeDef definition
class GetTraceSummariesResultTypeDef(TypedDict):
TraceSummaries: list[TraceSummaryTypeDef], # (1)
ApproximateTime: datetime,
TracesProcessedCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],