Skip to content

Typed dictionaries

Index > XRay > Typed dictionaries

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

AliasTypeDef

Usage Example
from mypy_boto3_xray.type_defs import AliasTypeDef

def get_value() -> AliasTypeDef:
    return {
        "Name": ...,
    }
Definition
class AliasTypeDef(TypedDict):
    Name: NotRequired[str],
    Names: NotRequired[List[str]],
    Type: NotRequired[str],

AnnotationValueTypeDef

Usage Example
from mypy_boto3_xray.type_defs import AnnotationValueTypeDef

def get_value() -> AnnotationValueTypeDef:
    return {
        "NumberValue": ...,
    }
Definition
class AnnotationValueTypeDef(TypedDict):
    NumberValue: NotRequired[float],
    BooleanValue: NotRequired[bool],
    StringValue: NotRequired[str],

ServiceIdTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ServiceIdTypeDef

def get_value() -> ServiceIdTypeDef:
    return {
        "Name": ...,
    }
Definition
class ServiceIdTypeDef(TypedDict):
    Name: NotRequired[str],
    Names: NotRequired[List[str]],
    AccountId: NotRequired[str],
    Type: NotRequired[str],

AvailabilityZoneDetailTypeDef

Usage Example
from mypy_boto3_xray.type_defs import AvailabilityZoneDetailTypeDef

def get_value() -> AvailabilityZoneDetailTypeDef:
    return {
        "Name": ...,
    }
Definition
class AvailabilityZoneDetailTypeDef(TypedDict):
    Name: NotRequired[str],

BackendConnectionErrorsTypeDef

Usage Example
from mypy_boto3_xray.type_defs import BackendConnectionErrorsTypeDef

def get_value() -> BackendConnectionErrorsTypeDef:
    return {
        "TimeoutCount": ...,
    }
Definition
class BackendConnectionErrorsTypeDef(TypedDict):
    TimeoutCount: NotRequired[int],
    ConnectionRefusedCount: NotRequired[int],
    HTTPCode4XXCount: NotRequired[int],
    HTTPCode5XXCount: NotRequired[int],
    UnknownHostCount: NotRequired[int],
    OtherCount: NotRequired[int],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_xray.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

BatchGetTracesRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import BatchGetTracesRequestRequestTypeDef

def get_value() -> BatchGetTracesRequestRequestTypeDef:
    return {
        "TraceIds": ...,
    }
Definition
class BatchGetTracesRequestRequestTypeDef(TypedDict):
    TraceIds: Sequence[str],
    NextToken: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

InsightsConfigurationTypeDef

Usage Example
from mypy_boto3_xray.type_defs import InsightsConfigurationTypeDef

def get_value() -> InsightsConfigurationTypeDef:
    return {
        "InsightsEnabled": ...,
    }
Definition
class InsightsConfigurationTypeDef(TypedDict):
    InsightsEnabled: NotRequired[bool],
    NotificationsEnabled: NotRequired[bool],

TagTypeDef

Usage Example
from mypy_boto3_xray.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

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": ...,
    }
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

Usage Example
from mypy_boto3_xray.type_defs import DeleteGroupRequestRequestTypeDef

def get_value() -> DeleteGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
    }
Definition
class DeleteGroupRequestRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],

DeleteResourcePolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import DeleteResourcePolicyRequestRequestTypeDef

def get_value() -> DeleteResourcePolicyRequestRequestTypeDef:
    return {
        "PolicyName": ...,
    }
Definition
class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    PolicyName: str,
    PolicyRevisionId: NotRequired[str],

DeleteSamplingRuleRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import DeleteSamplingRuleRequestRequestTypeDef

def get_value() -> DeleteSamplingRuleRequestRequestTypeDef:
    return {
        "RuleName": ...,
    }
Definition
class DeleteSamplingRuleRequestRequestTypeDef(TypedDict):
    RuleName: NotRequired[str],
    RuleARN: NotRequired[str],

ErrorStatisticsTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ErrorStatisticsTypeDef

def get_value() -> ErrorStatisticsTypeDef:
    return {
        "ThrottleCount": ...,
    }
Definition
class ErrorStatisticsTypeDef(TypedDict):
    ThrottleCount: NotRequired[int],
    OtherCount: NotRequired[int],
    TotalCount: NotRequired[int],

FaultStatisticsTypeDef

Usage Example
from mypy_boto3_xray.type_defs import FaultStatisticsTypeDef

def get_value() -> FaultStatisticsTypeDef:
    return {
        "OtherCount": ...,
    }
Definition
class FaultStatisticsTypeDef(TypedDict):
    OtherCount: NotRequired[int],
    TotalCount: NotRequired[int],

HistogramEntryTypeDef

Usage Example
from mypy_boto3_xray.type_defs import HistogramEntryTypeDef

def get_value() -> HistogramEntryTypeDef:
    return {
        "Value": ...,
    }
Definition
class HistogramEntryTypeDef(TypedDict):
    Value: NotRequired[float],
    Count: NotRequired[int],

EncryptionConfigTypeDef

Usage Example
from mypy_boto3_xray.type_defs import EncryptionConfigTypeDef

def get_value() -> EncryptionConfigTypeDef:
    return {
        "KeyId": ...,
    }
Definition
class EncryptionConfigTypeDef(TypedDict):
    KeyId: NotRequired[str],
    Status: NotRequired[EncryptionStatusType],  # (1)
    Type: NotRequired[EncryptionTypeType],  # (2)
  1. See EncryptionStatusType
  2. See EncryptionTypeType

RootCauseExceptionTypeDef

Usage Example
from mypy_boto3_xray.type_defs import RootCauseExceptionTypeDef

def get_value() -> RootCauseExceptionTypeDef:
    return {
        "Name": ...,
    }
Definition
class RootCauseExceptionTypeDef(TypedDict):
    Name: NotRequired[str],
    Message: NotRequired[str],

ForecastStatisticsTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ForecastStatisticsTypeDef

def get_value() -> ForecastStatisticsTypeDef:
    return {
        "FaultCountHigh": ...,
    }
Definition
class ForecastStatisticsTypeDef(TypedDict):
    FaultCountHigh: NotRequired[int],
    FaultCountLow: NotRequired[int],

GetGroupRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetGroupRequestRequestTypeDef

def get_value() -> GetGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
    }
Definition
class GetGroupRequestRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],

GetGroupsRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetGroupsRequestRequestTypeDef

def get_value() -> GetGroupsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class GetGroupsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

GetInsightEventsRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetInsightEventsRequestRequestTypeDef

def get_value() -> GetInsightEventsRequestRequestTypeDef:
    return {
        "InsightId": ...,
    }
Definition
class GetInsightEventsRequestRequestTypeDef(TypedDict):
    InsightId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetInsightImpactGraphRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetInsightImpactGraphRequestRequestTypeDef

def get_value() -> GetInsightImpactGraphRequestRequestTypeDef:
    return {
        "InsightId": ...,
        "StartTime": ...,
        "EndTime": ...,
    }
Definition
class GetInsightImpactGraphRequestRequestTypeDef(TypedDict):
    InsightId: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    NextToken: NotRequired[str],

GetInsightRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetInsightRequestRequestTypeDef

def get_value() -> GetInsightRequestRequestTypeDef:
    return {
        "InsightId": ...,
    }
Definition
class GetInsightRequestRequestTypeDef(TypedDict):
    InsightId: str,

GetInsightSummariesRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetInsightSummariesRequestRequestTypeDef

def get_value() -> GetInsightSummariesRequestRequestTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
    }
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],
  1. See InsightStateType

GetSamplingRulesRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetSamplingRulesRequestRequestTypeDef

def get_value() -> GetSamplingRulesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class GetSamplingRulesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

GetSamplingStatisticSummariesRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetSamplingStatisticSummariesRequestRequestTypeDef

def get_value() -> GetSamplingStatisticSummariesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class GetSamplingStatisticSummariesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

SamplingStatisticSummaryTypeDef

Usage Example
from mypy_boto3_xray.type_defs import SamplingStatisticSummaryTypeDef

def get_value() -> SamplingStatisticSummaryTypeDef:
    return {
        "RuleName": ...,
    }
Definition
class SamplingStatisticSummaryTypeDef(TypedDict):
    RuleName: NotRequired[str],
    Timestamp: NotRequired[datetime],
    RequestCount: NotRequired[int],
    BorrowCount: NotRequired[int],
    SampledCount: NotRequired[int],

SamplingStatisticsDocumentTypeDef

Usage Example
from mypy_boto3_xray.type_defs import SamplingStatisticsDocumentTypeDef

def get_value() -> SamplingStatisticsDocumentTypeDef:
    return {
        "RuleName": ...,
        "ClientID": ...,
        "Timestamp": ...,
        "RequestCount": ...,
        "SampledCount": ...,
    }
Definition
class SamplingStatisticsDocumentTypeDef(TypedDict):
    RuleName: str,
    ClientID: str,
    Timestamp: Union[datetime, str],
    RequestCount: int,
    SampledCount: int,
    BorrowCount: NotRequired[int],

SamplingTargetDocumentTypeDef

Usage Example
from mypy_boto3_xray.type_defs import SamplingTargetDocumentTypeDef

def get_value() -> SamplingTargetDocumentTypeDef:
    return {
        "RuleName": ...,
    }
Definition
class SamplingTargetDocumentTypeDef(TypedDict):
    RuleName: NotRequired[str],
    FixedRate: NotRequired[float],
    ReservoirQuota: NotRequired[int],
    ReservoirQuotaTTL: NotRequired[datetime],
    Interval: NotRequired[int],

UnprocessedStatisticsTypeDef

Usage Example
from mypy_boto3_xray.type_defs import UnprocessedStatisticsTypeDef

def get_value() -> UnprocessedStatisticsTypeDef:
    return {
        "RuleName": ...,
    }
Definition
class UnprocessedStatisticsTypeDef(TypedDict):
    RuleName: NotRequired[str],
    ErrorCode: NotRequired[str],
    Message: NotRequired[str],

GetServiceGraphRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetServiceGraphRequestRequestTypeDef

def get_value() -> GetServiceGraphRequestRequestTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
    }
Definition
class GetServiceGraphRequestRequestTypeDef(TypedDict):
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],
    NextToken: NotRequired[str],

GetTimeSeriesServiceStatisticsRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetTimeSeriesServiceStatisticsRequestRequestTypeDef

def get_value() -> GetTimeSeriesServiceStatisticsRequestRequestTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
    }
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],

GetTraceGraphRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetTraceGraphRequestRequestTypeDef

def get_value() -> GetTraceGraphRequestRequestTypeDef:
    return {
        "TraceIds": ...,
    }
Definition
class GetTraceGraphRequestRequestTypeDef(TypedDict):
    TraceIds: Sequence[str],
    NextToken: NotRequired[str],

SamplingStrategyTypeDef

Usage Example
from mypy_boto3_xray.type_defs import SamplingStrategyTypeDef

def get_value() -> SamplingStrategyTypeDef:
    return {
        "Name": ...,
    }
Definition
class SamplingStrategyTypeDef(TypedDict):
    Name: NotRequired[SamplingStrategyNameType],  # (1)
    Value: NotRequired[float],
  1. See SamplingStrategyNameType

HttpTypeDef

Usage Example
from mypy_boto3_xray.type_defs import HttpTypeDef

def get_value() -> HttpTypeDef:
    return {
        "HttpURL": ...,
    }
Definition
class HttpTypeDef(TypedDict):
    HttpURL: NotRequired[str],
    HttpStatus: NotRequired[int],
    HttpMethod: NotRequired[str],
    UserAgent: NotRequired[str],
    ClientIp: NotRequired[str],

RequestImpactStatisticsTypeDef

Usage Example
from mypy_boto3_xray.type_defs import RequestImpactStatisticsTypeDef

def get_value() -> RequestImpactStatisticsTypeDef:
    return {
        "FaultCount": ...,
    }
Definition
class RequestImpactStatisticsTypeDef(TypedDict):
    FaultCount: NotRequired[int],
    OkCount: NotRequired[int],
    TotalCount: NotRequired[int],

InsightImpactGraphEdgeTypeDef

Usage Example
from mypy_boto3_xray.type_defs import InsightImpactGraphEdgeTypeDef

def get_value() -> InsightImpactGraphEdgeTypeDef:
    return {
        "ReferenceId": ...,
    }
Definition
class InsightImpactGraphEdgeTypeDef(TypedDict):
    ReferenceId: NotRequired[int],

InstanceIdDetailTypeDef

Usage Example
from mypy_boto3_xray.type_defs import InstanceIdDetailTypeDef

def get_value() -> InstanceIdDetailTypeDef:
    return {
        "Id": ...,
    }
Definition
class InstanceIdDetailTypeDef(TypedDict):
    Id: NotRequired[str],

ListResourcePoliciesRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ListResourcePoliciesRequestRequestTypeDef

def get_value() -> ListResourcePoliciesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class ListResourcePoliciesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

ResourcePolicyTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ResourcePolicyTypeDef

def get_value() -> ResourcePolicyTypeDef:
    return {
        "PolicyName": ...,
    }
Definition
class ResourcePolicyTypeDef(TypedDict):
    PolicyName: NotRequired[str],
    PolicyDocument: NotRequired[str],
    PolicyRevisionId: NotRequired[str],
    LastUpdatedTime: NotRequired[datetime],

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    NextToken: NotRequired[str],

PutEncryptionConfigRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import PutEncryptionConfigRequestRequestTypeDef

def get_value() -> PutEncryptionConfigRequestRequestTypeDef:
    return {
        "Type": ...,
    }
Definition
class PutEncryptionConfigRequestRequestTypeDef(TypedDict):
    Type: EncryptionTypeType,  # (1)
    KeyId: NotRequired[str],
  1. See EncryptionTypeType

PutResourcePolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import PutResourcePolicyRequestRequestTypeDef

def get_value() -> PutResourcePolicyRequestRequestTypeDef:
    return {
        "PolicyName": ...,
        "PolicyDocument": ...,
    }
Definition
class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    PolicyName: str,
    PolicyDocument: str,
    PolicyRevisionId: NotRequired[str],
    BypassPolicyLockoutCheck: NotRequired[bool],

PutTraceSegmentsRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import PutTraceSegmentsRequestRequestTypeDef

def get_value() -> PutTraceSegmentsRequestRequestTypeDef:
    return {
        "TraceSegmentDocuments": ...,
    }
Definition
class PutTraceSegmentsRequestRequestTypeDef(TypedDict):
    TraceSegmentDocuments: Sequence[str],

UnprocessedTraceSegmentTypeDef

Usage Example
from mypy_boto3_xray.type_defs import UnprocessedTraceSegmentTypeDef

def get_value() -> UnprocessedTraceSegmentTypeDef:
    return {
        "Id": ...,
    }
Definition
class UnprocessedTraceSegmentTypeDef(TypedDict):
    Id: NotRequired[str],
    ErrorCode: NotRequired[str],
    Message: NotRequired[str],

ResourceARNDetailTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ResourceARNDetailTypeDef

def get_value() -> ResourceARNDetailTypeDef:
    return {
        "ARN": ...,
    }
Definition
class ResourceARNDetailTypeDef(TypedDict):
    ARN: NotRequired[str],

ResponseTimeRootCauseEntityTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ResponseTimeRootCauseEntityTypeDef

def get_value() -> ResponseTimeRootCauseEntityTypeDef:
    return {
        "Name": ...,
    }
Definition
class ResponseTimeRootCauseEntityTypeDef(TypedDict):
    Name: NotRequired[str],
    Coverage: NotRequired[float],
    Remote: NotRequired[bool],

SamplingRuleUpdateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import SamplingRuleUpdateTypeDef

def get_value() -> SamplingRuleUpdateTypeDef:
    return {
        "RuleName": ...,
    }
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

Usage Example
from mypy_boto3_xray.type_defs import SegmentTypeDef

def get_value() -> SegmentTypeDef:
    return {
        "Id": ...,
    }
Definition
class SegmentTypeDef(TypedDict):
    Id: NotRequired[str],
    Document: NotRequired[str],

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

AnomalousServiceTypeDef

Usage Example
from mypy_boto3_xray.type_defs import AnomalousServiceTypeDef

def get_value() -> AnomalousServiceTypeDef:
    return {
        "ServiceId": ...,
    }
Definition
class AnomalousServiceTypeDef(TypedDict):
    ServiceId: NotRequired[ServiceIdTypeDef],  # (1)
  1. See ServiceIdTypeDef

TraceUserTypeDef

Usage Example
from mypy_boto3_xray.type_defs import TraceUserTypeDef

def get_value() -> TraceUserTypeDef:
    return {
        "UserName": ...,
    }
Definition
class TraceUserTypeDef(TypedDict):
    UserName: NotRequired[str],
    ServiceIds: NotRequired[List[ServiceIdTypeDef]],  # (1)
  1. See ServiceIdTypeDef

ValueWithServiceIdsTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ValueWithServiceIdsTypeDef

def get_value() -> ValueWithServiceIdsTypeDef:
    return {
        "AnnotationValue": ...,
    }
Definition
class ValueWithServiceIdsTypeDef(TypedDict):
    AnnotationValue: NotRequired[AnnotationValueTypeDef],  # (1)
    ServiceIds: NotRequired[List[ServiceIdTypeDef]],  # (2)
  1. See AnnotationValueTypeDef
  2. See ServiceIdTypeDef

TelemetryRecordTypeDef

Usage Example
from mypy_boto3_xray.type_defs import TelemetryRecordTypeDef

def get_value() -> TelemetryRecordTypeDef:
    return {
        "Timestamp": ...,
    }
Definition
class TelemetryRecordTypeDef(TypedDict):
    Timestamp: Union[datetime, str],
    SegmentsReceivedCount: NotRequired[int],
    SegmentsSentCount: NotRequired[int],
    SegmentsSpilloverCount: NotRequired[int],
    SegmentsRejectedCount: NotRequired[int],
    BackendConnectionErrors: NotRequired[BackendConnectionErrorsTypeDef],  # (1)
  1. See BackendConnectionErrorsTypeDef

BatchGetTracesRequestBatchGetTracesPaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import BatchGetTracesRequestBatchGetTracesPaginateTypeDef

def get_value() -> BatchGetTracesRequestBatchGetTracesPaginateTypeDef:
    return {
        "TraceIds": ...,
    }
Definition
class BatchGetTracesRequestBatchGetTracesPaginateTypeDef(TypedDict):
    TraceIds: Sequence[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetGroupsRequestGetGroupsPaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetGroupsRequestGetGroupsPaginateTypeDef

def get_value() -> GetGroupsRequestGetGroupsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class GetGroupsRequestGetGroupsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef

def get_value() -> GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef

def get_value() -> GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetServiceGraphRequestGetServiceGraphPaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetServiceGraphRequestGetServiceGraphPaginateTypeDef

def get_value() -> GetServiceGraphRequestGetServiceGraphPaginateTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
    }
Definition
class GetServiceGraphRequestGetServiceGraphPaginateTypeDef(TypedDict):
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef

def get_value() -> GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
    }
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)
  1. See PaginatorConfigTypeDef

GetTraceGraphRequestGetTraceGraphPaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetTraceGraphRequestGetTraceGraphPaginateTypeDef

def get_value() -> GetTraceGraphRequestGetTraceGraphPaginateTypeDef:
    return {
        "TraceIds": ...,
    }
Definition
class GetTraceGraphRequestGetTraceGraphPaginateTypeDef(TypedDict):
    TraceIds: Sequence[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef

def get_value() -> ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ListTagsForResourceRequestListTagsForResourcePaginateTypeDef

def get_value() -> ListTagsForResourceRequestListTagsForResourcePaginateTypeDef:
    return {
        "ResourceARN": ...,
    }
Definition
class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
    ResourceARN: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GroupSummaryTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GroupSummaryTypeDef

def get_value() -> GroupSummaryTypeDef:
    return {
        "GroupName": ...,
    }
Definition
class GroupSummaryTypeDef(TypedDict):
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],
    FilterExpression: NotRequired[str],
    InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef],  # (1)
  1. See InsightsConfigurationTypeDef

GroupTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GroupTypeDef

def get_value() -> GroupTypeDef:
    return {
        "GroupName": ...,
    }
Definition
class GroupTypeDef(TypedDict):
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],
    FilterExpression: NotRequired[str],
    InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef],  # (1)
  1. See InsightsConfigurationTypeDef

UpdateGroupRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import UpdateGroupRequestRequestTypeDef

def get_value() -> UpdateGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
    }
Definition
class UpdateGroupRequestRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    GroupARN: NotRequired[str],
    FilterExpression: NotRequired[str],
    InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef],  # (1)
  1. See InsightsConfigurationTypeDef

CreateGroupRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import CreateGroupRequestRequestTypeDef

def get_value() -> CreateGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
    }
Definition
class CreateGroupRequestRequestTypeDef(TypedDict):
    GroupName: str,
    FilterExpression: NotRequired[str],
    InsightsConfiguration: NotRequired[InsightsConfigurationTypeDef],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See InsightsConfigurationTypeDef
  2. See TagTypeDef

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "Tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateSamplingRuleRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import CreateSamplingRuleRequestRequestTypeDef

def get_value() -> CreateSamplingRuleRequestRequestTypeDef:
    return {
        "SamplingRule": ...,
    }
Definition
class CreateSamplingRuleRequestRequestTypeDef(TypedDict):
    SamplingRule: SamplingRuleTypeDef,  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See SamplingRuleTypeDef
  2. See TagTypeDef

SamplingRuleRecordTypeDef

Usage Example
from mypy_boto3_xray.type_defs import SamplingRuleRecordTypeDef

def get_value() -> SamplingRuleRecordTypeDef:
    return {
        "SamplingRule": ...,
    }
Definition
class SamplingRuleRecordTypeDef(TypedDict):
    SamplingRule: NotRequired[SamplingRuleTypeDef],  # (1)
    CreatedAt: NotRequired[datetime],
    ModifiedAt: NotRequired[datetime],
  1. See SamplingRuleTypeDef

EdgeStatisticsTypeDef

Usage Example
from mypy_boto3_xray.type_defs import EdgeStatisticsTypeDef

def get_value() -> EdgeStatisticsTypeDef:
    return {
        "OkCount": ...,
    }
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

Usage Example
from mypy_boto3_xray.type_defs import ServiceStatisticsTypeDef

def get_value() -> ServiceStatisticsTypeDef:
    return {
        "OkCount": ...,
    }
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

Usage Example
from mypy_boto3_xray.type_defs import GetEncryptionConfigResultTypeDef

def get_value() -> GetEncryptionConfigResultTypeDef:
    return {
        "EncryptionConfig": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetEncryptionConfigResultTypeDef(TypedDict):
    EncryptionConfig: EncryptionConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EncryptionConfigTypeDef
  2. See ResponseMetadataTypeDef

PutEncryptionConfigResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import PutEncryptionConfigResultTypeDef

def get_value() -> PutEncryptionConfigResultTypeDef:
    return {
        "EncryptionConfig": ...,
        "ResponseMetadata": ...,
    }
Definition
class PutEncryptionConfigResultTypeDef(TypedDict):
    EncryptionConfig: EncryptionConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EncryptionConfigTypeDef
  2. See ResponseMetadataTypeDef

ErrorRootCauseEntityTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ErrorRootCauseEntityTypeDef

def get_value() -> ErrorRootCauseEntityTypeDef:
    return {
        "Name": ...,
    }
Definition
class ErrorRootCauseEntityTypeDef(TypedDict):
    Name: NotRequired[str],
    Exceptions: NotRequired[List[RootCauseExceptionTypeDef]],  # (1)
    Remote: NotRequired[bool],
  1. See RootCauseExceptionTypeDef

FaultRootCauseEntityTypeDef

Usage Example
from mypy_boto3_xray.type_defs import FaultRootCauseEntityTypeDef

def get_value() -> FaultRootCauseEntityTypeDef:
    return {
        "Name": ...,
    }
Definition
class FaultRootCauseEntityTypeDef(TypedDict):
    Name: NotRequired[str],
    Exceptions: NotRequired[List[RootCauseExceptionTypeDef]],  # (1)
    Remote: NotRequired[bool],
  1. See RootCauseExceptionTypeDef

GetSamplingStatisticSummariesResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetSamplingStatisticSummariesResultTypeDef

def get_value() -> GetSamplingStatisticSummariesResultTypeDef:
    return {
        "SamplingStatisticSummaries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetSamplingStatisticSummariesResultTypeDef(TypedDict):
    SamplingStatisticSummaries: List[SamplingStatisticSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SamplingStatisticSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetSamplingTargetsRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetSamplingTargetsRequestRequestTypeDef

def get_value() -> GetSamplingTargetsRequestRequestTypeDef:
    return {
        "SamplingStatisticsDocuments": ...,
    }
Definition
class GetSamplingTargetsRequestRequestTypeDef(TypedDict):
    SamplingStatisticsDocuments: Sequence[SamplingStatisticsDocumentTypeDef],  # (1)
  1. See SamplingStatisticsDocumentTypeDef

GetSamplingTargetsResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetSamplingTargetsResultTypeDef

def get_value() -> GetSamplingTargetsResultTypeDef:
    return {
        "SamplingTargetDocuments": ...,
        "LastRuleModification": ...,
        "UnprocessedStatistics": ...,
        "ResponseMetadata": ...,
    }
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

GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef

def get_value() -> GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
    }
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)
  1. See TimeRangeTypeType
  2. See SamplingStrategyTypeDef
  3. See PaginatorConfigTypeDef

GetTraceSummariesRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetTraceSummariesRequestRequestTypeDef

def get_value() -> GetTraceSummariesRequestRequestTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
    }
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],
  1. See TimeRangeTypeType
  2. See SamplingStrategyTypeDef

InsightImpactGraphServiceTypeDef

Usage Example
from mypy_boto3_xray.type_defs import InsightImpactGraphServiceTypeDef

def get_value() -> InsightImpactGraphServiceTypeDef:
    return {
        "ReferenceId": ...,
    }
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

Usage Example
from mypy_boto3_xray.type_defs import ListResourcePoliciesResultTypeDef

def get_value() -> ListResourcePoliciesResultTypeDef:
    return {
        "ResourcePolicies": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListResourcePoliciesResultTypeDef(TypedDict):
    ResourcePolicies: List[ResourcePolicyTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePolicyTypeDef
  2. See ResponseMetadataTypeDef

PutResourcePolicyResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import PutResourcePolicyResultTypeDef

def get_value() -> PutResourcePolicyResultTypeDef:
    return {
        "ResourcePolicy": ...,
        "ResponseMetadata": ...,
    }
Definition
class PutResourcePolicyResultTypeDef(TypedDict):
    ResourcePolicy: ResourcePolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePolicyTypeDef
  2. See ResponseMetadataTypeDef

PutTraceSegmentsResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import PutTraceSegmentsResultTypeDef

def get_value() -> PutTraceSegmentsResultTypeDef:
    return {
        "UnprocessedTraceSegments": ...,
        "ResponseMetadata": ...,
    }
Definition
class PutTraceSegmentsResultTypeDef(TypedDict):
    UnprocessedTraceSegments: List[UnprocessedTraceSegmentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UnprocessedTraceSegmentTypeDef
  2. See ResponseMetadataTypeDef

ResponseTimeRootCauseServiceTypeDef

Usage Example
from mypy_boto3_xray.type_defs import ResponseTimeRootCauseServiceTypeDef

def get_value() -> ResponseTimeRootCauseServiceTypeDef:
    return {
        "Name": ...,
    }
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

UpdateSamplingRuleRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import UpdateSamplingRuleRequestRequestTypeDef

def get_value() -> UpdateSamplingRuleRequestRequestTypeDef:
    return {
        "SamplingRuleUpdate": ...,
    }
Definition
class UpdateSamplingRuleRequestRequestTypeDef(TypedDict):
    SamplingRuleUpdate: SamplingRuleUpdateTypeDef,  # (1)
  1. See SamplingRuleUpdateTypeDef

TraceTypeDef

Usage Example
from mypy_boto3_xray.type_defs import TraceTypeDef

def get_value() -> TraceTypeDef:
    return {
        "Id": ...,
    }
Definition
class TraceTypeDef(TypedDict):
    Id: NotRequired[str],
    Duration: NotRequired[float],
    LimitExceeded: NotRequired[bool],
    Segments: NotRequired[List[SegmentTypeDef]],  # (1)
  1. See SegmentTypeDef

InsightEventTypeDef

Usage Example
from mypy_boto3_xray.type_defs import InsightEventTypeDef

def get_value() -> InsightEventTypeDef:
    return {
        "Summary": ...,
    }
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

Usage Example
from mypy_boto3_xray.type_defs import InsightSummaryTypeDef

def get_value() -> InsightSummaryTypeDef:
    return {
        "InsightId": ...,
    }
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

Usage Example
from mypy_boto3_xray.type_defs import InsightTypeDef

def get_value() -> InsightTypeDef:
    return {
        "InsightId": ...,
    }
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

PutTelemetryRecordsRequestRequestTypeDef

Usage Example
from mypy_boto3_xray.type_defs import PutTelemetryRecordsRequestRequestTypeDef

def get_value() -> PutTelemetryRecordsRequestRequestTypeDef:
    return {
        "TelemetryRecords": ...,
    }
Definition
class PutTelemetryRecordsRequestRequestTypeDef(TypedDict):
    TelemetryRecords: Sequence[TelemetryRecordTypeDef],  # (1)
    EC2InstanceId: NotRequired[str],
    Hostname: NotRequired[str],
    ResourceARN: NotRequired[str],
  1. See TelemetryRecordTypeDef

GetGroupsResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetGroupsResultTypeDef

def get_value() -> GetGroupsResultTypeDef:
    return {
        "Groups": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetGroupsResultTypeDef(TypedDict):
    Groups: List[GroupSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateGroupResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import CreateGroupResultTypeDef

def get_value() -> CreateGroupResultTypeDef:
    return {
        "Group": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateGroupResultTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupTypeDef
  2. See ResponseMetadataTypeDef

GetGroupResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetGroupResultTypeDef

def get_value() -> GetGroupResultTypeDef:
    return {
        "Group": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetGroupResultTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupTypeDef
  2. See ResponseMetadataTypeDef

UpdateGroupResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import UpdateGroupResultTypeDef

def get_value() -> UpdateGroupResultTypeDef:
    return {
        "Group": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateGroupResultTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupTypeDef
  2. See ResponseMetadataTypeDef

CreateSamplingRuleResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import CreateSamplingRuleResultTypeDef

def get_value() -> CreateSamplingRuleResultTypeDef:
    return {
        "SamplingRuleRecord": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateSamplingRuleResultTypeDef(TypedDict):
    SamplingRuleRecord: SamplingRuleRecordTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SamplingRuleRecordTypeDef
  2. See ResponseMetadataTypeDef

DeleteSamplingRuleResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import DeleteSamplingRuleResultTypeDef

def get_value() -> DeleteSamplingRuleResultTypeDef:
    return {
        "SamplingRuleRecord": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteSamplingRuleResultTypeDef(TypedDict):
    SamplingRuleRecord: SamplingRuleRecordTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SamplingRuleRecordTypeDef
  2. See ResponseMetadataTypeDef

GetSamplingRulesResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import GetSamplingRulesResultTypeDef

def get_value() -> GetSamplingRulesResultTypeDef:
    return {
        "SamplingRuleRecords": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetSamplingRulesResultTypeDef(TypedDict):
    SamplingRuleRecords: List[SamplingRuleRecordTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SamplingRuleRecordTypeDef
  2. See ResponseMetadataTypeDef

UpdateSamplingRuleResultTypeDef

Usage Example
from mypy_boto3_xray.type_defs import UpdateSamplingRuleResultTypeDef

def get_value() -> UpdateSamplingRuleResultTypeDef:
    return {
        "SamplingRuleRecord": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateSamplingRuleResultTypeDef(TypedDict):
    SamplingRuleRecord: SamplingRuleRecordTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See <