Literals#
Auto-generated documentation for XRay type annotations stubs module mypy-boto3-xray.
BatchGetTracesPaginatorName#
# BatchGetTracesPaginatorName usage example
from mypy_boto3_xray.literals import BatchGetTracesPaginatorName
def get_value() -> BatchGetTracesPaginatorName:
return "batch_get_traces"# BatchGetTracesPaginatorName definition
BatchGetTracesPaginatorName = Literal[
"batch_get_traces",
]EncryptionStatusType#
# EncryptionStatusType usage example
from mypy_boto3_xray.literals import EncryptionStatusType
def get_value() -> EncryptionStatusType:
return "ACTIVE"# EncryptionStatusType definition
EncryptionStatusType = Literal[
"ACTIVE",
"UPDATING",
]EncryptionTypeType#
# EncryptionTypeType usage example
from mypy_boto3_xray.literals import EncryptionTypeType
def get_value() -> EncryptionTypeType:
return "KMS"# EncryptionTypeType definition
EncryptionTypeType = Literal[
"KMS",
"NONE",
]GetGroupsPaginatorName#
# GetGroupsPaginatorName usage example
from mypy_boto3_xray.literals import GetGroupsPaginatorName
def get_value() -> GetGroupsPaginatorName:
return "get_groups"# GetGroupsPaginatorName definition
GetGroupsPaginatorName = Literal[
"get_groups",
]GetSamplingRulesPaginatorName#
# GetSamplingRulesPaginatorName usage example
from mypy_boto3_xray.literals import GetSamplingRulesPaginatorName
def get_value() -> GetSamplingRulesPaginatorName:
return "get_sampling_rules"# GetSamplingRulesPaginatorName definition
GetSamplingRulesPaginatorName = Literal[
"get_sampling_rules",
]GetSamplingStatisticSummariesPaginatorName#
# GetSamplingStatisticSummariesPaginatorName usage example
from mypy_boto3_xray.literals import GetSamplingStatisticSummariesPaginatorName
def get_value() -> GetSamplingStatisticSummariesPaginatorName:
return "get_sampling_statistic_summaries"# GetSamplingStatisticSummariesPaginatorName definition
GetSamplingStatisticSummariesPaginatorName = Literal[
"get_sampling_statistic_summaries",
]GetServiceGraphPaginatorName#
# GetServiceGraphPaginatorName usage example
from mypy_boto3_xray.literals import GetServiceGraphPaginatorName
def get_value() -> GetServiceGraphPaginatorName:
return "get_service_graph"# GetServiceGraphPaginatorName definition
GetServiceGraphPaginatorName = Literal[
"get_service_graph",
]GetTimeSeriesServiceStatisticsPaginatorName#
# GetTimeSeriesServiceStatisticsPaginatorName usage example
from mypy_boto3_xray.literals import GetTimeSeriesServiceStatisticsPaginatorName
def get_value() -> GetTimeSeriesServiceStatisticsPaginatorName:
return "get_time_series_service_statistics"# GetTimeSeriesServiceStatisticsPaginatorName definition
GetTimeSeriesServiceStatisticsPaginatorName = Literal[
"get_time_series_service_statistics",
]GetTraceGraphPaginatorName#
# GetTraceGraphPaginatorName usage example
from mypy_boto3_xray.literals import GetTraceGraphPaginatorName
def get_value() -> GetTraceGraphPaginatorName:
return "get_trace_graph"# GetTraceGraphPaginatorName definition
GetTraceGraphPaginatorName = Literal[
"get_trace_graph",
]GetTraceSummariesPaginatorName#
# GetTraceSummariesPaginatorName usage example
from mypy_boto3_xray.literals import GetTraceSummariesPaginatorName
def get_value() -> GetTraceSummariesPaginatorName:
return "get_trace_summaries"# GetTraceSummariesPaginatorName definition
GetTraceSummariesPaginatorName = Literal[
"get_trace_summaries",
]InsightCategoryType#
# InsightCategoryType usage example
from mypy_boto3_xray.literals import InsightCategoryType
def get_value() -> InsightCategoryType:
return "FAULT"# InsightCategoryType definition
InsightCategoryType = Literal[
"FAULT",
]InsightStateType#
# InsightStateType usage example
from mypy_boto3_xray.literals import InsightStateType
def get_value() -> InsightStateType:
return "ACTIVE"# InsightStateType definition
InsightStateType = Literal[
"ACTIVE",
"CLOSED",
]ListResourcePoliciesPaginatorName#
# ListResourcePoliciesPaginatorName usage example
from mypy_boto3_xray.literals import ListResourcePoliciesPaginatorName
def get_value() -> ListResourcePoliciesPaginatorName:
return "list_resource_policies"# ListResourcePoliciesPaginatorName definition
ListResourcePoliciesPaginatorName = Literal[
"list_resource_policies",
]ListTagsForResourcePaginatorName#
# ListTagsForResourcePaginatorName usage example
from mypy_boto3_xray.literals import ListTagsForResourcePaginatorName
def get_value() -> ListTagsForResourcePaginatorName:
return "list_tags_for_resource"# ListTagsForResourcePaginatorName definition
ListTagsForResourcePaginatorName = Literal[
"list_tags_for_resource",
]RetrievalStatusType#
# RetrievalStatusType usage example
from mypy_boto3_xray.literals import RetrievalStatusType
def get_value() -> RetrievalStatusType:
return "CANCELLED"# RetrievalStatusType definition
RetrievalStatusType = Literal[
"CANCELLED",
"COMPLETE",
"FAILED",
"RUNNING",
"SCHEDULED",
"TIMEOUT",
]SamplingStrategyNameType#
# SamplingStrategyNameType usage example
from mypy_boto3_xray.literals import SamplingStrategyNameType
def get_value() -> SamplingStrategyNameType:
return "FixedRate"# SamplingStrategyNameType definition
SamplingStrategyNameType = Literal[
"FixedRate",
"PartialScan",
]TimeRangeTypeType#
# TimeRangeTypeType usage example
from mypy_boto3_xray.literals import TimeRangeTypeType
def get_value() -> TimeRangeTypeType:
return "Event"# TimeRangeTypeType definition
TimeRangeTypeType = Literal[
"Event",
"Service",
"TraceId",
]TraceFormatTypeType#
# TraceFormatTypeType usage example
from mypy_boto3_xray.literals import TraceFormatTypeType
def get_value() -> TraceFormatTypeType:
return "OTEL"# TraceFormatTypeType definition
TraceFormatTypeType = Literal[
"OTEL",
"XRAY",
]TraceSegmentDestinationStatusType#
# TraceSegmentDestinationStatusType usage example
from mypy_boto3_xray.literals import TraceSegmentDestinationStatusType
def get_value() -> TraceSegmentDestinationStatusType:
return "ACTIVE"# TraceSegmentDestinationStatusType definition
TraceSegmentDestinationStatusType = Literal[
"ACTIVE",
"PENDING",
]TraceSegmentDestinationType#
# TraceSegmentDestinationType usage example
from mypy_boto3_xray.literals import TraceSegmentDestinationType
def get_value() -> TraceSegmentDestinationType:
return "CloudWatchLogs"# TraceSegmentDestinationType definition
TraceSegmentDestinationType = Literal[
"CloudWatchLogs",
"XRay",
]XRayServiceName#
# XRayServiceName usage example
from mypy_boto3_xray.literals import XRayServiceName
def get_value() -> XRayServiceName:
return "xray"# XRayServiceName definition
XRayServiceName = Literal[
"xray",
]ServiceName#
# ServiceName usage example
from mypy_boto3_xray.literals import ServiceName
def get_value() -> ServiceName:
return "accessanalyzer"# ServiceName definition
ServiceName = Literal[
"accessanalyzer",
"account",
"acm",
"acm-pca",
"amp",
"amplify",
"amplifybackend",
"amplifyuibuilder",
"apigateway",
"apigatewaymanagementapi",
"apigatewayv2",
"appconfig",
"appconfigdata",
"appfabric",
"appflow",
"appintegrations",
"application-autoscaling",
"application-insights",
"application-signals",
"applicationcostprofiler",
"appmesh",
"apprunner",
"appstream",
"appsync",
"apptest",
"arc-zonal-shift",
"artifact",
"athena",
"auditmanager",
"autoscaling",
"autoscaling-plans",
"b2bi",
"backup",
"backup-gateway",
"backupsearch",
"batch",
"bcm-data-exports",
"bcm-pricing-calculator",
"bedrock",
"bedrock-agent",
"bedrock-agent-runtime",
"bedrock-data-automation",
"bedrock-data-automation-runtime",
"bedrock-runtime",
"billing",
"billingconductor",
"braket",
"budgets",
"ce",
"chatbot",
"chime",
"chime-sdk-identity",
"chime-sdk-media-pipelines",
"chime-sdk-meetings",
"chime-sdk-messaging",
"chime-sdk-voice",
"cleanrooms",
"cleanroomsml",
"cloud9",
"cloudcontrol",
"clouddirectory",
"cloudformation",
"cloudfront",
"cloudfront-keyvaluestore",
"cloudhsm",
"cloudhsmv2",
"cloudsearch",
"cloudsearchdomain",
"cloudtrail",
"cloudtrail-data",
"cloudwatch",
"codeartifact",
"codebuild",
"codecatalyst",
"codecommit",
"codeconnections",
"codedeploy",
"codeguru-reviewer",
"codeguru-security",
"codeguruprofiler",
"codepipeline",
"codestar-connections",
"codestar-notifications",
"cognito-identity",
"cognito-idp",
"cognito-sync",
"comprehend",
"comprehendmedical",
"compute-optimizer",
"config",
"connect",
"connect-contact-lens",
"connectcampaigns",
"connectcampaignsv2",
"connectcases",
"connectparticipant",
"controlcatalog",
"controltower",
"cost-optimization-hub",
"cur",
"customer-profiles",
"databrew",
"dataexchange",
"datapipeline",
"datasync",
"datazone",
"dax",
"deadline",
"detective",
"devicefarm",
"devops-guru",
"directconnect",
"discovery",
"dlm",
"dms",
"docdb",
"docdb-elastic",
"drs",
"ds",
"ds-data",
"dsql",
"dynamodb",
"dynamodbstreams",
"ebs",
"ec2",
"ec2-instance-connect",
"ecr",
"ecr-public",
"ecs",
"efs",
"eks",
"eks-auth",
"elastic-inference",
"elasticache",
"elasticbeanstalk",
"elastictranscoder",
"elb",
"elbv2",
"emr",
"emr-containers",
"emr-serverless",
"entityresolution",
"es",
"events",
"evidently",
"finspace",
"finspace-data",
"firehose",
"fis",
"fms",
"forecast",
"forecastquery",
"frauddetector",
"freetier",
"fsx",
"gamelift",
"geo-maps",
"geo-places",
"geo-routes",
"glacier",
"globalaccelerator",
"glue",
"grafana",
"greengrass",
"greengrassv2",
"groundstation",
"guardduty",
"health",
"healthlake",
"iam",
"identitystore",
"imagebuilder",
"importexport",
"inspector",
"inspector-scan",
"inspector2",
"internetmonitor",
"invoicing",
"iot",
"iot-data",
"iot-jobs-data",
"iot1click-devices",
"iot1click-projects",
"iotanalytics",
"iotdeviceadvisor",
"iotevents",
"iotevents-data",
"iotfleethub",
"iotfleetwise",
"iotsecuretunneling",
"iotsitewise",
"iotthingsgraph",
"iottwinmaker",
"iotwireless",
"ivs",
"ivs-realtime",
"ivschat",
"kafka",
"kafkaconnect",
"kendra",
"kendra-ranking",
"keyspaces",
"kinesis",
"kinesis-video-archived-media",
"kinesis-video-media",
"kinesis-video-signaling",
"kinesis-video-webrtc-storage",
"kinesisanalytics",
"kinesisanalyticsv2",
"kinesisvideo",
"kms",
"lakeformation",
"lambda",
"launch-wizard",
"lex-models",
"lex-runtime",
"lexv2-models",
"lexv2-runtime",
"license-manager",
"license-manager-linux-subscriptions",
"license-manager-user-subscriptions",
"lightsail",
"location",
"logs",
"lookoutequipment",
"lookoutmetrics",
"lookoutvision",
"m2",
"machinelearning",
"macie2",
"mailmanager",
"managedblockchain",
"managedblockchain-query",
"marketplace-agreement",
"marketplace-catalog",
"marketplace-deployment",
"marketplace-entitlement",
"marketplace-reporting",
"marketplacecommerceanalytics",
"mediaconnect",
"mediaconvert",
"medialive",
"mediapackage",
"mediapackage-vod",
"mediapackagev2",
"mediastore",
"mediastore-data",
"mediatailor",
"medical-imaging",
"memorydb",
"meteringmarketplace",
"mgh",
"mgn",
"migration-hub-refactor-spaces",
"migrationhub-config",
"migrationhuborchestrator",
"migrationhubstrategy",
"mq",
"mturk",
"mwaa",
"neptune",
"neptune-graph",
"neptunedata",
"network-firewall",
"networkflowmonitor",
"networkmanager",
"networkmonitor",
"notifications",
"notificationscontacts",
"oam",
"observabilityadmin",
"omics",
"opensearch",
"opensearchserverless",
"opsworks",
"opsworkscm",
"organizations",
"osis",
"outposts",
"panorama",
"partnercentral-selling",
"payment-cryptography",
"payment-cryptography-data",
"pca-connector-ad",
"pca-connector-scep",
"pcs",
"personalize",
"personalize-events",
"personalize-runtime",
"pi",
"pinpoint",
"pinpoint-email",
"pinpoint-sms-voice",
"pinpoint-sms-voice-v2",
"pipes",
"polly",
"pricing",
"privatenetworks",
"proton",
"qapps",
"qbusiness",
"qconnect",
"qldb",
"qldb-session",
"quicksight",
"ram",
"rbin",
"rds",
"rds-data",
"redshift",
"redshift-data",
"redshift-serverless",
"rekognition",
"repostspace",
"resiliencehub",
"resource-explorer-2",
"resource-groups",
"resourcegroupstaggingapi",
"robomaker",
"rolesanywhere",
"route53",
"route53-recovery-cluster",
"route53-recovery-control-config",
"route53-recovery-readiness",
"route53domains",
"route53profiles",
"route53resolver",
"rum",
"s3",
"s3control",
"s3outposts",
"s3tables",
"sagemaker",
"sagemaker-a2i-runtime",
"sagemaker-edge",
"sagemaker-featurestore-runtime",
"sagemaker-geospatial",
"sagemaker-metrics",
"sagemaker-runtime",
"savingsplans",
"scheduler",
"schemas",
"sdb",
"secretsmanager",
"security-ir",
"securityhub",
"securitylake",
"serverlessrepo",
"service-quotas",
"servicecatalog",
"servicecatalog-appregistry",
"servicediscovery",
"ses",
"sesv2",
"shield",
"signer",
"simspaceweaver",
"sms",
"sms-voice",
"snow-device-management",
"snowball",
"sns",
"socialmessaging",
"sqs",
"ssm",
"ssm-contacts",
"ssm-incidents",
"ssm-quicksetup",
"ssm-sap",
"sso",
"sso-admin",
"sso-oidc",
"stepfunctions",
"storagegateway",
"sts",
"supplychain",
"support",
"support-app",
"swf",
"synthetics",
"taxsettings",
"textract",
"timestream-influxdb",
"timestream-query",
"timestream-write",
"tnb",
"transcribe",
"transfer",
"translate",
"trustedadvisor",
"verifiedpermissions",
"voice-id",
"vpc-lattice",
"waf",
"waf-regional",
"wafv2",
"wellarchitected",
"wisdom",
"workdocs",
"workmail",
"workmailmessageflow",
"workspaces",
"workspaces-thin-client",
"workspaces-web",
"xray",
]ResourceServiceName#
# ResourceServiceName usage example
from mypy_boto3_xray.literals import ResourceServiceName
def get_value() -> ResourceServiceName:
return "cloudformation"# ResourceServiceName definition
ResourceServiceName = Literal[
"cloudformation",
"cloudwatch",
"dynamodb",
"ec2",
"glacier",
"iam",
"opsworks",
"s3",
"sns",
"sqs",
]PaginatorName#
# PaginatorName usage example
from mypy_boto3_xray.literals import PaginatorName
def get_value() -> PaginatorName:
return "batch_get_traces"# PaginatorName definition
PaginatorName = Literal[
"batch_get_traces",
"get_groups",
"get_sampling_rules",
"get_sampling_statistic_summaries",
"get_service_graph",
"get_time_series_service_statistics",
"get_trace_graph",
"get_trace_summaries",
"list_resource_policies",
"list_tags_for_resource",
]RegionName#
# RegionName usage example
from mypy_boto3_xray.literals import RegionName
def get_value() -> RegionName:
return "af-south-1"# RegionName definition
RegionName = Literal[
"af-south-1",
"ap-east-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-south-1",
"ap-south-2",
"ap-southeast-1",
"ap-southeast-2",
"ap-southeast-3",
"ap-southeast-4",
"ap-southeast-5",
"ca-central-1",
"ca-west-1",
"eu-central-1",
"eu-central-2",
"eu-north-1",
"eu-south-1",
"eu-south-2",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"il-central-1",
"me-central-1",
"me-south-1",
"sa-east-1",
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
]