Type definitions

Index > XRay > Type definitions

Auto-generated documentation for XRay type annotations stubs module mypy-boto3-xray.

TimestampTypeDef

# TimestampTypeDef Union usage example

from mypy_boto3_xray.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

SamplingRuleUnionTypeDef

# SamplingRuleUnionTypeDef Union usage example

from mypy_boto3_xray.type_defs import SamplingRuleUnionTypeDef


def get_value() -> SamplingRuleUnionTypeDef:
    return ...


# SamplingRuleUnionTypeDef definition

SamplingRuleUnionTypeDef = Union[
    SamplingRuleTypeDef,  # (1)
    SamplingRuleOutputTypeDef,  # (2)
]

1. See SamplingRuleTypeDef
2. See SamplingRuleOutputTypeDef

AliasTypeDef

# AliasTypeDef TypedDict 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 TypedDict 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 TypedDict 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 TypedDict 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 TypedDict 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],

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict 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],

BatchGetTracesRequestTypeDef

# BatchGetTracesRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import BatchGetTracesRequestTypeDef


def get_value() -> BatchGetTracesRequestTypeDef:
    return {
        "TraceIds": ...,
    }


# BatchGetTracesRequestTypeDef definition

class BatchGetTracesRequestTypeDef(TypedDict):
    TraceIds: Sequence[str],
    NextToken: NotRequired[str],

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

CancelTraceRetrievalRequestTypeDef

# CancelTraceRetrievalRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import CancelTraceRetrievalRequestTypeDef


def get_value() -> CancelTraceRetrievalRequestTypeDef:
    return {
        "RetrievalToken": ...,
    }


# CancelTraceRetrievalRequestTypeDef definition

class CancelTraceRetrievalRequestTypeDef(TypedDict):
    RetrievalToken: str,

InsightsConfigurationTypeDef

# InsightsConfigurationTypeDef TypedDict 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 TypedDict usage example

from mypy_boto3_xray.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

DeleteGroupRequestTypeDef

# DeleteGroupRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import DeleteGroupRequestTypeDef


def get_value() -> DeleteGroupRequestTypeDef:
    return {
        "GroupName": ...,
    }


# DeleteGroupRequestTypeDef definition

class DeleteGroupRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],

DeleteResourcePolicyRequestTypeDef

# DeleteResourcePolicyRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import DeleteResourcePolicyRequestTypeDef


def get_value() -> DeleteResourcePolicyRequestTypeDef:
    return {
        "PolicyName": ...,
    }


# DeleteResourcePolicyRequestTypeDef definition

class DeleteResourcePolicyRequestTypeDef(TypedDict):
    PolicyName: str,
    PolicyRevisionId: NotRequired[str],

DeleteSamplingRuleRequestTypeDef

# DeleteSamplingRuleRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import DeleteSamplingRuleRequestTypeDef


def get_value() -> DeleteSamplingRuleRequestTypeDef:
    return {
        "RuleName": ...,
    }


# DeleteSamplingRuleRequestTypeDef definition

class DeleteSamplingRuleRequestTypeDef(TypedDict):
    RuleName: NotRequired[str],
    RuleARN: NotRequired[str],

ErrorStatisticsTypeDef

# ErrorStatisticsTypeDef TypedDict 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 TypedDict 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 TypedDict 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 TypedDict 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)

1. See EncryptionStatusType
2. See EncryptionTypeType

RootCauseExceptionTypeDef

# RootCauseExceptionTypeDef TypedDict 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 TypedDict 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],

GetGroupRequestTypeDef

# GetGroupRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetGroupRequestTypeDef


def get_value() -> GetGroupRequestTypeDef:
    return {
        "GroupName": ...,
    }


# GetGroupRequestTypeDef definition

class GetGroupRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],

GetGroupsRequestTypeDef

# GetGroupsRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetGroupsRequestTypeDef


def get_value() -> GetGroupsRequestTypeDef:
    return {
        "NextToken": ...,
    }


# GetGroupsRequestTypeDef definition

class GetGroupsRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

GetIndexingRulesRequestTypeDef

# GetIndexingRulesRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetIndexingRulesRequestTypeDef


def get_value() -> GetIndexingRulesRequestTypeDef:
    return {
        "NextToken": ...,
    }


# GetIndexingRulesRequestTypeDef definition

class GetIndexingRulesRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

GetInsightEventsRequestTypeDef

# GetInsightEventsRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetInsightEventsRequestTypeDef


def get_value() -> GetInsightEventsRequestTypeDef:
    return {
        "InsightId": ...,
    }


# GetInsightEventsRequestTypeDef definition

class GetInsightEventsRequestTypeDef(TypedDict):
    InsightId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetInsightRequestTypeDef

# GetInsightRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetInsightRequestTypeDef


def get_value() -> GetInsightRequestTypeDef:
    return {
        "InsightId": ...,
    }


# GetInsightRequestTypeDef definition

class GetInsightRequestTypeDef(TypedDict):
    InsightId: str,

GetRetrievedTracesGraphRequestTypeDef

# GetRetrievedTracesGraphRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetRetrievedTracesGraphRequestTypeDef


def get_value() -> GetRetrievedTracesGraphRequestTypeDef:
    return {
        "RetrievalToken": ...,
    }


# GetRetrievedTracesGraphRequestTypeDef definition

class GetRetrievedTracesGraphRequestTypeDef(TypedDict):
    RetrievalToken: str,
    NextToken: NotRequired[str],

GetSamplingRulesRequestTypeDef

# GetSamplingRulesRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetSamplingRulesRequestTypeDef


def get_value() -> GetSamplingRulesRequestTypeDef:
    return {
        "NextToken": ...,
    }


# GetSamplingRulesRequestTypeDef definition

class GetSamplingRulesRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

GetSamplingStatisticSummariesRequestTypeDef

# GetSamplingStatisticSummariesRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetSamplingStatisticSummariesRequestTypeDef


def get_value() -> GetSamplingStatisticSummariesRequestTypeDef:
    return {
        "NextToken": ...,
    }


# GetSamplingStatisticSummariesRequestTypeDef definition

class GetSamplingStatisticSummariesRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

SamplingStatisticSummaryTypeDef

# SamplingStatisticSummaryTypeDef TypedDict 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],

SamplingTargetDocumentTypeDef

# SamplingTargetDocumentTypeDef TypedDict 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 TypedDict 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],

GetTraceGraphRequestTypeDef

# GetTraceGraphRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTraceGraphRequestTypeDef


def get_value() -> GetTraceGraphRequestTypeDef:
    return {
        "TraceIds": ...,
    }


# GetTraceGraphRequestTypeDef definition

class GetTraceGraphRequestTypeDef(TypedDict):
    TraceIds: Sequence[str],
    NextToken: NotRequired[str],

SamplingStrategyTypeDef

# SamplingStrategyTypeDef TypedDict 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],

1. See SamplingStrategyNameType

GraphLinkTypeDef

# GraphLinkTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GraphLinkTypeDef


def get_value() -> GraphLinkTypeDef:
    return {
        "ReferenceType": ...,
    }


# GraphLinkTypeDef definition

class GraphLinkTypeDef(TypedDict):
    ReferenceType: NotRequired[str],
    SourceTraceId: NotRequired[str],
    DestinationTraceIds: NotRequired[List[str]],

HttpTypeDef

# HttpTypeDef TypedDict 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],

ProbabilisticRuleValueTypeDef

# ProbabilisticRuleValueTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ProbabilisticRuleValueTypeDef


def get_value() -> ProbabilisticRuleValueTypeDef:
    return {
        "DesiredSamplingPercentage": ...,
    }


# ProbabilisticRuleValueTypeDef definition

class ProbabilisticRuleValueTypeDef(TypedDict):
    DesiredSamplingPercentage: float,
    ActualSamplingPercentage: NotRequired[float],

ProbabilisticRuleValueUpdateTypeDef

# ProbabilisticRuleValueUpdateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ProbabilisticRuleValueUpdateTypeDef


def get_value() -> ProbabilisticRuleValueUpdateTypeDef:
    return {
        "DesiredSamplingPercentage": ...,
    }


# ProbabilisticRuleValueUpdateTypeDef definition

class ProbabilisticRuleValueUpdateTypeDef(TypedDict):
    DesiredSamplingPercentage: float,

RequestImpactStatisticsTypeDef

# RequestImpactStatisticsTypeDef TypedDict 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 TypedDict 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 TypedDict usage example

from mypy_boto3_xray.type_defs import InstanceIdDetailTypeDef


def get_value() -> InstanceIdDetailTypeDef:
    return {
        "Id": ...,
    }


# InstanceIdDetailTypeDef definition

class InstanceIdDetailTypeDef(TypedDict):
    Id: NotRequired[str],

ListResourcePoliciesRequestTypeDef

# ListResourcePoliciesRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ListResourcePoliciesRequestTypeDef


def get_value() -> ListResourcePoliciesRequestTypeDef:
    return {
        "NextToken": ...,
    }


# ListResourcePoliciesRequestTypeDef definition

class ListResourcePoliciesRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

ResourcePolicyTypeDef

# ResourcePolicyTypeDef TypedDict 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],

ListRetrievedTracesRequestTypeDef

# ListRetrievedTracesRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ListRetrievedTracesRequestTypeDef


def get_value() -> ListRetrievedTracesRequestTypeDef:
    return {
        "RetrievalToken": ...,
    }


# ListRetrievedTracesRequestTypeDef definition

class ListRetrievedTracesRequestTypeDef(TypedDict):
    RetrievalToken: str,
    TraceFormat: NotRequired[TraceFormatTypeType],  # (1)
    NextToken: NotRequired[str],

1. See TraceFormatTypeType

ListTagsForResourceRequestTypeDef

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    ResourceARN: str,
    NextToken: NotRequired[str],

PutEncryptionConfigRequestTypeDef

# PutEncryptionConfigRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import PutEncryptionConfigRequestTypeDef


def get_value() -> PutEncryptionConfigRequestTypeDef:
    return {
        "Type": ...,
    }


# PutEncryptionConfigRequestTypeDef definition

class PutEncryptionConfigRequestTypeDef(TypedDict):
    Type: EncryptionTypeType,  # (1)
    KeyId: NotRequired[str],

1. See EncryptionTypeType

PutResourcePolicyRequestTypeDef

# PutResourcePolicyRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import PutResourcePolicyRequestTypeDef


def get_value() -> PutResourcePolicyRequestTypeDef:
    return {
        "PolicyName": ...,
    }


# PutResourcePolicyRequestTypeDef definition

class PutResourcePolicyRequestTypeDef(TypedDict):
    PolicyName: str,
    PolicyDocument: str,
    PolicyRevisionId: NotRequired[str],
    BypassPolicyLockoutCheck: NotRequired[bool],

PutTraceSegmentsRequestTypeDef

# PutTraceSegmentsRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import PutTraceSegmentsRequestTypeDef


def get_value() -> PutTraceSegmentsRequestTypeDef:
    return {
        "TraceSegmentDocuments": ...,
    }


# PutTraceSegmentsRequestTypeDef definition

class PutTraceSegmentsRequestTypeDef(TypedDict):
    TraceSegmentDocuments: Sequence[str],

UnprocessedTraceSegmentTypeDef

# UnprocessedTraceSegmentTypeDef TypedDict 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 TypedDict usage example

from mypy_boto3_xray.type_defs import ResourceARNDetailTypeDef


def get_value() -> ResourceARNDetailTypeDef:
    return {
        "ARN": ...,
    }


# ResourceARNDetailTypeDef definition

class ResourceARNDetailTypeDef(TypedDict):
    ARN: NotRequired[str],

ResponseTimeRootCauseEntityTypeDef

# ResponseTimeRootCauseEntityTypeDef TypedDict 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],

SpanTypeDef

# SpanTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import SpanTypeDef


def get_value() -> SpanTypeDef:
    return {
        "Id": ...,
    }


# SpanTypeDef definition

class SpanTypeDef(TypedDict):
    Id: NotRequired[str],
    Document: NotRequired[str],

SamplingRuleOutputTypeDef

# SamplingRuleOutputTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import SamplingRuleOutputTypeDef


def get_value() -> SamplingRuleOutputTypeDef:
    return {
        "RuleName": ...,
    }


# 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]],

SamplingRuleTypeDef

# SamplingRuleTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import SamplingRuleTypeDef


def get_value() -> SamplingRuleTypeDef:
    return {
        "RuleName": ...,
    }


# 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]],

SamplingRuleUpdateTypeDef

# SamplingRuleUpdateTypeDef TypedDict 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 TypedDict 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],

UntagResourceRequestTypeDef

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateTraceSegmentDestinationRequestTypeDef

# UpdateTraceSegmentDestinationRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import UpdateTraceSegmentDestinationRequestTypeDef


def get_value() -> UpdateTraceSegmentDestinationRequestTypeDef:
    return {
        "Destination": ...,
    }


# UpdateTraceSegmentDestinationRequestTypeDef definition

class UpdateTraceSegmentDestinationRequestTypeDef(TypedDict):
    Destination: NotRequired[TraceSegmentDestinationType],  # (1)

1. See TraceSegmentDestinationType

AnomalousServiceTypeDef

# AnomalousServiceTypeDef TypedDict 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)

1. See ServiceIdTypeDef

TraceUserTypeDef

# TraceUserTypeDef TypedDict 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)

1. See ServiceIdTypeDef

ValueWithServiceIdsTypeDef

# ValueWithServiceIdsTypeDef TypedDict 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)

1. See AnnotationValueTypeDef
2. See ServiceIdTypeDef

BatchGetTracesRequestPaginateTypeDef

# BatchGetTracesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import BatchGetTracesRequestPaginateTypeDef


def get_value() -> BatchGetTracesRequestPaginateTypeDef:
    return {
        "TraceIds": ...,
    }


# BatchGetTracesRequestPaginateTypeDef definition

class BatchGetTracesRequestPaginateTypeDef(TypedDict):
    TraceIds: Sequence[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GetGroupsRequestPaginateTypeDef

# GetGroupsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetGroupsRequestPaginateTypeDef


def get_value() -> GetGroupsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# GetGroupsRequestPaginateTypeDef definition

class GetGroupsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GetSamplingRulesRequestPaginateTypeDef

# GetSamplingRulesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetSamplingRulesRequestPaginateTypeDef


def get_value() -> GetSamplingRulesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# GetSamplingRulesRequestPaginateTypeDef definition

class GetSamplingRulesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GetSamplingStatisticSummariesRequestPaginateTypeDef

# GetSamplingStatisticSummariesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetSamplingStatisticSummariesRequestPaginateTypeDef


def get_value() -> GetSamplingStatisticSummariesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# GetSamplingStatisticSummariesRequestPaginateTypeDef definition

class GetSamplingStatisticSummariesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GetTraceGraphRequestPaginateTypeDef

# GetTraceGraphRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTraceGraphRequestPaginateTypeDef


def get_value() -> GetTraceGraphRequestPaginateTypeDef:
    return {
        "TraceIds": ...,
    }


# GetTraceGraphRequestPaginateTypeDef definition

class GetTraceGraphRequestPaginateTypeDef(TypedDict):
    TraceIds: Sequence[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListResourcePoliciesRequestPaginateTypeDef

# ListResourcePoliciesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ListResourcePoliciesRequestPaginateTypeDef


def get_value() -> ListResourcePoliciesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListResourcePoliciesRequestPaginateTypeDef definition

class ListResourcePoliciesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListTagsForResourceRequestPaginateTypeDef

# ListTagsForResourceRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ListTagsForResourceRequestPaginateTypeDef


def get_value() -> ListTagsForResourceRequestPaginateTypeDef:
    return {
        "ResourceARN": ...,
    }


# ListTagsForResourceRequestPaginateTypeDef definition

class ListTagsForResourceRequestPaginateTypeDef(TypedDict):
    ResourceARN: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GetTraceSegmentDestinationResultTypeDef

# GetTraceSegmentDestinationResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTraceSegmentDestinationResultTypeDef


def get_value() -> GetTraceSegmentDestinationResultTypeDef:
    return {
        "Destination": ...,
    }


# GetTraceSegmentDestinationResultTypeDef definition

class GetTraceSegmentDestinationResultTypeDef(TypedDict):
    Destination: TraceSegmentDestinationType,  # (1)
    Status: TraceSegmentDestinationStatusType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See TraceSegmentDestinationType
2. See TraceSegmentDestinationStatusType
3. See ResponseMetadataTypeDef

StartTraceRetrievalResultTypeDef

# StartTraceRetrievalResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import StartTraceRetrievalResultTypeDef


def get_value() -> StartTraceRetrievalResultTypeDef:
    return {
        "RetrievalToken": ...,
    }


# StartTraceRetrievalResultTypeDef definition

class StartTraceRetrievalResultTypeDef(TypedDict):
    RetrievalToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

UpdateTraceSegmentDestinationResultTypeDef

# UpdateTraceSegmentDestinationResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import UpdateTraceSegmentDestinationResultTypeDef


def get_value() -> UpdateTraceSegmentDestinationResultTypeDef:
    return {
        "Destination": ...,
    }


# UpdateTraceSegmentDestinationResultTypeDef definition

class UpdateTraceSegmentDestinationResultTypeDef(TypedDict):
    Destination: TraceSegmentDestinationType,  # (1)
    Status: TraceSegmentDestinationStatusType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See TraceSegmentDestinationType
2. See TraceSegmentDestinationStatusType
3. See ResponseMetadataTypeDef

GroupSummaryTypeDef

# GroupSummaryTypeDef TypedDict 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)

1. See InsightsConfigurationTypeDef

GroupTypeDef

# GroupTypeDef TypedDict 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)

1. See InsightsConfigurationTypeDef

UpdateGroupRequestTypeDef

# UpdateGroupRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import UpdateGroupRequestTypeDef


def get_value() -> UpdateGroupRequestTypeDef:
    return {
        "GroupName": ...,
    }


# UpdateGroupRequestTypeDef definition

class UpdateGroupRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],
    FilterExpression: NotRequired[str],
    InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef],  # (1)

1. See InsightsConfigurationTypeDef

CreateGroupRequestTypeDef

# CreateGroupRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import CreateGroupRequestTypeDef


def get_value() -> CreateGroupRequestTypeDef:
    return {
        "GroupName": ...,
    }


# CreateGroupRequestTypeDef definition

class CreateGroupRequestTypeDef(TypedDict):
    GroupName: str,
    FilterExpression: NotRequired[str],
    InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)

1. See InsightsConfigurationTypeDef
2. See TagTypeDef

ListTagsForResourceResponseTypeDef

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See TagTypeDef
2. See ResponseMetadataTypeDef

TagResourceRequestTypeDef

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)

1. See TagTypeDef

EdgeStatisticsTypeDef

# EdgeStatisticsTypeDef TypedDict 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],

1. See ErrorStatisticsTypeDef
2. See FaultStatisticsTypeDef

ServiceStatisticsTypeDef

# ServiceStatisticsTypeDef TypedDict 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],

1. See ErrorStatisticsTypeDef
2. See FaultStatisticsTypeDef

GetEncryptionConfigResultTypeDef

# GetEncryptionConfigResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetEncryptionConfigResultTypeDef


def get_value() -> GetEncryptionConfigResultTypeDef:
    return {
        "EncryptionConfig": ...,
    }


# GetEncryptionConfigResultTypeDef definition

class GetEncryptionConfigResultTypeDef(TypedDict):
    EncryptionConfig: EncryptionConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EncryptionConfigTypeDef
2. See ResponseMetadataTypeDef

PutEncryptionConfigResultTypeDef

# PutEncryptionConfigResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import PutEncryptionConfigResultTypeDef


def get_value() -> PutEncryptionConfigResultTypeDef:
    return {
        "EncryptionConfig": ...,
    }


# PutEncryptionConfigResultTypeDef definition

class PutEncryptionConfigResultTypeDef(TypedDict):
    EncryptionConfig: EncryptionConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EncryptionConfigTypeDef
2. See ResponseMetadataTypeDef

ErrorRootCauseEntityTypeDef

# ErrorRootCauseEntityTypeDef TypedDict 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],

1. See RootCauseExceptionTypeDef

FaultRootCauseEntityTypeDef

# FaultRootCauseEntityTypeDef TypedDict 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],

1. See RootCauseExceptionTypeDef

GetInsightImpactGraphRequestTypeDef

# GetInsightImpactGraphRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetInsightImpactGraphRequestTypeDef


def get_value() -> GetInsightImpactGraphRequestTypeDef:
    return {
        "InsightId": ...,
    }


# GetInsightImpactGraphRequestTypeDef definition

class GetInsightImpactGraphRequestTypeDef(TypedDict):
    InsightId: str,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    NextToken: NotRequired[str],

GetInsightSummariesRequestTypeDef

# GetInsightSummariesRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetInsightSummariesRequestTypeDef


def get_value() -> GetInsightSummariesRequestTypeDef:
    return {
        "StartTime": ...,
    }


# GetInsightSummariesRequestTypeDef definition

class GetInsightSummariesRequestTypeDef(TypedDict):
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    States: NotRequired[Sequence[InsightStateType]],  # (1)
    GroupARN: NotRequired[str],
    GroupName: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

1. See InsightStateType

GetServiceGraphRequestPaginateTypeDef

# GetServiceGraphRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetServiceGraphRequestPaginateTypeDef


def get_value() -> GetServiceGraphRequestPaginateTypeDef:
    return {
        "StartTime": ...,
    }


# GetServiceGraphRequestPaginateTypeDef definition

class GetServiceGraphRequestPaginateTypeDef(TypedDict):
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GetServiceGraphRequestTypeDef

# GetServiceGraphRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetServiceGraphRequestTypeDef


def get_value() -> GetServiceGraphRequestTypeDef:
    return {
        "StartTime": ...,
    }


# GetServiceGraphRequestTypeDef definition

class GetServiceGraphRequestTypeDef(TypedDict):
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],
    NextToken: NotRequired[str],

GetTimeSeriesServiceStatisticsRequestPaginateTypeDef

# GetTimeSeriesServiceStatisticsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTimeSeriesServiceStatisticsRequestPaginateTypeDef


def get_value() -> GetTimeSeriesServiceStatisticsRequestPaginateTypeDef:
    return {
        "StartTime": ...,
    }


# 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)

1. See PaginatorConfigTypeDef

GetTimeSeriesServiceStatisticsRequestTypeDef

# GetTimeSeriesServiceStatisticsRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTimeSeriesServiceStatisticsRequestTypeDef


def get_value() -> GetTimeSeriesServiceStatisticsRequestTypeDef:
    return {
        "StartTime": ...,
    }


# GetTimeSeriesServiceStatisticsRequestTypeDef definition

class GetTimeSeriesServiceStatisticsRequestTypeDef(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 TypedDict usage example

from mypy_boto3_xray.type_defs import SamplingStatisticsDocumentTypeDef


def get_value() -> SamplingStatisticsDocumentTypeDef:
    return {
        "RuleName": ...,
    }


# SamplingStatisticsDocumentTypeDef definition

class SamplingStatisticsDocumentTypeDef(TypedDict):
    RuleName: str,
    ClientID: str,
    Timestamp: TimestampTypeDef,
    RequestCount: int,
    SampledCount: int,
    BorrowCount: NotRequired[int],

StartTraceRetrievalRequestTypeDef

# StartTraceRetrievalRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import StartTraceRetrievalRequestTypeDef


def get_value() -> StartTraceRetrievalRequestTypeDef:
    return {
        "TraceIds": ...,
    }


# StartTraceRetrievalRequestTypeDef definition

class StartTraceRetrievalRequestTypeDef(TypedDict):
    TraceIds: Sequence[str],
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,

TelemetryRecordTypeDef

# TelemetryRecordTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import TelemetryRecordTypeDef


def get_value() -> TelemetryRecordTypeDef:
    return {
        "Timestamp": ...,
    }


# TelemetryRecordTypeDef definition

class TelemetryRecordTypeDef(TypedDict):
    Timestamp: TimestampTypeDef,
    SegmentsReceivedCount: NotRequired[int],
    SegmentsSentCount: NotRequired[int],
    SegmentsSpilloverCount: NotRequired[int],
    SegmentsRejectedCount: NotRequired[int],
    BackendConnectionErrors: NotRequired[BackendConnectionErrorsTypeDef],  # (1)

1. See BackendConnectionErrorsTypeDef

GetSamplingStatisticSummariesResultTypeDef

# GetSamplingStatisticSummariesResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetSamplingStatisticSummariesResultTypeDef


def get_value() -> GetSamplingStatisticSummariesResultTypeDef:
    return {
        "SamplingStatisticSummaries": ...,
    }


# GetSamplingStatisticSummariesResultTypeDef definition

class GetSamplingStatisticSummariesResultTypeDef(TypedDict):
    SamplingStatisticSummaries: List[SamplingStatisticSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See SamplingStatisticSummaryTypeDef
2. See ResponseMetadataTypeDef

GetSamplingTargetsResultTypeDef

# GetSamplingTargetsResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetSamplingTargetsResultTypeDef


def get_value() -> GetSamplingTargetsResultTypeDef:
    return {
        "SamplingTargetDocuments": ...,
    }


# GetSamplingTargetsResultTypeDef definition

class GetSamplingTargetsResultTypeDef(TypedDict):
    SamplingTargetDocuments: List[SamplingTargetDocumentTypeDef],  # (1)
    LastRuleModification: datetime,
    UnprocessedStatistics: List[UnprocessedStatisticsTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See SamplingTargetDocumentTypeDef
2. See UnprocessedStatisticsTypeDef
3. See ResponseMetadataTypeDef

GetTraceSummariesRequestPaginateTypeDef

# GetTraceSummariesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTraceSummariesRequestPaginateTypeDef


def get_value() -> GetTraceSummariesRequestPaginateTypeDef:
    return {
        "StartTime": ...,
    }


# 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)

1. See TimeRangeTypeType
2. See SamplingStrategyTypeDef
3. See PaginatorConfigTypeDef

GetTraceSummariesRequestTypeDef

# GetTraceSummariesRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTraceSummariesRequestTypeDef


def get_value() -> GetTraceSummariesRequestTypeDef:
    return {
        "StartTime": ...,
    }


# GetTraceSummariesRequestTypeDef definition

class GetTraceSummariesRequestTypeDef(TypedDict):
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    TimeRangeType: NotRequired[TimeRangeTypeType],  # (1)
    Sampling: NotRequired[bool],
    SamplingStrategy: NotRequired[SamplingStrategyTypeDef],  # (2)
    FilterExpression: NotRequired[str],
    NextToken: NotRequired[str],

1. See TimeRangeTypeType
2. See SamplingStrategyTypeDef

IndexingRuleValueTypeDef

# IndexingRuleValueTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import IndexingRuleValueTypeDef


def get_value() -> IndexingRuleValueTypeDef:
    return {
        "Probabilistic": ...,
    }


# IndexingRuleValueTypeDef definition

class IndexingRuleValueTypeDef(TypedDict):
    Probabilistic: NotRequired[ProbabilisticRuleValueTypeDef],  # (1)

1. See ProbabilisticRuleValueTypeDef

IndexingRuleValueUpdateTypeDef

# IndexingRuleValueUpdateTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import IndexingRuleValueUpdateTypeDef


def get_value() -> IndexingRuleValueUpdateTypeDef:
    return {
        "Probabilistic": ...,
    }


# IndexingRuleValueUpdateTypeDef definition

class IndexingRuleValueUpdateTypeDef(TypedDict):
    Probabilistic: NotRequired[ProbabilisticRuleValueUpdateTypeDef],  # (1)

1. See ProbabilisticRuleValueUpdateTypeDef

InsightImpactGraphServiceTypeDef

# InsightImpactGraphServiceTypeDef TypedDict 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)

1. See InsightImpactGraphEdgeTypeDef

ListResourcePoliciesResultTypeDef

# ListResourcePoliciesResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ListResourcePoliciesResultTypeDef


def get_value() -> ListResourcePoliciesResultTypeDef:
    return {
        "ResourcePolicies": ...,
    }


# ListResourcePoliciesResultTypeDef definition

class ListResourcePoliciesResultTypeDef(TypedDict):
    ResourcePolicies: List[ResourcePolicyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See ResourcePolicyTypeDef
2. See ResponseMetadataTypeDef

PutResourcePolicyResultTypeDef

# PutResourcePolicyResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import PutResourcePolicyResultTypeDef


def get_value() -> PutResourcePolicyResultTypeDef:
    return {
        "ResourcePolicy": ...,
    }


# PutResourcePolicyResultTypeDef definition

class PutResourcePolicyResultTypeDef(TypedDict):
    ResourcePolicy: ResourcePolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ResourcePolicyTypeDef
2. See ResponseMetadataTypeDef

PutTraceSegmentsResultTypeDef

# PutTraceSegmentsResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import PutTraceSegmentsResultTypeDef


def get_value() -> PutTraceSegmentsResultTypeDef:
    return {
        "UnprocessedTraceSegments": ...,
    }


# PutTraceSegmentsResultTypeDef definition

class PutTraceSegmentsResultTypeDef(TypedDict):
    UnprocessedTraceSegments: List[UnprocessedTraceSegmentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UnprocessedTraceSegmentTypeDef
2. See ResponseMetadataTypeDef

ResponseTimeRootCauseServiceTypeDef

# ResponseTimeRootCauseServiceTypeDef TypedDict 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],

1. See ResponseTimeRootCauseEntityTypeDef

RetrievedTraceTypeDef

# RetrievedTraceTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import RetrievedTraceTypeDef


def get_value() -> RetrievedTraceTypeDef:
    return {
        "Id": ...,
    }


# RetrievedTraceTypeDef definition

class RetrievedTraceTypeDef(TypedDict):
    Id: NotRequired[str],
    Duration: NotRequired[float],
    Spans: NotRequired[List[SpanTypeDef]],  # (1)

1. See SpanTypeDef

SamplingRuleRecordTypeDef

# SamplingRuleRecordTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import SamplingRuleRecordTypeDef


def get_value() -> SamplingRuleRecordTypeDef:
    return {
        "SamplingRule": ...,
    }


# SamplingRuleRecordTypeDef definition

class SamplingRuleRecordTypeDef(TypedDict):
    SamplingRule: NotRequired[SamplingRuleOutputTypeDef],  # (1)
    CreatedAt: NotRequired[datetime],
    ModifiedAt: NotRequired[datetime],

1. See SamplingRuleOutputTypeDef

UpdateSamplingRuleRequestTypeDef

# UpdateSamplingRuleRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import UpdateSamplingRuleRequestTypeDef


def get_value() -> UpdateSamplingRuleRequestTypeDef:
    return {
        "SamplingRuleUpdate": ...,
    }


# UpdateSamplingRuleRequestTypeDef definition

class UpdateSamplingRuleRequestTypeDef(TypedDict):
    SamplingRuleUpdate: SamplingRuleUpdateTypeDef,  # (1)

1. See SamplingRuleUpdateTypeDef

TraceTypeDef

# TraceTypeDef TypedDict 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)

1. See SegmentTypeDef

InsightEventTypeDef

# InsightEventTypeDef TypedDict 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)

1. See RequestImpactStatisticsTypeDef
2. See RequestImpactStatisticsTypeDef
3. See AnomalousServiceTypeDef

InsightSummaryTypeDef

# InsightSummaryTypeDef TypedDict 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],

1. See ServiceIdTypeDef
2. See InsightCategoryType
3. See InsightStateType
4. See RequestImpactStatisticsTypeDef
5. See RequestImpactStatisticsTypeDef
6. See AnomalousServiceTypeDef

InsightTypeDef

# InsightTypeDef TypedDict 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)

1. See ServiceIdTypeDef
2. See InsightCategoryType
3. See InsightStateType
4. See RequestImpactStatisticsTypeDef
5. See RequestImpactStatisticsTypeDef
6. See AnomalousServiceTypeDef

GetGroupsResultTypeDef

# GetGroupsResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetGroupsResultTypeDef


def get_value() -> GetGroupsResultTypeDef:
    return {
        "Groups": ...,
    }


# GetGroupsResultTypeDef definition

class GetGroupsResultTypeDef(TypedDict):
    Groups: List[GroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See GroupSummaryTypeDef
2. See ResponseMetadataTypeDef

CreateGroupResultTypeDef

# CreateGroupResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import CreateGroupResultTypeDef


def get_value() -> CreateGroupResultTypeDef:
    return {
        "Group": ...,
    }


# CreateGroupResultTypeDef definition

class CreateGroupResultTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GroupTypeDef
2. See ResponseMetadataTypeDef

GetGroupResultTypeDef

# GetGroupResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetGroupResultTypeDef


def get_value() -> GetGroupResultTypeDef:
    return {
        "Group": ...,
    }


# GetGroupResultTypeDef definition

class GetGroupResultTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GroupTypeDef
2. See ResponseMetadataTypeDef

UpdateGroupResultTypeDef

# UpdateGroupResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import UpdateGroupResultTypeDef


def get_value() -> UpdateGroupResultTypeDef:
    return {
        "Group": ...,
    }


# UpdateGroupResultTypeDef definition

class UpdateGroupResultTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GroupTypeDef
2. See ResponseMetadataTypeDef

EdgeTypeDef

# EdgeTypeDef TypedDict 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)

1. See EdgeStatisticsTypeDef
2. See HistogramEntryTypeDef
3. See AliasTypeDef
4. See HistogramEntryTypeDef

TimeSeriesServiceStatisticsTypeDef

# TimeSeriesServiceStatisticsTypeDef TypedDict 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)

1. See EdgeStatisticsTypeDef
2. See ServiceStatisticsTypeDef
3. See ForecastStatisticsTypeDef
4. See HistogramEntryTypeDef

ErrorRootCauseServiceTypeDef

# ErrorRootCauseServiceTypeDef TypedDict 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],

1. See ErrorRootCauseEntityTypeDef

FaultRootCauseServiceTypeDef

# FaultRootCauseServiceTypeDef TypedDict 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],

1. See FaultRootCauseEntityTypeDef

GetSamplingTargetsRequestTypeDef

# GetSamplingTargetsRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetSamplingTargetsRequestTypeDef


def get_value() -> GetSamplingTargetsRequestTypeDef:
    return {
        "SamplingStatisticsDocuments": ...,
    }


# GetSamplingTargetsRequestTypeDef definition

class GetSamplingTargetsRequestTypeDef(TypedDict):
    SamplingStatisticsDocuments: Sequence[SamplingStatisticsDocumentTypeDef],  # (1)

1. See SamplingStatisticsDocumentTypeDef

PutTelemetryRecordsRequestTypeDef

# PutTelemetryRecordsRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import PutTelemetryRecordsRequestTypeDef


def get_value() -> PutTelemetryRecordsRequestTypeDef:
    return {
        "TelemetryRecords": ...,
    }


# PutTelemetryRecordsRequestTypeDef definition

class PutTelemetryRecordsRequestTypeDef(TypedDict):
    TelemetryRecords: Sequence[TelemetryRecordTypeDef],  # (1)
    EC2InstanceId: NotRequired[str],
    Hostname: NotRequired[str],
    ResourceARN: NotRequired[str],

1. See TelemetryRecordTypeDef

IndexingRuleTypeDef

# IndexingRuleTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import IndexingRuleTypeDef


def get_value() -> IndexingRuleTypeDef:
    return {
        "Name": ...,
    }


# IndexingRuleTypeDef definition

class IndexingRuleTypeDef(TypedDict):
    Name: NotRequired[str],
    ModifiedAt: NotRequired[datetime],
    Rule: NotRequired[IndexingRuleValueTypeDef],  # (1)

1. See IndexingRuleValueTypeDef

UpdateIndexingRuleRequestTypeDef

# UpdateIndexingRuleRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import UpdateIndexingRuleRequestTypeDef


def get_value() -> UpdateIndexingRuleRequestTypeDef:
    return {
        "Name": ...,
    }


# UpdateIndexingRuleRequestTypeDef definition

class UpdateIndexingRuleRequestTypeDef(TypedDict):
    Name: str,
    Rule: IndexingRuleValueUpdateTypeDef,  # (1)

1. See IndexingRuleValueUpdateTypeDef

GetInsightImpactGraphResultTypeDef

# GetInsightImpactGraphResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetInsightImpactGraphResultTypeDef


def get_value() -> GetInsightImpactGraphResultTypeDef:
    return {
        "InsightId": ...,
    }


# 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],

1. See InsightImpactGraphServiceTypeDef
2. See ResponseMetadataTypeDef

ResponseTimeRootCauseTypeDef

# ResponseTimeRootCauseTypeDef TypedDict 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],

1. See ResponseTimeRootCauseServiceTypeDef

ListRetrievedTracesResultTypeDef

# ListRetrievedTracesResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import ListRetrievedTracesResultTypeDef


def get_value() -> ListRetrievedTracesResultTypeDef:
    return {
        "RetrievalStatus": ...,
    }


# ListRetrievedTracesResultTypeDef definition

class ListRetrievedTracesResultTypeDef(TypedDict):
    RetrievalStatus: RetrievalStatusType,  # (1)
    TraceFormat: TraceFormatTypeType,  # (2)
    Traces: List[RetrievedTraceTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
    NextToken: NotRequired[str],

1. See RetrievalStatusType
2. See TraceFormatTypeType
3. See RetrievedTraceTypeDef
4. See ResponseMetadataTypeDef

CreateSamplingRuleResultTypeDef

# CreateSamplingRuleResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import CreateSamplingRuleResultTypeDef


def get_value() -> CreateSamplingRuleResultTypeDef:
    return {
        "SamplingRuleRecord": ...,
    }


# CreateSamplingRuleResultTypeDef definition

class CreateSamplingRuleResultTypeDef(TypedDict):
    SamplingRuleRecord: SamplingRuleRecordTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SamplingRuleRecordTypeDef
2. See ResponseMetadataTypeDef

DeleteSamplingRuleResultTypeDef

# DeleteSamplingRuleResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import DeleteSamplingRuleResultTypeDef


def get_value() -> DeleteSamplingRuleResultTypeDef:
    return {
        "SamplingRuleRecord": ...,
    }


# DeleteSamplingRuleResultTypeDef definition

class DeleteSamplingRuleResultTypeDef(TypedDict):
    SamplingRuleRecord: SamplingRuleRecordTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SamplingRuleRecordTypeDef
2. See ResponseMetadataTypeDef

GetSamplingRulesResultTypeDef

# GetSamplingRulesResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetSamplingRulesResultTypeDef


def get_value() -> GetSamplingRulesResultTypeDef:
    return {
        "SamplingRuleRecords": ...,
    }


# GetSamplingRulesResultTypeDef definition

class GetSamplingRulesResultTypeDef(TypedDict):
    SamplingRuleRecords: List[SamplingRuleRecordTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See SamplingRuleRecordTypeDef
2. See ResponseMetadataTypeDef

UpdateSamplingRuleResultTypeDef

# UpdateSamplingRuleResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import UpdateSamplingRuleResultTypeDef


def get_value() -> UpdateSamplingRuleResultTypeDef:
    return {
        "SamplingRuleRecord": ...,
    }


# UpdateSamplingRuleResultTypeDef definition

class UpdateSamplingRuleResultTypeDef(TypedDict):
    SamplingRuleRecord: SamplingRuleRecordTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SamplingRuleRecordTypeDef
2. See ResponseMetadataTypeDef

CreateSamplingRuleRequestTypeDef

# CreateSamplingRuleRequestTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import CreateSamplingRuleRequestTypeDef


def get_value() -> CreateSamplingRuleRequestTypeDef:
    return {
        "SamplingRule": ...,
    }


# CreateSamplingRuleRequestTypeDef definition

class CreateSamplingRuleRequestTypeDef(TypedDict):
    SamplingRule: SamplingRuleUnionTypeDef,  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)

1. See SamplingRuleTypeDef SamplingRuleOutputTypeDef
2. See TagTypeDef

BatchGetTracesResultTypeDef

# BatchGetTracesResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import BatchGetTracesResultTypeDef


def get_value() -> BatchGetTracesResultTypeDef:
    return {
        "Traces": ...,
    }


# BatchGetTracesResultTypeDef definition

class BatchGetTracesResultTypeDef(TypedDict):
    Traces: List[TraceTypeDef],  # (1)
    UnprocessedTraceIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See TraceTypeDef
2. See ResponseMetadataTypeDef

GetInsightEventsResultTypeDef

# GetInsightEventsResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetInsightEventsResultTypeDef


def get_value() -> GetInsightEventsResultTypeDef:
    return {
        "InsightEvents": ...,
    }


# GetInsightEventsResultTypeDef definition

class GetInsightEventsResultTypeDef(TypedDict):
    InsightEvents: List[InsightEventTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See InsightEventTypeDef
2. See ResponseMetadataTypeDef

GetInsightSummariesResultTypeDef

# GetInsightSummariesResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetInsightSummariesResultTypeDef


def get_value() -> GetInsightSummariesResultTypeDef:
    return {
        "InsightSummaries": ...,
    }


# GetInsightSummariesResultTypeDef definition

class GetInsightSummariesResultTypeDef(TypedDict):
    InsightSummaries: List[InsightSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See InsightSummaryTypeDef
2. See ResponseMetadataTypeDef

GetInsightResultTypeDef

# GetInsightResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetInsightResultTypeDef


def get_value() -> GetInsightResultTypeDef:
    return {
        "Insight": ...,
    }


# GetInsightResultTypeDef definition

class GetInsightResultTypeDef(TypedDict):
    Insight: InsightTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See InsightTypeDef
2. See ResponseMetadataTypeDef

ServiceTypeDef

# ServiceTypeDef TypedDict 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)

1. See EdgeTypeDef
2. See ServiceStatisticsTypeDef
3. See HistogramEntryTypeDef
4. See HistogramEntryTypeDef

GetTimeSeriesServiceStatisticsResultTypeDef

# GetTimeSeriesServiceStatisticsResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTimeSeriesServiceStatisticsResultTypeDef


def get_value() -> GetTimeSeriesServiceStatisticsResultTypeDef:
    return {
        "TimeSeriesServiceStatistics": ...,
    }


# GetTimeSeriesServiceStatisticsResultTypeDef definition

class GetTimeSeriesServiceStatisticsResultTypeDef(TypedDict):
    TimeSeriesServiceStatistics: List[TimeSeriesServiceStatisticsTypeDef],  # (1)
    ContainsOldGroupVersions: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See TimeSeriesServiceStatisticsTypeDef
2. See ResponseMetadataTypeDef

ErrorRootCauseTypeDef

# ErrorRootCauseTypeDef TypedDict 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],

1. See ErrorRootCauseServiceTypeDef

FaultRootCauseTypeDef

# FaultRootCauseTypeDef TypedDict 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],

1. See FaultRootCauseServiceTypeDef

GetIndexingRulesResultTypeDef

# GetIndexingRulesResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetIndexingRulesResultTypeDef


def get_value() -> GetIndexingRulesResultTypeDef:
    return {
        "IndexingRules": ...,
    }


# GetIndexingRulesResultTypeDef definition

class GetIndexingRulesResultTypeDef(TypedDict):
    IndexingRules: List[IndexingRuleTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See IndexingRuleTypeDef
2. See ResponseMetadataTypeDef

UpdateIndexingRuleResultTypeDef

# UpdateIndexingRuleResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import UpdateIndexingRuleResultTypeDef


def get_value() -> UpdateIndexingRuleResultTypeDef:
    return {
        "IndexingRule": ...,
    }


# UpdateIndexingRuleResultTypeDef definition

class UpdateIndexingRuleResultTypeDef(TypedDict):
    IndexingRule: IndexingRuleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IndexingRuleTypeDef
2. See ResponseMetadataTypeDef

GetServiceGraphResultTypeDef

# GetServiceGraphResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetServiceGraphResultTypeDef


def get_value() -> GetServiceGraphResultTypeDef:
    return {
        "StartTime": ...,
    }


# GetServiceGraphResultTypeDef definition

class GetServiceGraphResultTypeDef(TypedDict):
    StartTime: datetime,
    EndTime: datetime,
    Services: List[ServiceTypeDef],  # (1)
    ContainsOldGroupVersions: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See ServiceTypeDef
2. See ResponseMetadataTypeDef

GetTraceGraphResultTypeDef

# GetTraceGraphResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTraceGraphResultTypeDef


def get_value() -> GetTraceGraphResultTypeDef:
    return {
        "Services": ...,
    }


# GetTraceGraphResultTypeDef definition

class GetTraceGraphResultTypeDef(TypedDict):
    Services: List[ServiceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See ServiceTypeDef
2. See ResponseMetadataTypeDef

RetrievedServiceTypeDef

# RetrievedServiceTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import RetrievedServiceTypeDef


def get_value() -> RetrievedServiceTypeDef:
    return {
        "Service": ...,
    }


# RetrievedServiceTypeDef definition

class RetrievedServiceTypeDef(TypedDict):
    Service: NotRequired[ServiceTypeDef],  # (1)
    Links: NotRequired[List[GraphLinkTypeDef]],  # (2)

1. See ServiceTypeDef
2. See GraphLinkTypeDef

TraceSummaryTypeDef

# TraceSummaryTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import TraceSummaryTypeDef


def get_value() -> TraceSummaryTypeDef:
    return {
        "Id": ...,
    }


# 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],

1. See HttpTypeDef
2. See ValueWithServiceIdsTypeDef
3. See TraceUserTypeDef
4. See ServiceIdTypeDef
5. See ResourceARNDetailTypeDef
6. See InstanceIdDetailTypeDef
7. See AvailabilityZoneDetailTypeDef
8. See ServiceIdTypeDef
9. See FaultRootCauseTypeDef
10. See ErrorRootCauseTypeDef
11. See ResponseTimeRootCauseTypeDef

GetRetrievedTracesGraphResultTypeDef

# GetRetrievedTracesGraphResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetRetrievedTracesGraphResultTypeDef


def get_value() -> GetRetrievedTracesGraphResultTypeDef:
    return {
        "RetrievalStatus": ...,
    }


# GetRetrievedTracesGraphResultTypeDef definition

class GetRetrievedTracesGraphResultTypeDef(TypedDict):
    RetrievalStatus: RetrievalStatusType,  # (1)
    Services: List[RetrievedServiceTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    NextToken: NotRequired[str],

1. See RetrievalStatusType
2. See RetrievedServiceTypeDef
3. See ResponseMetadataTypeDef

GetTraceSummariesResultTypeDef

# GetTraceSummariesResultTypeDef TypedDict usage example

from mypy_boto3_xray.type_defs import GetTraceSummariesResultTypeDef


def get_value() -> GetTraceSummariesResultTypeDef:
    return {
        "TraceSummaries": ...,
    }


# GetTraceSummariesResultTypeDef definition

class GetTraceSummariesResultTypeDef(TypedDict):
    TraceSummaries: List[TraceSummaryTypeDef],  # (1)
    ApproximateTime: datetime,
    TracesProcessedCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See TraceSummaryTypeDef
2. See ResponseMetadataTypeDef