XRay module
Index > XRay
Auto-generated documentation for XRay type annotations stubs module mypy-boto3-xray.
How to install
VSCode extension
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and XRay
.
From PyPI with pip
Install boto3-stubs
for XRay
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[xray]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[xray]'
# standalone installation
python -m pip install mypy-boto3-xray
How to uninstall
Usage
Code samples can be found in Examples.
XRayClient
Type annotations and code completion for boto3.client("xray")
as XRayClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_boto3_xray.client import XRayClient
def get_client() -> XRayClient:
return Session().client("xray")
Paginators
Type annotations and code completion for paginators
from boto3.client("xray").get_paginator("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_xray.paginator import BatchGetTracesPaginator
def get_batch_get_traces_paginator() -> BatchGetTracesPaginator:
return Session().client("xray").get_paginator("batch_get_traces"))
- BatchGetTracesPaginator
- GetGroupsPaginator
- GetSamplingRulesPaginator
- GetSamplingStatisticSummariesPaginator
- GetServiceGraphPaginator
- GetTimeSeriesServiceStatisticsPaginator
- GetTraceGraphPaginator
- GetTraceSummariesPaginator
- ListResourcePoliciesPaginator
- ListTagsForResourcePaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_xray.literals import BatchGetTracesPaginatorName
def get_value() -> BatchGetTracesPaginatorName:
return "batch_get_traces"
- BatchGetTracesPaginatorName
- EncryptionStatusType
- EncryptionTypeType
- GetGroupsPaginatorName
- GetSamplingRulesPaginatorName
- GetSamplingStatisticSummariesPaginatorName
- GetServiceGraphPaginatorName
- GetTimeSeriesServiceStatisticsPaginatorName
- GetTraceGraphPaginatorName
- GetTraceSummariesPaginatorName
- InsightCategoryType
- InsightStateType
- ListResourcePoliciesPaginatorName
- ListTagsForResourcePaginatorName
- SamplingStrategyNameType
- TimeRangeTypeType
- XRayServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_xray.type_defs import AliasTypeDef
def get_value() -> AliasTypeDef:
return {
"Name": ...,
}
- AliasTypeDef
- AnnotationValueTypeDef
- ServiceIdTypeDef
- AvailabilityZoneDetailTypeDef
- BackendConnectionErrorsTypeDef
- PaginatorConfigTypeDef
- BatchGetTracesRequestRequestTypeDef
- ResponseMetadataTypeDef
- InsightsConfigurationTypeDef
- TagTypeDef
- SamplingRuleTypeDef
- DeleteGroupRequestRequestTypeDef
- DeleteResourcePolicyRequestRequestTypeDef
- DeleteSamplingRuleRequestRequestTypeDef
- ErrorStatisticsTypeDef
- FaultStatisticsTypeDef
- HistogramEntryTypeDef
- EncryptionConfigTypeDef
- RootCauseExceptionTypeDef
- ForecastStatisticsTypeDef
- GetGroupRequestRequestTypeDef
- GetGroupsRequestRequestTypeDef
- GetInsightEventsRequestRequestTypeDef
- GetInsightImpactGraphRequestRequestTypeDef
- GetInsightRequestRequestTypeDef
- GetInsightSummariesRequestRequestTypeDef
- GetSamplingRulesRequestRequestTypeDef
- GetSamplingStatisticSummariesRequestRequestTypeDef
- SamplingStatisticSummaryTypeDef
- SamplingStatisticsDocumentTypeDef
- SamplingTargetDocumentTypeDef
- UnprocessedStatisticsTypeDef
- GetServiceGraphRequestRequestTypeDef
- GetTimeSeriesServiceStatisticsRequestRequestTypeDef
- GetTraceGraphRequestRequestTypeDef
- SamplingStrategyTypeDef
- HttpTypeDef
- RequestImpactStatisticsTypeDef
- InsightImpactGraphEdgeTypeDef
- InstanceIdDetailTypeDef
- ListResourcePoliciesRequestRequestTypeDef
- ResourcePolicyTypeDef
- ListTagsForResourceRequestRequestTypeDef
- PutEncryptionConfigRequestRequestTypeDef
- PutResourcePolicyRequestRequestTypeDef
- PutTraceSegmentsRequestRequestTypeDef
- UnprocessedTraceSegmentTypeDef
- ResourceARNDetailTypeDef
- ResponseTimeRootCauseEntityTypeDef
- SamplingRuleUpdateTypeDef
- SegmentTypeDef
- UntagResourceRequestRequestTypeDef
- AnomalousServiceTypeDef
- TraceUserTypeDef
- ValueWithServiceIdsTypeDef
- TelemetryRecordTypeDef
- BatchGetTracesRequestBatchGetTracesPaginateTypeDef
- GetGroupsRequestGetGroupsPaginateTypeDef
- GetSamplingRulesRequestGetSamplingRulesPaginateTypeDef
- GetSamplingStatisticSummariesRequestGetSamplingStatisticSummariesPaginateTypeDef
- GetServiceGraphRequestGetServiceGraphPaginateTypeDef
- GetTimeSeriesServiceStatisticsRequestGetTimeSeriesServiceStatisticsPaginateTypeDef
- GetTraceGraphRequestGetTraceGraphPaginateTypeDef
- ListResourcePoliciesRequestListResourcePoliciesPaginateTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- GroupSummaryTypeDef
- GroupTypeDef
- UpdateGroupRequestRequestTypeDef
- CreateGroupRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- CreateSamplingRuleRequestRequestTypeDef
- SamplingRuleRecordTypeDef
- EdgeStatisticsTypeDef
- ServiceStatisticsTypeDef
- GetEncryptionConfigResultTypeDef
- PutEncryptionConfigResultTypeDef
- ErrorRootCauseEntityTypeDef
- FaultRootCauseEntityTypeDef
- GetSamplingStatisticSummariesResultTypeDef
- GetSamplingTargetsRequestRequestTypeDef
- GetSamplingTargetsResultTypeDef
- GetTraceSummariesRequestGetTraceSummariesPaginateTypeDef
- GetTraceSummariesRequestRequestTypeDef
- InsightImpactGraphServiceTypeDef
- ListResourcePoliciesResultTypeDef
- PutResourcePolicyResultTypeDef
- PutTraceSegmentsResultTypeDef
- ResponseTimeRootCauseServiceTypeDef
- UpdateSamplingRuleRequestRequestTypeDef
- TraceTypeDef
- InsightEventTypeDef
- InsightSummaryTypeDef
- InsightTypeDef
- PutTelemetryRecordsRequestRequestTypeDef
- GetGroupsResultTypeDef
- CreateGroupResultTypeDef
- GetGroupResultTypeDef
- UpdateGroupResultTypeDef
- CreateSamplingRuleResultTypeDef
- DeleteSamplingRuleResultTypeDef
- GetSamplingRulesResultTypeDef
- UpdateSamplingRuleResultTypeDef
- EdgeTypeDef
- TimeSeriesServiceStatisticsTypeDef
- ErrorRootCauseServiceTypeDef
- FaultRootCauseServiceTypeDef
- GetInsightImpactGraphResultTypeDef
- ResponseTimeRootCauseTypeDef
- BatchGetTracesResultTypeDef
- GetInsightEventsResultTypeDef
- GetInsightSummariesResultTypeDef
- GetInsightResultTypeDef
- ServiceTypeDef
- GetTimeSeriesServiceStatisticsResultTypeDef
- ErrorRootCauseTypeDef
- FaultRootCauseTypeDef
- GetServiceGraphResultTypeDef
- GetTraceGraphResultTypeDef
- TraceSummaryTypeDef
- GetTraceSummariesResultTypeDef