Typed dictionaries#
Auto-generated documentation for XRay type annotations stubs module mypy-boto3-xray.
AliasTypeDef#
# AliasTypeDef usage example
from mypy_boto3_xray.type_defs import AliasTypeDef
def get_value() -> AliasTypeDef:
return {
"Name": ...,
}
# AliasTypeDef definition
class AliasTypeDef(TypedDict):
Name: NotRequired[str],
Names: NotRequired[List[str]],
Type: NotRequired[str],
AnnotationValueTypeDef#
# AnnotationValueTypeDef usage example
from mypy_boto3_xray.type_defs import AnnotationValueTypeDef
def get_value() -> AnnotationValueTypeDef:
return {
"NumberValue": ...,
}
# AnnotationValueTypeDef definition
class AnnotationValueTypeDef(TypedDict):
NumberValue: NotRequired[float],
BooleanValue: NotRequired[bool],
StringValue: NotRequired[str],
ServiceIdTypeDef#
# ServiceIdTypeDef usage example
from mypy_boto3_xray.type_defs import ServiceIdTypeDef
def get_value() -> ServiceIdTypeDef:
return {
"Name": ...,
}
# ServiceIdTypeDef definition
class ServiceIdTypeDef(TypedDict):
Name: NotRequired[str],
Names: NotRequired[List[str]],
AccountId: NotRequired[str],
Type: NotRequired[str],
AvailabilityZoneDetailTypeDef#
# AvailabilityZoneDetailTypeDef usage example
from mypy_boto3_xray.type_defs import AvailabilityZoneDetailTypeDef
def get_value() -> AvailabilityZoneDetailTypeDef:
return {
"Name": ...,
}
# AvailabilityZoneDetailTypeDef definition
class AvailabilityZoneDetailTypeDef(TypedDict):
Name: NotRequired[str],
BackendConnectionErrorsTypeDef#
# BackendConnectionErrorsTypeDef usage example
from mypy_boto3_xray.type_defs import BackendConnectionErrorsTypeDef
def get_value() -> BackendConnectionErrorsTypeDef:
return {
"TimeoutCount": ...,
}
# BackendConnectionErrorsTypeDef definition
class BackendConnectionErrorsTypeDef(TypedDict):
TimeoutCount: NotRequired[int],
ConnectionRefusedCount: NotRequired[int],
HTTPCode4XXCount: NotRequired[int],
HTTPCode5XXCount: NotRequired[int],
UnknownHostCount: NotRequired[int],
OtherCount: NotRequired[int],
BatchGetTracesRequestBatchGetTracesPaginateTypeDef#
# BatchGetTracesRequestBatchGetTracesPaginateTypeDef usage example
from mypy_boto3_xray.type_defs import BatchGetTracesRequestBatchGetTracesPaginateTypeDef
def get_value() -> BatchGetTracesRequestBatchGetTracesPaginateTypeDef:
return {
"TraceIds": ...,
}
# BatchGetTracesRequestBatchGetTracesPaginateTypeDef definition
class BatchGetTracesRequestBatchGetTracesPaginateTypeDef(TypedDict):
TraceIds: Sequence[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
BatchGetTracesRequestRequestTypeDef#
# BatchGetTracesRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import BatchGetTracesRequestRequestTypeDef
def get_value() -> BatchGetTracesRequestRequestTypeDef:
return {
"TraceIds": ...,
}
# BatchGetTracesRequestRequestTypeDef definition
class BatchGetTracesRequestRequestTypeDef(TypedDict):
TraceIds: Sequence[str],
NextToken: NotRequired[str],
InsightsConfigurationTypeDef#
# InsightsConfigurationTypeDef usage example
from mypy_boto3_xray.type_defs import InsightsConfigurationTypeDef
def get_value() -> InsightsConfigurationTypeDef:
return {
"InsightsEnabled": ...,
}
# InsightsConfigurationTypeDef definition
class InsightsConfigurationTypeDef(TypedDict):
InsightsEnabled: NotRequired[bool],
NotificationsEnabled: NotRequired[bool],
TagTypeDef#
# TagTypeDef usage example
from mypy_boto3_xray.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
SamplingRuleTypeDef#
# SamplingRuleTypeDef usage example
from mypy_boto3_xray.type_defs import SamplingRuleTypeDef
def get_value() -> SamplingRuleTypeDef:
return {
"ResourceARN": ...,
"Priority": ...,
"FixedRate": ...,
"ReservoirSize": ...,
"ServiceName": ...,
"ServiceType": ...,
"Host": ...,
"HTTPMethod": ...,
"URLPath": ...,
"Version": ...,
}
# 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 usage example
from mypy_boto3_xray.type_defs import DeleteGroupRequestRequestTypeDef
def get_value() -> DeleteGroupRequestRequestTypeDef:
return {
"GroupName": ...,
}
# DeleteGroupRequestRequestTypeDef definition
class DeleteGroupRequestRequestTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
DeleteResourcePolicyRequestRequestTypeDef#
# DeleteResourcePolicyRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import DeleteResourcePolicyRequestRequestTypeDef
def get_value() -> DeleteResourcePolicyRequestRequestTypeDef:
return {
"PolicyName": ...,
}
# DeleteResourcePolicyRequestRequestTypeDef definition
class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
PolicyName: str,
PolicyRevisionId: NotRequired[str],
DeleteSamplingRuleRequestRequestTypeDef#
# DeleteSamplingRuleRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import DeleteSamplingRuleRequestRequestTypeDef
def get_value() -> DeleteSamplingRuleRequestRequestTypeDef:
return {
"RuleName": ...,
}
# DeleteSamplingRuleRequestRequestTypeDef definition
class DeleteSamplingRuleRequestRequestTypeDef(TypedDict):
RuleName: NotRequired[str],
RuleARN: NotRequired[str],
ErrorStatisticsTypeDef#
# ErrorStatisticsTypeDef usage example
from mypy_boto3_xray.type_defs import ErrorStatisticsTypeDef
def get_value() -> ErrorStatisticsTypeDef:
return {
"ThrottleCount": ...,
}
# ErrorStatisticsTypeDef definition
class ErrorStatisticsTypeDef(TypedDict):
ThrottleCount: NotRequired[int],
OtherCount: NotRequired[int],
TotalCount: NotRequired[int],
FaultStatisticsTypeDef#
# FaultStatisticsTypeDef usage example
from mypy_boto3_xray.type_defs import FaultStatisticsTypeDef
def get_value() -> FaultStatisticsTypeDef:
return {
"OtherCount": ...,
}
# FaultStatisticsTypeDef definition
class FaultStatisticsTypeDef(TypedDict):
OtherCount: NotRequired[int],
TotalCount: NotRequired[int],
HistogramEntryTypeDef#
# HistogramEntryTypeDef usage example
from mypy_boto3_xray.type_defs import HistogramEntryTypeDef
def get_value() -> HistogramEntryTypeDef:
return {
"Value": ...,
}
# HistogramEntryTypeDef definition
class HistogramEntryTypeDef(TypedDict):
Value: NotRequired[float],
Count: NotRequired[int],
EncryptionConfigTypeDef#
# EncryptionConfigTypeDef usage example
from mypy_boto3_xray.type_defs import EncryptionConfigTypeDef
def get_value() -> EncryptionConfigTypeDef:
return {
"KeyId": ...,
}
# EncryptionConfigTypeDef definition
class EncryptionConfigTypeDef(TypedDict):
KeyId: NotRequired[str],
Status: NotRequired[EncryptionStatusType], # (1)
Type: NotRequired[EncryptionTypeType], # (2)
RootCauseExceptionTypeDef#
# RootCauseExceptionTypeDef usage example
from mypy_boto3_xray.type_defs import RootCauseExceptionTypeDef
def get_value() -> RootCauseExceptionTypeDef:
return {
"Name": ...,
}
# RootCauseExceptionTypeDef definition
class RootCauseExceptionTypeDef(TypedDict):
Name: NotRequired[str],
Message: NotRequired[str],
ForecastStatisticsTypeDef#
# ForecastStatisticsTypeDef usage example
from mypy_boto3_xray.type_defs import ForecastStatisticsTypeDef
def get_value() -> ForecastStatisticsTypeDef:
return {
"FaultCountHigh": ...,
}
# ForecastStatisticsTypeDef definition
class ForecastStatisticsTypeDef(TypedDict):
FaultCountHigh: NotRequired[int],
FaultCountLow: NotRequired[int],
GetGroupRequestRequestTypeDef#
# GetGroupRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetGroupRequestRequestTypeDef
def get_value() -> GetGroupRequestRequestTypeDef:
return {
"GroupName": ...,
}
# GetGroupRequestRequestTypeDef definition
class GetGroupRequestRequestTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
GetGroupsRequestGetGroupsPaginateTypeDef#
# GetGroupsRequestGetGroupsPaginateTypeDef usage example
from mypy_boto3_xray.type_defs import GetGroupsRequestGetGroupsPaginateTypeDef
def get_value() -> GetGroupsRequestGetGroupsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# GetGroupsRequestGetGroupsPaginateTypeDef definition
class GetGroupsRequestGetGroupsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetGroupsRequestRequestTypeDef#
# GetGroupsRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetGroupsRequestRequestTypeDef
def get_value() -> GetGroupsRequestRequestTypeDef:
return {
"NextToken": ...,
}
# GetGroupsRequestRequestTypeDef definition
class GetGroupsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
GetInsightEventsRequestRequestTypeDef#
# GetInsightEventsRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetInsightEventsRequestRequestTypeDef
def get_value() -> GetInsightEventsRequestRequestTypeDef:
return {
"InsightId": ...,
}
# GetInsightEventsRequestRequestTypeDef definition
class GetInsightEventsRequestRequestTypeDef(TypedDict):
InsightId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetInsightImpactGraphRequestRequestTypeDef#
# GetInsightImpactGraphRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetInsightImpactGraphRequestRequestTypeDef
def get_value() -> GetInsightImpactGraphRequestRequestTypeDef:
return {
"InsightId": ...,
"StartTime": ...,
"EndTime": ...,
}
# GetInsightImpactGraphRequestRequestTypeDef definition
class GetInsightImpactGraphRequestRequestTypeDef(TypedDict):
InsightId: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
NextToken: NotRequired[str],
GetInsightRequestRequestTypeDef#
# GetInsightRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetInsightRequestRequestTypeDef
def get_value() -> GetInsightRequestRequestTypeDef:
return {
"InsightId": ...,
}
# GetInsightRequestRequestTypeDef definition
class GetInsightRequestRequestTypeDef(TypedDict):
InsightId: str,
GetInsightSummariesRequestRequestTypeDef#
# GetInsightSummariesRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetInsightSummariesRequestRequestTypeDef
def get_value() -> GetInsightSummariesRequestRequestTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
}
# GetInsightSummariesRequestRequestTypeDef definition
class GetInsightSummariesRequestRequestTypeDef(TypedDict):
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
States: NotRequired[Sequence[InsightStateType]], # (1)
GroupARN: NotRequired[str],
GroupName: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
- See InsightStateType
GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef#
# GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef usage example
from mypy_boto3_xray.type_defs import GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef
def get_value() -> GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef definition
class GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSamplingRulesRequestRequestTypeDef#
# GetSamplingRulesRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetSamplingRulesRequestRequestTypeDef
def get_value() -> GetSamplingRulesRequestRequestTypeDef:
return {
"NextToken": ...,
}
# GetSamplingRulesRequestRequestTypeDef definition
class GetSamplingRulesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef#
# GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef usage example
from mypy_boto3_xray.type_defs import GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef
def get_value() -> GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef definition
class GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSamplingStatisticSummariesRequestRequestTypeDef#
# GetSamplingStatisticSummariesRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetSamplingStatisticSummariesRequestRequestTypeDef
def get_value() -> GetSamplingStatisticSummariesRequestRequestTypeDef:
return {
"NextToken": ...,
}
# GetSamplingStatisticSummariesRequestRequestTypeDef definition
class GetSamplingStatisticSummariesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
SamplingStatisticSummaryTypeDef#
# SamplingStatisticSummaryTypeDef usage example
from mypy_boto3_xray.type_defs import SamplingStatisticSummaryTypeDef
def get_value() -> SamplingStatisticSummaryTypeDef:
return {
"RuleName": ...,
}
# SamplingStatisticSummaryTypeDef definition
class SamplingStatisticSummaryTypeDef(TypedDict):
RuleName: NotRequired[str],
Timestamp: NotRequired[datetime],
RequestCount: NotRequired[int],
BorrowCount: NotRequired[int],
SampledCount: NotRequired[int],
SamplingStatisticsDocumentTypeDef#
# SamplingStatisticsDocumentTypeDef usage example
from mypy_boto3_xray.type_defs import SamplingStatisticsDocumentTypeDef
def get_value() -> SamplingStatisticsDocumentTypeDef:
return {
"RuleName": ...,
"ClientID": ...,
"Timestamp": ...,
"RequestCount": ...,
"SampledCount": ...,
}
# SamplingStatisticsDocumentTypeDef definition
class SamplingStatisticsDocumentTypeDef(TypedDict):
RuleName: str,
ClientID: str,
Timestamp: Union[datetime, str],
RequestCount: int,
SampledCount: int,
BorrowCount: NotRequired[int],
SamplingTargetDocumentTypeDef#
# SamplingTargetDocumentTypeDef usage example
from mypy_boto3_xray.type_defs import SamplingTargetDocumentTypeDef
def get_value() -> SamplingTargetDocumentTypeDef:
return {
"RuleName": ...,
}
# SamplingTargetDocumentTypeDef definition
class SamplingTargetDocumentTypeDef(TypedDict):
RuleName: NotRequired[str],
FixedRate: NotRequired[float],
ReservoirQuota: NotRequired[int],
ReservoirQuotaTTL: NotRequired[datetime],
Interval: NotRequired[int],
UnprocessedStatisticsTypeDef#
# UnprocessedStatisticsTypeDef usage example
from mypy_boto3_xray.type_defs import UnprocessedStatisticsTypeDef
def get_value() -> UnprocessedStatisticsTypeDef:
return {
"RuleName": ...,
}
# UnprocessedStatisticsTypeDef definition
class UnprocessedStatisticsTypeDef(TypedDict):
RuleName: NotRequired[str],
ErrorCode: NotRequired[str],
Message: NotRequired[str],
GetServiceGraphRequestGetServiceGraphPaginateTypeDef#
# GetServiceGraphRequestGetServiceGraphPaginateTypeDef usage example
from mypy_boto3_xray.type_defs import GetServiceGraphRequestGetServiceGraphPaginateTypeDef
def get_value() -> GetServiceGraphRequestGetServiceGraphPaginateTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
}
# GetServiceGraphRequestGetServiceGraphPaginateTypeDef definition
class GetServiceGraphRequestGetServiceGraphPaginateTypeDef(TypedDict):
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetServiceGraphRequestRequestTypeDef#
# GetServiceGraphRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetServiceGraphRequestRequestTypeDef
def get_value() -> GetServiceGraphRequestRequestTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
}
# GetServiceGraphRequestRequestTypeDef definition
class GetServiceGraphRequestRequestTypeDef(TypedDict):
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
NextToken: NotRequired[str],
GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef#
# GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef usage example
from mypy_boto3_xray.type_defs import GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef
def get_value() -> GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
}
# GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef definition
class GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef(TypedDict):
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
EntitySelectorExpression: NotRequired[str],
Period: NotRequired[int],
ForecastStatistics: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetTimeSeriesServiceStatisticsRequestRequestTypeDef#
# GetTimeSeriesServiceStatisticsRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetTimeSeriesServiceStatisticsRequestRequestTypeDef
def get_value() -> GetTimeSeriesServiceStatisticsRequestRequestTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
}
# GetTimeSeriesServiceStatisticsRequestRequestTypeDef definition
class GetTimeSeriesServiceStatisticsRequestRequestTypeDef(TypedDict):
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
EntitySelectorExpression: NotRequired[str],
Period: NotRequired[int],
ForecastStatistics: NotRequired[bool],
NextToken: NotRequired[str],
GetTraceGraphRequestGetTraceGraphPaginateTypeDef#
# GetTraceGraphRequestGetTraceGraphPaginateTypeDef usage example
from mypy_boto3_xray.type_defs import GetTraceGraphRequestGetTraceGraphPaginateTypeDef
def get_value() -> GetTraceGraphRequestGetTraceGraphPaginateTypeDef:
return {
"TraceIds": ...,
}
# GetTraceGraphRequestGetTraceGraphPaginateTypeDef definition
class GetTraceGraphRequestGetTraceGraphPaginateTypeDef(TypedDict):
TraceIds: Sequence[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetTraceGraphRequestRequestTypeDef#
# GetTraceGraphRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetTraceGraphRequestRequestTypeDef
def get_value() -> GetTraceGraphRequestRequestTypeDef:
return {
"TraceIds": ...,
}
# GetTraceGraphRequestRequestTypeDef definition
class GetTraceGraphRequestRequestTypeDef(TypedDict):
TraceIds: Sequence[str],
NextToken: NotRequired[str],
SamplingStrategyTypeDef#
# SamplingStrategyTypeDef usage example
from mypy_boto3_xray.type_defs import SamplingStrategyTypeDef
def get_value() -> SamplingStrategyTypeDef:
return {
"Name": ...,
}
# SamplingStrategyTypeDef definition
class SamplingStrategyTypeDef(TypedDict):
Name: NotRequired[SamplingStrategyNameType], # (1)
Value: NotRequired[float],
HttpTypeDef#
# HttpTypeDef usage example
from mypy_boto3_xray.type_defs import HttpTypeDef
def get_value() -> HttpTypeDef:
return {
"HttpURL": ...,
}
# HttpTypeDef definition
class HttpTypeDef(TypedDict):
HttpURL: NotRequired[str],
HttpStatus: NotRequired[int],
HttpMethod: NotRequired[str],
UserAgent: NotRequired[str],
ClientIp: NotRequired[str],
RequestImpactStatisticsTypeDef#
# RequestImpactStatisticsTypeDef usage example
from mypy_boto3_xray.type_defs import RequestImpactStatisticsTypeDef
def get_value() -> RequestImpactStatisticsTypeDef:
return {
"FaultCount": ...,
}
# RequestImpactStatisticsTypeDef definition
class RequestImpactStatisticsTypeDef(TypedDict):
FaultCount: NotRequired[int],
OkCount: NotRequired[int],
TotalCount: NotRequired[int],
InsightImpactGraphEdgeTypeDef#
# InsightImpactGraphEdgeTypeDef usage example
from mypy_boto3_xray.type_defs import InsightImpactGraphEdgeTypeDef
def get_value() -> InsightImpactGraphEdgeTypeDef:
return {
"ReferenceId": ...,
}
# InsightImpactGraphEdgeTypeDef definition
class InsightImpactGraphEdgeTypeDef(TypedDict):
ReferenceId: NotRequired[int],
InstanceIdDetailTypeDef#
# InstanceIdDetailTypeDef usage example
from mypy_boto3_xray.type_defs import InstanceIdDetailTypeDef
def get_value() -> InstanceIdDetailTypeDef:
return {
"Id": ...,
}
# InstanceIdDetailTypeDef definition
class InstanceIdDetailTypeDef(TypedDict):
Id: NotRequired[str],
ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef#
# ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef usage example
from mypy_boto3_xray.type_defs import ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef
def get_value() -> ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef definition
class ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListResourcePoliciesRequestRequestTypeDef#
# ListResourcePoliciesRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import ListResourcePoliciesRequestRequestTypeDef
def get_value() -> ListResourcePoliciesRequestRequestTypeDef:
return {
"NextToken": ...,
}
# ListResourcePoliciesRequestRequestTypeDef definition
class ListResourcePoliciesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
ResourcePolicyTypeDef#
# ResourcePolicyTypeDef usage example
from mypy_boto3_xray.type_defs import ResourcePolicyTypeDef
def get_value() -> ResourcePolicyTypeDef:
return {
"PolicyName": ...,
}
# ResourcePolicyTypeDef definition
class ResourcePolicyTypeDef(TypedDict):
PolicyName: NotRequired[str],
PolicyDocument: NotRequired[str],
PolicyRevisionId: NotRequired[str],
LastUpdatedTime: NotRequired[datetime],
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#
# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef usage example
from mypy_boto3_xray.type_defs import ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
def get_value() -> ListTagsForResourceRequestListTagsForResourcePaginateTypeDef:
return {
"ResourceARN": ...,
}
# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition
class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
ResourceARN: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
NextToken: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_xray.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
PutEncryptionConfigRequestRequestTypeDef#
# PutEncryptionConfigRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import PutEncryptionConfigRequestRequestTypeDef
def get_value() -> PutEncryptionConfigRequestRequestTypeDef:
return {
"Type": ...,
}
# PutEncryptionConfigRequestRequestTypeDef definition
class PutEncryptionConfigRequestRequestTypeDef(TypedDict):
Type: EncryptionTypeType, # (1)
KeyId: NotRequired[str],
PutResourcePolicyRequestRequestTypeDef#
# PutResourcePolicyRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import PutResourcePolicyRequestRequestTypeDef
def get_value() -> PutResourcePolicyRequestRequestTypeDef:
return {
"PolicyName": ...,
"PolicyDocument": ...,
}
# PutResourcePolicyRequestRequestTypeDef definition
class PutResourcePolicyRequestRequestTypeDef(TypedDict):
PolicyName: str,
PolicyDocument: str,
PolicyRevisionId: NotRequired[str],
BypassPolicyLockoutCheck: NotRequired[bool],
PutTraceSegmentsRequestRequestTypeDef#
# PutTraceSegmentsRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import PutTraceSegmentsRequestRequestTypeDef
def get_value() -> PutTraceSegmentsRequestRequestTypeDef:
return {
"TraceSegmentDocuments": ...,
}
# PutTraceSegmentsRequestRequestTypeDef definition
class PutTraceSegmentsRequestRequestTypeDef(TypedDict):
TraceSegmentDocuments: Sequence[str],
UnprocessedTraceSegmentTypeDef#
# UnprocessedTraceSegmentTypeDef usage example
from mypy_boto3_xray.type_defs import UnprocessedTraceSegmentTypeDef
def get_value() -> UnprocessedTraceSegmentTypeDef:
return {
"Id": ...,
}
# UnprocessedTraceSegmentTypeDef definition
class UnprocessedTraceSegmentTypeDef(TypedDict):
Id: NotRequired[str],
ErrorCode: NotRequired[str],
Message: NotRequired[str],
ResourceARNDetailTypeDef#
# ResourceARNDetailTypeDef usage example
from mypy_boto3_xray.type_defs import ResourceARNDetailTypeDef
def get_value() -> ResourceARNDetailTypeDef:
return {
"ARN": ...,
}
# ResourceARNDetailTypeDef definition
class ResourceARNDetailTypeDef(TypedDict):
ARN: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_xray.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ResponseTimeRootCauseEntityTypeDef#
# ResponseTimeRootCauseEntityTypeDef usage example
from mypy_boto3_xray.type_defs import ResponseTimeRootCauseEntityTypeDef
def get_value() -> ResponseTimeRootCauseEntityTypeDef:
return {
"Name": ...,
}
# ResponseTimeRootCauseEntityTypeDef definition
class ResponseTimeRootCauseEntityTypeDef(TypedDict):
Name: NotRequired[str],
Coverage: NotRequired[float],
Remote: NotRequired[bool],
SamplingRuleUpdateTypeDef#
# SamplingRuleUpdateTypeDef usage example
from mypy_boto3_xray.type_defs import SamplingRuleUpdateTypeDef
def get_value() -> SamplingRuleUpdateTypeDef:
return {
"RuleName": ...,
}
# 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 usage example
from mypy_boto3_xray.type_defs import SegmentTypeDef
def get_value() -> SegmentTypeDef:
return {
"Id": ...,
}
# SegmentTypeDef definition
class SegmentTypeDef(TypedDict):
Id: NotRequired[str],
Document: NotRequired[str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
AnomalousServiceTypeDef#
# AnomalousServiceTypeDef usage example
from mypy_boto3_xray.type_defs import AnomalousServiceTypeDef
def get_value() -> AnomalousServiceTypeDef:
return {
"ServiceId": ...,
}
# AnomalousServiceTypeDef definition
class AnomalousServiceTypeDef(TypedDict):
ServiceId: NotRequired[ServiceIdTypeDef], # (1)
- See ServiceIdTypeDef
TraceUserTypeDef#
# TraceUserTypeDef usage example
from mypy_boto3_xray.type_defs import TraceUserTypeDef
def get_value() -> TraceUserTypeDef:
return {
"UserName": ...,
}
# TraceUserTypeDef definition
class TraceUserTypeDef(TypedDict):
UserName: NotRequired[str],
ServiceIds: NotRequired[List[ServiceIdTypeDef]], # (1)
- See ServiceIdTypeDef
ValueWithServiceIdsTypeDef#
# ValueWithServiceIdsTypeDef usage example
from mypy_boto3_xray.type_defs import ValueWithServiceIdsTypeDef
def get_value() -> ValueWithServiceIdsTypeDef:
return {
"AnnotationValue": ...,
}
# ValueWithServiceIdsTypeDef definition
class ValueWithServiceIdsTypeDef(TypedDict):
AnnotationValue: NotRequired[AnnotationValueTypeDef], # (1)
ServiceIds: NotRequired[List[ServiceIdTypeDef]], # (2)
TelemetryRecordTypeDef#
# TelemetryRecordTypeDef usage example
from mypy_boto3_xray.type_defs import TelemetryRecordTypeDef
def get_value() -> TelemetryRecordTypeDef:
return {
"Timestamp": ...,
}
# TelemetryRecordTypeDef definition
class TelemetryRecordTypeDef(TypedDict):
Timestamp: Union[datetime, str],
SegmentsReceivedCount: NotRequired[int],
SegmentsSentCount: NotRequired[int],
SegmentsSpilloverCount: NotRequired[int],
SegmentsRejectedCount: NotRequired[int],
BackendConnectionErrors: NotRequired[BackendConnectionErrorsTypeDef], # (1)
GroupSummaryTypeDef#
# GroupSummaryTypeDef usage example
from mypy_boto3_xray.type_defs import GroupSummaryTypeDef
def get_value() -> GroupSummaryTypeDef:
return {
"GroupName": ...,
}
# GroupSummaryTypeDef definition
class GroupSummaryTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
FilterExpression: NotRequired[str],
InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef], # (1)
GroupTypeDef#
# GroupTypeDef usage example
from mypy_boto3_xray.type_defs import GroupTypeDef
def get_value() -> GroupTypeDef:
return {
"GroupName": ...,
}
# GroupTypeDef definition
class GroupTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
FilterExpression: NotRequired[str],
InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef], # (1)
UpdateGroupRequestRequestTypeDef#
# UpdateGroupRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import UpdateGroupRequestRequestTypeDef
def get_value() -> UpdateGroupRequestRequestTypeDef:
return {
"GroupName": ...,
}
# UpdateGroupRequestRequestTypeDef definition
class UpdateGroupRequestRequestTypeDef(TypedDict):
GroupName: NotRequired[str],
GroupARN: NotRequired[str],
FilterExpression: NotRequired[str],
InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef], # (1)
CreateGroupRequestRequestTypeDef#
# CreateGroupRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import CreateGroupRequestRequestTypeDef
def get_value() -> CreateGroupRequestRequestTypeDef:
return {
"GroupName": ...,
}
# CreateGroupRequestRequestTypeDef definition
class CreateGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
FilterExpression: NotRequired[str],
InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_xray.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateSamplingRuleRequestRequestTypeDef#
# CreateSamplingRuleRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import CreateSamplingRuleRequestRequestTypeDef
def get_value() -> CreateSamplingRuleRequestRequestTypeDef:
return {
"SamplingRule": ...,
}
# CreateSamplingRuleRequestRequestTypeDef definition
class CreateSamplingRuleRequestRequestTypeDef(TypedDict):
SamplingRule: SamplingRuleTypeDef, # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See SamplingRuleTypeDef
- See TagTypeDef
SamplingRuleRecordTypeDef#
# SamplingRuleRecordTypeDef usage example
from mypy_boto3_xray.type_defs import SamplingRuleRecordTypeDef
def get_value() -> SamplingRuleRecordTypeDef:
return {
"SamplingRule": ...,
}
# SamplingRuleRecordTypeDef definition
class SamplingRuleRecordTypeDef(TypedDict):
SamplingRule: NotRequired[SamplingRuleTypeDef], # (1)
CreatedAt: NotRequired[datetime],
ModifiedAt: NotRequired[datetime],
EdgeStatisticsTypeDef#
# EdgeStatisticsTypeDef usage example
from mypy_boto3_xray.type_defs import EdgeStatisticsTypeDef
def get_value() -> EdgeStatisticsTypeDef:
return {
"OkCount": ...,
}
# EdgeStatisticsTypeDef definition
class EdgeStatisticsTypeDef(TypedDict):
OkCount: NotRequired[int],
ErrorStatistics: NotRequired[ErrorStatisticsTypeDef], # (1)
FaultStatistics: NotRequired[FaultStatisticsTypeDef], # (2)
TotalCount: NotRequired[int],
TotalResponseTime: NotRequired[float],
ServiceStatisticsTypeDef#
# ServiceStatisticsTypeDef usage example
from mypy_boto3_xray.type_defs import ServiceStatisticsTypeDef
def get_value() -> ServiceStatisticsTypeDef:
return {
"OkCount": ...,
}
# ServiceStatisticsTypeDef definition
class ServiceStatisticsTypeDef(TypedDict):
OkCount: NotRequired[int],
ErrorStatistics: NotRequired[ErrorStatisticsTypeDef], # (1)
FaultStatistics: NotRequired[FaultStatisticsTypeDef], # (2)
TotalCount: NotRequired[int],
TotalResponseTime: NotRequired[float],
GetEncryptionConfigResultTypeDef#
# GetEncryptionConfigResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetEncryptionConfigResultTypeDef
def get_value() -> GetEncryptionConfigResultTypeDef:
return {
"EncryptionConfig": ...,
"ResponseMetadata": ...,
}
# GetEncryptionConfigResultTypeDef definition
class GetEncryptionConfigResultTypeDef(TypedDict):
EncryptionConfig: EncryptionConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutEncryptionConfigResultTypeDef#
# PutEncryptionConfigResultTypeDef usage example
from mypy_boto3_xray.type_defs import PutEncryptionConfigResultTypeDef
def get_value() -> PutEncryptionConfigResultTypeDef:
return {
"EncryptionConfig": ...,
"ResponseMetadata": ...,
}
# PutEncryptionConfigResultTypeDef definition
class PutEncryptionConfigResultTypeDef(TypedDict):
EncryptionConfig: EncryptionConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ErrorRootCauseEntityTypeDef#
# ErrorRootCauseEntityTypeDef usage example
from mypy_boto3_xray.type_defs import ErrorRootCauseEntityTypeDef
def get_value() -> ErrorRootCauseEntityTypeDef:
return {
"Name": ...,
}
# ErrorRootCauseEntityTypeDef definition
class ErrorRootCauseEntityTypeDef(TypedDict):
Name: NotRequired[str],
Exceptions: NotRequired[List[RootCauseExceptionTypeDef]], # (1)
Remote: NotRequired[bool],
FaultRootCauseEntityTypeDef#
# FaultRootCauseEntityTypeDef usage example
from mypy_boto3_xray.type_defs import FaultRootCauseEntityTypeDef
def get_value() -> FaultRootCauseEntityTypeDef:
return {
"Name": ...,
}
# FaultRootCauseEntityTypeDef definition
class FaultRootCauseEntityTypeDef(TypedDict):
Name: NotRequired[str],
Exceptions: NotRequired[List[RootCauseExceptionTypeDef]], # (1)
Remote: NotRequired[bool],
GetSamplingStatisticSummariesResultTypeDef#
# GetSamplingStatisticSummariesResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetSamplingStatisticSummariesResultTypeDef
def get_value() -> GetSamplingStatisticSummariesResultTypeDef:
return {
"SamplingStatisticSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetSamplingStatisticSummariesResultTypeDef definition
class GetSamplingStatisticSummariesResultTypeDef(TypedDict):
SamplingStatisticSummaries: List[SamplingStatisticSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSamplingTargetsRequestRequestTypeDef#
# GetSamplingTargetsRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetSamplingTargetsRequestRequestTypeDef
def get_value() -> GetSamplingTargetsRequestRequestTypeDef:
return {
"SamplingStatisticsDocuments": ...,
}
# GetSamplingTargetsRequestRequestTypeDef definition
class GetSamplingTargetsRequestRequestTypeDef(TypedDict):
SamplingStatisticsDocuments: Sequence[SamplingStatisticsDocumentTypeDef], # (1)
GetSamplingTargetsResultTypeDef#
# GetSamplingTargetsResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetSamplingTargetsResultTypeDef
def get_value() -> GetSamplingTargetsResultTypeDef:
return {
"SamplingTargetDocuments": ...,
"LastRuleModification": ...,
"UnprocessedStatistics": ...,
"ResponseMetadata": ...,
}
# GetSamplingTargetsResultTypeDef definition
class GetSamplingTargetsResultTypeDef(TypedDict):
SamplingTargetDocuments: List[SamplingTargetDocumentTypeDef], # (1)
LastRuleModification: datetime,
UnprocessedStatistics: List[UnprocessedStatisticsTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef#
# GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef usage example
from mypy_boto3_xray.type_defs import GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef
def get_value() -> GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
}
# GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef definition
class GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef(TypedDict):
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
TimeRangeType: NotRequired[TimeRangeTypeType], # (1)
Sampling: NotRequired[bool],
SamplingStrategy: NotRequired[SamplingStrategyTypeDef], # (2)
FilterExpression: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
GetTraceSummariesRequestRequestTypeDef#
# GetTraceSummariesRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import GetTraceSummariesRequestRequestTypeDef
def get_value() -> GetTraceSummariesRequestRequestTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
}
# GetTraceSummariesRequestRequestTypeDef definition
class GetTraceSummariesRequestRequestTypeDef(TypedDict):
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
TimeRangeType: NotRequired[TimeRangeTypeType], # (1)
Sampling: NotRequired[bool],
SamplingStrategy: NotRequired[SamplingStrategyTypeDef], # (2)
FilterExpression: NotRequired[str],
NextToken: NotRequired[str],
InsightImpactGraphServiceTypeDef#
# InsightImpactGraphServiceTypeDef usage example
from mypy_boto3_xray.type_defs import InsightImpactGraphServiceTypeDef
def get_value() -> InsightImpactGraphServiceTypeDef:
return {
"ReferenceId": ...,
}
# 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 usage example
from mypy_boto3_xray.type_defs import ListResourcePoliciesResultTypeDef
def get_value() -> ListResourcePoliciesResultTypeDef:
return {
"ResourcePolicies": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListResourcePoliciesResultTypeDef definition
class ListResourcePoliciesResultTypeDef(TypedDict):
ResourcePolicies: List[ResourcePolicyTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutResourcePolicyResultTypeDef#
# PutResourcePolicyResultTypeDef usage example
from mypy_boto3_xray.type_defs import PutResourcePolicyResultTypeDef
def get_value() -> PutResourcePolicyResultTypeDef:
return {
"ResourcePolicy": ...,
"ResponseMetadata": ...,
}
# PutResourcePolicyResultTypeDef definition
class PutResourcePolicyResultTypeDef(TypedDict):
ResourcePolicy: ResourcePolicyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutTraceSegmentsResultTypeDef#
# PutTraceSegmentsResultTypeDef usage example
from mypy_boto3_xray.type_defs import PutTraceSegmentsResultTypeDef
def get_value() -> PutTraceSegmentsResultTypeDef:
return {
"UnprocessedTraceSegments": ...,
"ResponseMetadata": ...,
}
# PutTraceSegmentsResultTypeDef definition
class PutTraceSegmentsResultTypeDef(TypedDict):
UnprocessedTraceSegments: List[UnprocessedTraceSegmentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ResponseTimeRootCauseServiceTypeDef#
# ResponseTimeRootCauseServiceTypeDef usage example
from mypy_boto3_xray.type_defs import ResponseTimeRootCauseServiceTypeDef
def get_value() -> ResponseTimeRootCauseServiceTypeDef:
return {
"Name": ...,
}
# 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],
UpdateSamplingRuleRequestRequestTypeDef#
# UpdateSamplingRuleRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import UpdateSamplingRuleRequestRequestTypeDef
def get_value() -> UpdateSamplingRuleRequestRequestTypeDef:
return {
"SamplingRuleUpdate": ...,
}
# UpdateSamplingRuleRequestRequestTypeDef definition
class UpdateSamplingRuleRequestRequestTypeDef(TypedDict):
SamplingRuleUpdate: SamplingRuleUpdateTypeDef, # (1)
TraceTypeDef#
# TraceTypeDef usage example
from mypy_boto3_xray.type_defs import TraceTypeDef
def get_value() -> TraceTypeDef:
return {
"Id": ...,
}
# TraceTypeDef definition
class TraceTypeDef(TypedDict):
Id: NotRequired[str],
Duration: NotRequired[float],
LimitExceeded: NotRequired[bool],
Segments: NotRequired[List[SegmentTypeDef]], # (1)
- See SegmentTypeDef
InsightEventTypeDef#
# InsightEventTypeDef usage example
from mypy_boto3_xray.type_defs import InsightEventTypeDef
def get_value() -> InsightEventTypeDef:
return {
"Summary": ...,
}
# 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 usage example
from mypy_boto3_xray.type_defs import InsightSummaryTypeDef
def get_value() -> InsightSummaryTypeDef:
return {
"InsightId": ...,
}
# 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 usage example
from mypy_boto3_xray.type_defs import InsightTypeDef
def get_value() -> InsightTypeDef:
return {
"InsightId": ...,
}
# 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
PutTelemetryRecordsRequestRequestTypeDef#
# PutTelemetryRecordsRequestRequestTypeDef usage example
from mypy_boto3_xray.type_defs import PutTelemetryRecordsRequestRequestTypeDef
def get_value() -> PutTelemetryRecordsRequestRequestTypeDef:
return {
"TelemetryRecords": ...,
}
# PutTelemetryRecordsRequestRequestTypeDef definition
class PutTelemetryRecordsRequestRequestTypeDef(TypedDict):
TelemetryRecords: Sequence[TelemetryRecordTypeDef], # (1)
EC2InstanceId: NotRequired[str],
Hostname: NotRequired[str],
ResourceARN: NotRequired[str],
GetGroupsResultTypeDef#
# GetGroupsResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetGroupsResultTypeDef
def get_value() -> GetGroupsResultTypeDef:
return {
"Groups": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetGroupsResultTypeDef definition
class GetGroupsResultTypeDef(TypedDict):
Groups: List[GroupSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateGroupResultTypeDef#
# CreateGroupResultTypeDef usage example
from mypy_boto3_xray.type_defs import CreateGroupResultTypeDef
def get_value() -> CreateGroupResultTypeDef:
return {
"Group": ...,
"ResponseMetadata": ...,
}
# CreateGroupResultTypeDef definition
class CreateGroupResultTypeDef(TypedDict):
Group: GroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
GetGroupResultTypeDef#
# GetGroupResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetGroupResultTypeDef
def get_value() -> GetGroupResultTypeDef:
return {
"Group": ...,
"ResponseMetadata": ...,
}
# GetGroupResultTypeDef definition
class GetGroupResultTypeDef(TypedDict):
Group: GroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
UpdateGroupResultTypeDef#
# UpdateGroupResultTypeDef usage example
from mypy_boto3_xray.type_defs import UpdateGroupResultTypeDef
def get_value() -> UpdateGroupResultTypeDef:
return {
"Group": ...,
"ResponseMetadata": ...,
}
# UpdateGroupResultTypeDef definition
class UpdateGroupResultTypeDef(TypedDict):
Group: GroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
CreateSamplingRuleResultTypeDef#
# CreateSamplingRuleResultTypeDef usage example
from mypy_boto3_xray.type_defs import CreateSamplingRuleResultTypeDef
def get_value() -> CreateSamplingRuleResultTypeDef:
return {
"SamplingRuleRecord": ...,
"ResponseMetadata": ...,
}
# CreateSamplingRuleResultTypeDef definition
class CreateSamplingRuleResultTypeDef(TypedDict):
SamplingRuleRecord: SamplingRuleRecordTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteSamplingRuleResultTypeDef#
# DeleteSamplingRuleResultTypeDef usage example
from mypy_boto3_xray.type_defs import DeleteSamplingRuleResultTypeDef
def get_value() -> DeleteSamplingRuleResultTypeDef:
return {
"SamplingRuleRecord": ...,
"ResponseMetadata": ...,
}
# DeleteSamplingRuleResultTypeDef definition
class DeleteSamplingRuleResultTypeDef(TypedDict):
SamplingRuleRecord: SamplingRuleRecordTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSamplingRulesResultTypeDef#
# GetSamplingRulesResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetSamplingRulesResultTypeDef
def get_value() -> GetSamplingRulesResultTypeDef:
return {
"SamplingRuleRecords": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetSamplingRulesResultTypeDef definition
class GetSamplingRulesResultTypeDef(TypedDict):
SamplingRuleRecords: List[SamplingRuleRecordTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateSamplingRuleResultTypeDef#
# UpdateSamplingRuleResultTypeDef usage example
from mypy_boto3_xray.type_defs import UpdateSamplingRuleResultTypeDef
def get_value() -> UpdateSamplingRuleResultTypeDef:
return {
"SamplingRuleRecord": ...,
"ResponseMetadata": ...,
}
# UpdateSamplingRuleResultTypeDef definition
class UpdateSamplingRuleResultTypeDef(TypedDict):
SamplingRuleRecord: SamplingRuleRecordTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EdgeTypeDef#
# EdgeTypeDef usage example
from mypy_boto3_xray.type_defs import EdgeTypeDef
def get_value() -> EdgeTypeDef:
return {
"ReferenceId": ...,
}
# 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 usage example
from mypy_boto3_xray.type_defs import TimeSeriesServiceStatisticsTypeDef
def get_value() -> TimeSeriesServiceStatisticsTypeDef:
return {
"Timestamp": ...,
}
# 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 usage example
from mypy_boto3_xray.type_defs import ErrorRootCauseServiceTypeDef
def get_value() -> ErrorRootCauseServiceTypeDef:
return {
"Name": ...,
}
# 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 usage example
from mypy_boto3_xray.type_defs import FaultRootCauseServiceTypeDef
def get_value() -> FaultRootCauseServiceTypeDef:
return {
"Name": ...,
}
# 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],
GetInsightImpactGraphResultTypeDef#
# GetInsightImpactGraphResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetInsightImpactGraphResultTypeDef
def get_value() -> GetInsightImpactGraphResultTypeDef:
return {
"InsightId": ...,
"StartTime": ...,
"EndTime": ...,
"ServiceGraphStartTime": ...,
"ServiceGraphEndTime": ...,
"Services": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetInsightImpactGraphResultTypeDef definition
class GetInsightImpactGraphResultTypeDef(TypedDict):
InsightId: str,
StartTime: datetime,
EndTime: datetime,
ServiceGraphStartTime: datetime,
ServiceGraphEndTime: datetime,
Services: List[InsightImpactGraphServiceTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ResponseTimeRootCauseTypeDef#
# ResponseTimeRootCauseTypeDef usage example
from mypy_boto3_xray.type_defs import ResponseTimeRootCauseTypeDef
def get_value() -> ResponseTimeRootCauseTypeDef:
return {
"Services": ...,
}
# ResponseTimeRootCauseTypeDef definition
class ResponseTimeRootCauseTypeDef(TypedDict):
Services: NotRequired[List[ResponseTimeRootCauseServiceTypeDef]], # (1)
ClientImpacting: NotRequired[bool],
BatchGetTracesResultTypeDef#
# BatchGetTracesResultTypeDef usage example
from mypy_boto3_xray.type_defs import BatchGetTracesResultTypeDef
def get_value() -> BatchGetTracesResultTypeDef:
return {
"Traces": ...,
"UnprocessedTraceIds": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# BatchGetTracesResultTypeDef definition
class BatchGetTracesResultTypeDef(TypedDict):
Traces: List[TraceTypeDef], # (1)
UnprocessedTraceIds: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TraceTypeDef
- See ResponseMetadataTypeDef
GetInsightEventsResultTypeDef#
# GetInsightEventsResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetInsightEventsResultTypeDef
def get_value() -> GetInsightEventsResultTypeDef:
return {
"InsightEvents": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetInsightEventsResultTypeDef definition
class GetInsightEventsResultTypeDef(TypedDict):
InsightEvents: List[InsightEventTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetInsightSummariesResultTypeDef#
# GetInsightSummariesResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetInsightSummariesResultTypeDef
def get_value() -> GetInsightSummariesResultTypeDef:
return {
"InsightSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetInsightSummariesResultTypeDef definition
class GetInsightSummariesResultTypeDef(TypedDict):
InsightSummaries: List[InsightSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetInsightResultTypeDef#
# GetInsightResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetInsightResultTypeDef
def get_value() -> GetInsightResultTypeDef:
return {
"Insight": ...,
"ResponseMetadata": ...,
}
# GetInsightResultTypeDef definition
class GetInsightResultTypeDef(TypedDict):
Insight: InsightTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ServiceTypeDef#
# ServiceTypeDef usage example
from mypy_boto3_xray.type_defs import ServiceTypeDef
def get_value() -> ServiceTypeDef:
return {
"ReferenceId": ...,
}
# 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 usage example
from mypy_boto3_xray.type_defs import GetTimeSeriesServiceStatisticsResultTypeDef
def get_value() -> GetTimeSeriesServiceStatisticsResultTypeDef:
return {
"TimeSeriesServiceStatistics": ...,
"ContainsOldGroupVersions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetTimeSeriesServiceStatisticsResultTypeDef definition
class GetTimeSeriesServiceStatisticsResultTypeDef(TypedDict):
TimeSeriesServiceStatistics: List[TimeSeriesServiceStatisticsTypeDef], # (1)
ContainsOldGroupVersions: bool,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ErrorRootCauseTypeDef#
# ErrorRootCauseTypeDef usage example
from mypy_boto3_xray.type_defs import ErrorRootCauseTypeDef
def get_value() -> ErrorRootCauseTypeDef:
return {
"Services": ...,
}
# ErrorRootCauseTypeDef definition
class ErrorRootCauseTypeDef(TypedDict):
Services: NotRequired[List[ErrorRootCauseServiceTypeDef]], # (1)
ClientImpacting: NotRequired[bool],
FaultRootCauseTypeDef#
# FaultRootCauseTypeDef usage example
from mypy_boto3_xray.type_defs import FaultRootCauseTypeDef
def get_value() -> FaultRootCauseTypeDef:
return {
"Services": ...,
}
# FaultRootCauseTypeDef definition
class FaultRootCauseTypeDef(TypedDict):
Services: NotRequired[List[FaultRootCauseServiceTypeDef]], # (1)
ClientImpacting: NotRequired[bool],
GetServiceGraphResultTypeDef#
# GetServiceGraphResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetServiceGraphResultTypeDef
def get_value() -> GetServiceGraphResultTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
"Services": ...,
"ContainsOldGroupVersions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetServiceGraphResultTypeDef definition
class GetServiceGraphResultTypeDef(TypedDict):
StartTime: datetime,
EndTime: datetime,
Services: List[ServiceTypeDef], # (1)
ContainsOldGroupVersions: bool,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetTraceGraphResultTypeDef#
# GetTraceGraphResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetTraceGraphResultTypeDef
def get_value() -> GetTraceGraphResultTypeDef:
return {
"Services": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetTraceGraphResultTypeDef definition
class GetTraceGraphResultTypeDef(TypedDict):
Services: List[ServiceTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TraceSummaryTypeDef#
# TraceSummaryTypeDef usage example
from mypy_boto3_xray.type_defs import TraceSummaryTypeDef
def get_value() -> TraceSummaryTypeDef:
return {
"Id": ...,
}
# TraceSummaryTypeDef definition
class TraceSummaryTypeDef(TypedDict):
Id: NotRequired[str],
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
GetTraceSummariesResultTypeDef#
# GetTraceSummariesResultTypeDef usage example
from mypy_boto3_xray.type_defs import GetTraceSummariesResultTypeDef
def get_value() -> GetTraceSummariesResultTypeDef:
return {
"TraceSummaries": ...,
"ApproximateTime": ...,
"TracesProcessedCount": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetTraceSummariesResultTypeDef definition
class GetTraceSummariesResultTypeDef(TypedDict):
TraceSummaries: List[TraceSummaryTypeDef], # (1)
ApproximateTime: datetime,
TracesProcessedCount: int,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)