Literals#
Index > APIGateway > Literals
Auto-generated documentation for APIGateway type annotations stubs module mypy-boto3-apigateway.
ApiKeySourceTypeType#
# ApiKeySourceTypeType usage example
from mypy_boto3_apigateway.literals import ApiKeySourceTypeType
def get_value() -> ApiKeySourceTypeType:
return "AUTHORIZER"# ApiKeySourceTypeType definition
ApiKeySourceTypeType = Literal[
"AUTHORIZER",
"HEADER",
]ApiKeysFormatType#
# ApiKeysFormatType usage example
from mypy_boto3_apigateway.literals import ApiKeysFormatType
def get_value() -> ApiKeysFormatType:
return "csv"# ApiKeysFormatType definition
ApiKeysFormatType = Literal[
"csv",
]AuthorizerTypeType#
# AuthorizerTypeType usage example
from mypy_boto3_apigateway.literals import AuthorizerTypeType
def get_value() -> AuthorizerTypeType:
return "COGNITO_USER_POOLS"# AuthorizerTypeType definition
AuthorizerTypeType = Literal[
"COGNITO_USER_POOLS",
"REQUEST",
"TOKEN",
]CacheClusterSizeType#
# CacheClusterSizeType usage example
from mypy_boto3_apigateway.literals import CacheClusterSizeType
def get_value() -> CacheClusterSizeType:
return "0.5"# CacheClusterSizeType definition
CacheClusterSizeType = Literal[
"0.5",
"1.6",
"118",
"13.5",
"237",
"28.4",
"58.2",
"6.1",
]CacheClusterStatusType#
# CacheClusterStatusType usage example
from mypy_boto3_apigateway.literals import CacheClusterStatusType
def get_value() -> CacheClusterStatusType:
return "AVAILABLE"# CacheClusterStatusType definition
CacheClusterStatusType = Literal[
"AVAILABLE",
"CREATE_IN_PROGRESS",
"DELETE_IN_PROGRESS",
"FLUSH_IN_PROGRESS",
"NOT_AVAILABLE",
]ConnectionTypeType#
# ConnectionTypeType usage example
from mypy_boto3_apigateway.literals import ConnectionTypeType
def get_value() -> ConnectionTypeType:
return "INTERNET"# ConnectionTypeType definition
ConnectionTypeType = Literal[
"INTERNET",
"VPC_LINK",
]ContentHandlingStrategyType#
# ContentHandlingStrategyType usage example
from mypy_boto3_apigateway.literals import ContentHandlingStrategyType
def get_value() -> ContentHandlingStrategyType:
return "CONVERT_TO_BINARY"# ContentHandlingStrategyType definition
ContentHandlingStrategyType = Literal[
"CONVERT_TO_BINARY",
"CONVERT_TO_TEXT",
]DocumentationPartTypeType#
# DocumentationPartTypeType usage example
from mypy_boto3_apigateway.literals import DocumentationPartTypeType
def get_value() -> DocumentationPartTypeType:
return "API"# DocumentationPartTypeType definition
DocumentationPartTypeType = Literal[
"API",
"AUTHORIZER",
"METHOD",
"MODEL",
"PATH_PARAMETER",
"QUERY_PARAMETER",
"REQUEST_BODY",
"REQUEST_HEADER",
"RESOURCE",
"RESPONSE",
"RESPONSE_BODY",
"RESPONSE_HEADER",
]DomainNameStatusType#
# DomainNameStatusType usage example
from mypy_boto3_apigateway.literals import DomainNameStatusType
def get_value() -> DomainNameStatusType:
return "AVAILABLE"# DomainNameStatusType definition
DomainNameStatusType = Literal[
"AVAILABLE",
"PENDING",
"PENDING_CERTIFICATE_REIMPORT",
"PENDING_OWNERSHIP_VERIFICATION",
"UPDATING",
]EndpointTypeType#
# EndpointTypeType usage example
from mypy_boto3_apigateway.literals import EndpointTypeType
def get_value() -> EndpointTypeType:
return "EDGE"# EndpointTypeType definition
EndpointTypeType = Literal[
"EDGE",
"PRIVATE",
"REGIONAL",
]GatewayResponseTypeType#
# GatewayResponseTypeType usage example
from mypy_boto3_apigateway.literals import GatewayResponseTypeType
def get_value() -> GatewayResponseTypeType:
return "ACCESS_DENIED"# GatewayResponseTypeType definition
GatewayResponseTypeType = Literal[
"ACCESS_DENIED",
"API_CONFIGURATION_ERROR",
"AUTHORIZER_CONFIGURATION_ERROR",
"AUTHORIZER_FAILURE",
"BAD_REQUEST_BODY",
"BAD_REQUEST_PARAMETERS",
"DEFAULT_4XX",
"DEFAULT_5XX",
"EXPIRED_TOKEN",
"INTEGRATION_FAILURE",
"INTEGRATION_TIMEOUT",
"INVALID_API_KEY",
"INVALID_SIGNATURE",
"MISSING_AUTHENTICATION_TOKEN",
"QUOTA_EXCEEDED",
"REQUEST_TOO_LARGE",
"RESOURCE_NOT_FOUND",
"THROTTLED",
"UNAUTHORIZED",
"UNSUPPORTED_MEDIA_TYPE",
"WAF_FILTERED",
]GetApiKeysPaginatorName#
# GetApiKeysPaginatorName usage example
from mypy_boto3_apigateway.literals import GetApiKeysPaginatorName
def get_value() -> GetApiKeysPaginatorName:
return "get_api_keys"# GetApiKeysPaginatorName definition
GetApiKeysPaginatorName = Literal[
"get_api_keys",
]GetAuthorizersPaginatorName#
# GetAuthorizersPaginatorName usage example
from mypy_boto3_apigateway.literals import GetAuthorizersPaginatorName
def get_value() -> GetAuthorizersPaginatorName:
return "get_authorizers"# GetAuthorizersPaginatorName definition
GetAuthorizersPaginatorName = Literal[
"get_authorizers",
]GetBasePathMappingsPaginatorName#
# GetBasePathMappingsPaginatorName usage example
from mypy_boto3_apigateway.literals import GetBasePathMappingsPaginatorName
def get_value() -> GetBasePathMappingsPaginatorName:
return "get_base_path_mappings"# GetBasePathMappingsPaginatorName definition
GetBasePathMappingsPaginatorName = Literal[
"get_base_path_mappings",
]GetClientCertificatesPaginatorName#
# GetClientCertificatesPaginatorName usage example
from mypy_boto3_apigateway.literals import GetClientCertificatesPaginatorName
def get_value() -> GetClientCertificatesPaginatorName:
return "get_client_certificates"# GetClientCertificatesPaginatorName definition
GetClientCertificatesPaginatorName = Literal[
"get_client_certificates",
]GetDeploymentsPaginatorName#
# GetDeploymentsPaginatorName usage example
from mypy_boto3_apigateway.literals import GetDeploymentsPaginatorName
def get_value() -> GetDeploymentsPaginatorName:
return "get_deployments"# GetDeploymentsPaginatorName definition
GetDeploymentsPaginatorName = Literal[
"get_deployments",
]GetDocumentationPartsPaginatorName#
# GetDocumentationPartsPaginatorName usage example
from mypy_boto3_apigateway.literals import GetDocumentationPartsPaginatorName
def get_value() -> GetDocumentationPartsPaginatorName:
return "get_documentation_parts"# GetDocumentationPartsPaginatorName definition
GetDocumentationPartsPaginatorName = Literal[
"get_documentation_parts",
]GetDocumentationVersionsPaginatorName#
# GetDocumentationVersionsPaginatorName usage example
from mypy_boto3_apigateway.literals import GetDocumentationVersionsPaginatorName
def get_value() -> GetDocumentationVersionsPaginatorName:
return "get_documentation_versions"# GetDocumentationVersionsPaginatorName definition
GetDocumentationVersionsPaginatorName = Literal[
"get_documentation_versions",
]GetDomainNamesPaginatorName#
# GetDomainNamesPaginatorName usage example
from mypy_boto3_apigateway.literals import GetDomainNamesPaginatorName
def get_value() -> GetDomainNamesPaginatorName:
return "get_domain_names"# GetDomainNamesPaginatorName definition
GetDomainNamesPaginatorName = Literal[
"get_domain_names",
]GetGatewayResponsesPaginatorName#
# GetGatewayResponsesPaginatorName usage example
from mypy_boto3_apigateway.literals import GetGatewayResponsesPaginatorName
def get_value() -> GetGatewayResponsesPaginatorName:
return "get_gateway_responses"# GetGatewayResponsesPaginatorName definition
GetGatewayResponsesPaginatorName = Literal[
"get_gateway_responses",
]GetModelsPaginatorName#
# GetModelsPaginatorName usage example
from mypy_boto3_apigateway.literals import GetModelsPaginatorName
def get_value() -> GetModelsPaginatorName:
return "get_models"# GetModelsPaginatorName definition
GetModelsPaginatorName = Literal[
"get_models",
]GetRequestValidatorsPaginatorName#
# GetRequestValidatorsPaginatorName usage example
from mypy_boto3_apigateway.literals import GetRequestValidatorsPaginatorName
def get_value() -> GetRequestValidatorsPaginatorName:
return "get_request_validators"# GetRequestValidatorsPaginatorName definition
GetRequestValidatorsPaginatorName = Literal[
"get_request_validators",
]GetResourcesPaginatorName#
# GetResourcesPaginatorName usage example
from mypy_boto3_apigateway.literals import GetResourcesPaginatorName
def get_value() -> GetResourcesPaginatorName:
return "get_resources"# GetResourcesPaginatorName definition
GetResourcesPaginatorName = Literal[
"get_resources",
]GetRestApisPaginatorName#
# GetRestApisPaginatorName usage example
from mypy_boto3_apigateway.literals import GetRestApisPaginatorName
def get_value() -> GetRestApisPaginatorName:
return "get_rest_apis"# GetRestApisPaginatorName definition
GetRestApisPaginatorName = Literal[
"get_rest_apis",
]GetSdkTypesPaginatorName#
# GetSdkTypesPaginatorName usage example
from mypy_boto3_apigateway.literals import GetSdkTypesPaginatorName
def get_value() -> GetSdkTypesPaginatorName:
return "get_sdk_types"# GetSdkTypesPaginatorName definition
GetSdkTypesPaginatorName = Literal[
"get_sdk_types",
]GetUsagePaginatorName#
# GetUsagePaginatorName usage example
from mypy_boto3_apigateway.literals import GetUsagePaginatorName
def get_value() -> GetUsagePaginatorName:
return "get_usage"# GetUsagePaginatorName definition
GetUsagePaginatorName = Literal[
"get_usage",
]GetUsagePlanKeysPaginatorName#
# GetUsagePlanKeysPaginatorName usage example
from mypy_boto3_apigateway.literals import GetUsagePlanKeysPaginatorName
def get_value() -> GetUsagePlanKeysPaginatorName:
return "get_usage_plan_keys"# GetUsagePlanKeysPaginatorName definition
GetUsagePlanKeysPaginatorName = Literal[
"get_usage_plan_keys",
]GetUsagePlansPaginatorName#
# GetUsagePlansPaginatorName usage example
from mypy_boto3_apigateway.literals import GetUsagePlansPaginatorName
def get_value() -> GetUsagePlansPaginatorName:
return "get_usage_plans"# GetUsagePlansPaginatorName definition
GetUsagePlansPaginatorName = Literal[
"get_usage_plans",
]GetVpcLinksPaginatorName#
# GetVpcLinksPaginatorName usage example
from mypy_boto3_apigateway.literals import GetVpcLinksPaginatorName
def get_value() -> GetVpcLinksPaginatorName:
return "get_vpc_links"# GetVpcLinksPaginatorName definition
GetVpcLinksPaginatorName = Literal[
"get_vpc_links",
]IntegrationTypeType#
# IntegrationTypeType usage example
from mypy_boto3_apigateway.literals import IntegrationTypeType
def get_value() -> IntegrationTypeType:
return "AWS"# IntegrationTypeType definition
IntegrationTypeType = Literal[
"AWS",
"AWS_PROXY",
"HTTP",
"HTTP_PROXY",
"MOCK",
]LocationStatusTypeType#
# LocationStatusTypeType usage example
from mypy_boto3_apigateway.literals import LocationStatusTypeType
def get_value() -> LocationStatusTypeType:
return "DOCUMENTED"# LocationStatusTypeType definition
LocationStatusTypeType = Literal[
"DOCUMENTED",
"UNDOCUMENTED",
]OpType#
# OpType usage example
from mypy_boto3_apigateway.literals import OpType
def get_value() -> OpType:
return "add"# OpType definition
OpType = Literal[
"add",
"copy",
"move",
"remove",
"replace",
"test",
]PutModeType#
# PutModeType usage example
from mypy_boto3_apigateway.literals import PutModeType
def get_value() -> PutModeType:
return "merge"# PutModeType definition
PutModeType = Literal[
"merge",
"overwrite",
]QuotaPeriodTypeType#
# QuotaPeriodTypeType usage example
from mypy_boto3_apigateway.literals import QuotaPeriodTypeType
def get_value() -> QuotaPeriodTypeType:
return "DAY"# QuotaPeriodTypeType definition
QuotaPeriodTypeType = Literal[
"DAY",
"MONTH",
"WEEK",
]SecurityPolicyType#
# SecurityPolicyType usage example
from mypy_boto3_apigateway.literals import SecurityPolicyType
def get_value() -> SecurityPolicyType:
return "TLS_1_0"# SecurityPolicyType definition
SecurityPolicyType = Literal[
"TLS_1_0",
"TLS_1_2",
]UnauthorizedCacheControlHeaderStrategyType#
# UnauthorizedCacheControlHeaderStrategyType usage example
from mypy_boto3_apigateway.literals import UnauthorizedCacheControlHeaderStrategyType
def get_value() -> UnauthorizedCacheControlHeaderStrategyType:
return "FAIL_WITH_403"# UnauthorizedCacheControlHeaderStrategyType definition
UnauthorizedCacheControlHeaderStrategyType = Literal[
"FAIL_WITH_403",
"SUCCEED_WITH_RESPONSE_HEADER",
"SUCCEED_WITHOUT_RESPONSE_HEADER",
]VpcLinkStatusType#
# VpcLinkStatusType usage example
from mypy_boto3_apigateway.literals import VpcLinkStatusType
def get_value() -> VpcLinkStatusType:
return "AVAILABLE"# VpcLinkStatusType definition
VpcLinkStatusType = Literal[
"AVAILABLE",
"DELETING",
"FAILED",
"PENDING",
]APIGatewayServiceName#
# APIGatewayServiceName usage example
from mypy_boto3_apigateway.literals import APIGatewayServiceName
def get_value() -> APIGatewayServiceName:
return "apigateway"# APIGatewayServiceName definition
APIGatewayServiceName = Literal[
"apigateway",
]ServiceName#
# ServiceName usage example
from mypy_boto3_apigateway.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_apigateway.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_apigateway.literals import PaginatorName
def get_value() -> PaginatorName:
return "get_api_keys"# PaginatorName definition
PaginatorName = Literal[
"get_api_keys",
"get_authorizers",
"get_base_path_mappings",
"get_client_certificates",
"get_deployments",
"get_documentation_parts",
"get_documentation_versions",
"get_domain_names",
"get_gateway_responses",
"get_models",
"get_request_validators",
"get_resources",
"get_rest_apis",
"get_sdk_types",
"get_usage",
"get_usage_plan_keys",
"get_usage_plans",
"get_vpc_links",
]RegionName#
# RegionName usage example
from mypy_boto3_apigateway.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",
]