Literals#
Auto-generated documentation for DocDB type annotations stubs module mypy-boto3-docdb.
ApplyMethodType#
# ApplyMethodType usage example
from mypy_boto3_docdb.literals import ApplyMethodType
def get_value() -> ApplyMethodType:
return "immediate"
# ApplyMethodType definition
ApplyMethodType = Literal[
"immediate",
"pending-reboot",
]
DBInstanceAvailableWaiterName#
# DBInstanceAvailableWaiterName usage example
from mypy_boto3_docdb.literals import DBInstanceAvailableWaiterName
def get_value() -> DBInstanceAvailableWaiterName:
return "db_instance_available"
# DBInstanceAvailableWaiterName definition
DBInstanceAvailableWaiterName = Literal[
"db_instance_available",
]
DBInstanceDeletedWaiterName#
# DBInstanceDeletedWaiterName usage example
from mypy_boto3_docdb.literals import DBInstanceDeletedWaiterName
def get_value() -> DBInstanceDeletedWaiterName:
return "db_instance_deleted"
# DBInstanceDeletedWaiterName definition
DBInstanceDeletedWaiterName = Literal[
"db_instance_deleted",
]
DescribeCertificatesPaginatorName#
# DescribeCertificatesPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeCertificatesPaginatorName
def get_value() -> DescribeCertificatesPaginatorName:
return "describe_certificates"
# DescribeCertificatesPaginatorName definition
DescribeCertificatesPaginatorName = Literal[
"describe_certificates",
]
DescribeDBClusterParameterGroupsPaginatorName#
# DescribeDBClusterParameterGroupsPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeDBClusterParameterGroupsPaginatorName
def get_value() -> DescribeDBClusterParameterGroupsPaginatorName:
return "describe_db_cluster_parameter_groups"
# DescribeDBClusterParameterGroupsPaginatorName definition
DescribeDBClusterParameterGroupsPaginatorName = Literal[
"describe_db_cluster_parameter_groups",
]
DescribeDBClusterParametersPaginatorName#
# DescribeDBClusterParametersPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeDBClusterParametersPaginatorName
def get_value() -> DescribeDBClusterParametersPaginatorName:
return "describe_db_cluster_parameters"
# DescribeDBClusterParametersPaginatorName definition
DescribeDBClusterParametersPaginatorName = Literal[
"describe_db_cluster_parameters",
]
DescribeDBClusterSnapshotsPaginatorName#
# DescribeDBClusterSnapshotsPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeDBClusterSnapshotsPaginatorName
def get_value() -> DescribeDBClusterSnapshotsPaginatorName:
return "describe_db_cluster_snapshots"
# DescribeDBClusterSnapshotsPaginatorName definition
DescribeDBClusterSnapshotsPaginatorName = Literal[
"describe_db_cluster_snapshots",
]
DescribeDBClustersPaginatorName#
# DescribeDBClustersPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeDBClustersPaginatorName
def get_value() -> DescribeDBClustersPaginatorName:
return "describe_db_clusters"
# DescribeDBClustersPaginatorName definition
DescribeDBClustersPaginatorName = Literal[
"describe_db_clusters",
]
DescribeDBEngineVersionsPaginatorName#
# DescribeDBEngineVersionsPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeDBEngineVersionsPaginatorName
def get_value() -> DescribeDBEngineVersionsPaginatorName:
return "describe_db_engine_versions"
# DescribeDBEngineVersionsPaginatorName definition
DescribeDBEngineVersionsPaginatorName = Literal[
"describe_db_engine_versions",
]
DescribeDBInstancesPaginatorName#
# DescribeDBInstancesPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeDBInstancesPaginatorName
def get_value() -> DescribeDBInstancesPaginatorName:
return "describe_db_instances"
# DescribeDBInstancesPaginatorName definition
DescribeDBInstancesPaginatorName = Literal[
"describe_db_instances",
]
DescribeDBSubnetGroupsPaginatorName#
# DescribeDBSubnetGroupsPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeDBSubnetGroupsPaginatorName
def get_value() -> DescribeDBSubnetGroupsPaginatorName:
return "describe_db_subnet_groups"
# DescribeDBSubnetGroupsPaginatorName definition
DescribeDBSubnetGroupsPaginatorName = Literal[
"describe_db_subnet_groups",
]
DescribeEventSubscriptionsPaginatorName#
# DescribeEventSubscriptionsPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeEventSubscriptionsPaginatorName
def get_value() -> DescribeEventSubscriptionsPaginatorName:
return "describe_event_subscriptions"
# DescribeEventSubscriptionsPaginatorName definition
DescribeEventSubscriptionsPaginatorName = Literal[
"describe_event_subscriptions",
]
DescribeEventsPaginatorName#
# DescribeEventsPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeEventsPaginatorName
def get_value() -> DescribeEventsPaginatorName:
return "describe_events"
# DescribeEventsPaginatorName definition
DescribeEventsPaginatorName = Literal[
"describe_events",
]
DescribeGlobalClustersPaginatorName#
# DescribeGlobalClustersPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeGlobalClustersPaginatorName
def get_value() -> DescribeGlobalClustersPaginatorName:
return "describe_global_clusters"
# DescribeGlobalClustersPaginatorName definition
DescribeGlobalClustersPaginatorName = Literal[
"describe_global_clusters",
]
DescribeOrderableDBInstanceOptionsPaginatorName#
# DescribeOrderableDBInstanceOptionsPaginatorName usage example
from mypy_boto3_docdb.literals import DescribeOrderableDBInstanceOptionsPaginatorName
def get_value() -> DescribeOrderableDBInstanceOptionsPaginatorName:
return "describe_orderable_db_instance_options"
# DescribeOrderableDBInstanceOptionsPaginatorName definition
DescribeOrderableDBInstanceOptionsPaginatorName = Literal[
"describe_orderable_db_instance_options",
]
DescribePendingMaintenanceActionsPaginatorName#
# DescribePendingMaintenanceActionsPaginatorName usage example
from mypy_boto3_docdb.literals import DescribePendingMaintenanceActionsPaginatorName
def get_value() -> DescribePendingMaintenanceActionsPaginatorName:
return "describe_pending_maintenance_actions"
# DescribePendingMaintenanceActionsPaginatorName definition
DescribePendingMaintenanceActionsPaginatorName = Literal[
"describe_pending_maintenance_actions",
]
SourceTypeType#
# SourceTypeType usage example
from mypy_boto3_docdb.literals import SourceTypeType
def get_value() -> SourceTypeType:
return "db-cluster"
# SourceTypeType definition
SourceTypeType = Literal[
"db-cluster",
"db-cluster-snapshot",
"db-instance",
"db-parameter-group",
"db-security-group",
"db-snapshot",
]
DocDBServiceName#
# DocDBServiceName usage example
from mypy_boto3_docdb.literals import DocDBServiceName
def get_value() -> DocDBServiceName:
return "docdb"
# DocDBServiceName definition
DocDBServiceName = Literal[
"docdb",
]
ServiceName#
# ServiceName usage example
from mypy_boto3_docdb.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",
"batch",
"bcm-data-exports",
"bedrock",
"bedrock-agent",
"bedrock-agent-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",
"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",
"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",
"networkmanager",
"networkmonitor",
"oam",
"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",
"sagemaker",
"sagemaker-a2i-runtime",
"sagemaker-edge",
"sagemaker-featurestore-runtime",
"sagemaker-geospatial",
"sagemaker-metrics",
"sagemaker-runtime",
"savingsplans",
"scheduler",
"schemas",
"sdb",
"secretsmanager",
"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_docdb.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_docdb.literals import PaginatorName
def get_value() -> PaginatorName:
return "describe_certificates"
# PaginatorName definition
PaginatorName = Literal[
"describe_certificates",
"describe_db_cluster_parameter_groups",
"describe_db_cluster_parameters",
"describe_db_cluster_snapshots",
"describe_db_clusters",
"describe_db_engine_versions",
"describe_db_instances",
"describe_db_subnet_groups",
"describe_event_subscriptions",
"describe_events",
"describe_global_clusters",
"describe_orderable_db_instance_options",
"describe_pending_maintenance_actions",
]
WaiterName#
# WaiterName usage example
from mypy_boto3_docdb.literals import WaiterName
def get_value() -> WaiterName:
return "db_instance_available"
# WaiterName definition
WaiterName = Literal[
"db_instance_available",
"db_instance_deleted",
]
RegionName#
# RegionName usage example
from mypy_boto3_docdb.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",
]