Skip to content

Literals

Index > APIGateway > Literals

Auto-generated documentation for APIGateway type annotations stubs module mypy-boto3-apigateway.

ApiKeySourceTypeType

Usage Example
from mypy_boto3_apigateway.literals import ApiKeySourceTypeType

def get_value() -> ApiKeySourceTypeType:
    return "AUTHORIZER"
Definition
ApiKeySourceTypeType = Literal[
    "AUTHORIZER",
    "HEADER",
]

ApiKeysFormatType

Usage Example
from mypy_boto3_apigateway.literals import ApiKeysFormatType

def get_value() -> ApiKeysFormatType:
    return "csv"
Definition
ApiKeysFormatType = Literal[
    "csv",
]

AuthorizerTypeType

Usage Example
from mypy_boto3_apigateway.literals import AuthorizerTypeType

def get_value() -> AuthorizerTypeType:
    return "COGNITO_USER_POOLS"
Definition
AuthorizerTypeType = Literal[
    "COGNITO_USER_POOLS",
    "REQUEST",
    "TOKEN",
]

CacheClusterSizeType

Usage Example
from mypy_boto3_apigateway.literals import CacheClusterSizeType

def get_value() -> CacheClusterSizeType:
    return "0.5"
Definition
CacheClusterSizeType = Literal[
    "0.5",
    "1.6",
    "118",
    "13.5",
    "237",
    "28.4",
    "58.2",
    "6.1",
]

CacheClusterStatusType

Usage Example
from mypy_boto3_apigateway.literals import CacheClusterStatusType

def get_value() -> CacheClusterStatusType:
    return "AVAILABLE"
Definition
CacheClusterStatusType = Literal[
    "AVAILABLE",
    "CREATE_IN_PROGRESS",
    "DELETE_IN_PROGRESS",
    "FLUSH_IN_PROGRESS",
    "NOT_AVAILABLE",
]

ConnectionTypeType

Usage Example
from mypy_boto3_apigateway.literals import ConnectionTypeType

def get_value() -> ConnectionTypeType:
    return "INTERNET"
Definition
ConnectionTypeType = Literal[
    "INTERNET",
    "VPC_LINK",
]

ContentHandlingStrategyType

Usage Example
from mypy_boto3_apigateway.literals import ContentHandlingStrategyType

def get_value() -> ContentHandlingStrategyType:
    return "CONVERT_TO_BINARY"
Definition
ContentHandlingStrategyType = Literal[
    "CONVERT_TO_BINARY",
    "CONVERT_TO_TEXT",
]

DocumentationPartTypeType

Usage Example
from mypy_boto3_apigateway.literals import DocumentationPartTypeType

def get_value() -> DocumentationPartTypeType:
    return "API"
Definition
DocumentationPartTypeType = Literal[
    "API",
    "AUTHORIZER",
    "METHOD",
    "MODEL",
    "PATH_PARAMETER",
    "QUERY_PARAMETER",
    "REQUEST_BODY",
    "REQUEST_HEADER",
    "RESOURCE",
    "RESPONSE",
    "RESPONSE_BODY",
    "RESPONSE_HEADER",
]

DomainNameStatusType

Usage Example
from mypy_boto3_apigateway.literals import DomainNameStatusType

def get_value() -> DomainNameStatusType:
    return "AVAILABLE"
Definition
DomainNameStatusType = Literal[
    "AVAILABLE",
    "PENDING",
    "PENDING_CERTIFICATE_REIMPORT",
    "PENDING_OWNERSHIP_VERIFICATION",
    "UPDATING",
]

EndpointTypeType

Usage Example
from mypy_boto3_apigateway.literals import EndpointTypeType

def get_value() -> EndpointTypeType:
    return "EDGE"
Definition
EndpointTypeType = Literal[
    "EDGE",
    "PRIVATE",
    "REGIONAL",
]

GatewayResponseTypeType

Usage Example
from mypy_boto3_apigateway.literals import GatewayResponseTypeType

def get_value() -> GatewayResponseTypeType:
    return "ACCESS_DENIED"
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

Usage Example
from mypy_boto3_apigateway.literals import GetApiKeysPaginatorName

def get_value() -> GetApiKeysPaginatorName:
    return "get_api_keys"
Definition
GetApiKeysPaginatorName = Literal[
    "get_api_keys",
]

GetAuthorizersPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetAuthorizersPaginatorName

def get_value() -> GetAuthorizersPaginatorName:
    return "get_authorizers"
Definition
GetAuthorizersPaginatorName = Literal[
    "get_authorizers",
]

GetBasePathMappingsPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetBasePathMappingsPaginatorName

def get_value() -> GetBasePathMappingsPaginatorName:
    return "get_base_path_mappings"
Definition
GetBasePathMappingsPaginatorName = Literal[
    "get_base_path_mappings",
]

GetClientCertificatesPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetClientCertificatesPaginatorName

def get_value() -> GetClientCertificatesPaginatorName:
    return "get_client_certificates"
Definition
GetClientCertificatesPaginatorName = Literal[
    "get_client_certificates",
]

GetDeploymentsPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetDeploymentsPaginatorName

def get_value() -> GetDeploymentsPaginatorName:
    return "get_deployments"
Definition
GetDeploymentsPaginatorName = Literal[
    "get_deployments",
]

GetDocumentationPartsPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetDocumentationPartsPaginatorName

def get_value() -> GetDocumentationPartsPaginatorName:
    return "get_documentation_parts"
Definition
GetDocumentationPartsPaginatorName = Literal[
    "get_documentation_parts",
]

GetDocumentationVersionsPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetDocumentationVersionsPaginatorName

def get_value() -> GetDocumentationVersionsPaginatorName:
    return "get_documentation_versions"
Definition
GetDocumentationVersionsPaginatorName = Literal[
    "get_documentation_versions",
]

GetDomainNamesPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetDomainNamesPaginatorName

def get_value() -> GetDomainNamesPaginatorName:
    return "get_domain_names"
Definition
GetDomainNamesPaginatorName = Literal[
    "get_domain_names",
]

GetGatewayResponsesPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetGatewayResponsesPaginatorName

def get_value() -> GetGatewayResponsesPaginatorName:
    return "get_gateway_responses"
Definition
GetGatewayResponsesPaginatorName = Literal[
    "get_gateway_responses",
]

GetModelsPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetModelsPaginatorName

def get_value() -> GetModelsPaginatorName:
    return "get_models"
Definition
GetModelsPaginatorName = Literal[
    "get_models",
]

GetRequestValidatorsPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetRequestValidatorsPaginatorName

def get_value() -> GetRequestValidatorsPaginatorName:
    return "get_request_validators"
Definition
GetRequestValidatorsPaginatorName = Literal[
    "get_request_validators",
]

GetResourcesPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetResourcesPaginatorName

def get_value() -> GetResourcesPaginatorName:
    return "get_resources"
Definition
GetResourcesPaginatorName = Literal[
    "get_resources",
]

GetRestApisPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetRestApisPaginatorName

def get_value() -> GetRestApisPaginatorName:
    return "get_rest_apis"
Definition
GetRestApisPaginatorName = Literal[
    "get_rest_apis",
]

GetSdkTypesPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetSdkTypesPaginatorName

def get_value() -> GetSdkTypesPaginatorName:
    return "get_sdk_types"
Definition
GetSdkTypesPaginatorName = Literal[
    "get_sdk_types",
]

GetUsagePaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetUsagePaginatorName

def get_value() -> GetUsagePaginatorName:
    return "get_usage"
Definition
GetUsagePaginatorName = Literal[
    "get_usage",
]

GetUsagePlanKeysPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetUsagePlanKeysPaginatorName

def get_value() -> GetUsagePlanKeysPaginatorName:
    return "get_usage_plan_keys"
Definition
GetUsagePlanKeysPaginatorName = Literal[
    "get_usage_plan_keys",
]

GetUsagePlansPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetUsagePlansPaginatorName

def get_value() -> GetUsagePlansPaginatorName:
    return "get_usage_plans"
Definition
GetUsagePlansPaginatorName = Literal[
    "get_usage_plans",
]

GetVpcLinksPaginatorName

Usage Example
from mypy_boto3_apigateway.literals import GetVpcLinksPaginatorName

def get_value() -> GetVpcLinksPaginatorName:
    return "get_vpc_links"
Definition
GetVpcLinksPaginatorName = Literal[
    "get_vpc_links",
]

IntegrationTypeType

Usage Example
from mypy_boto3_apigateway.literals import IntegrationTypeType

def get_value() -> IntegrationTypeType:
    return "AWS"
Definition
IntegrationTypeType = Literal[
    "AWS",
    "AWS_PROXY",
    "HTTP",
    "HTTP_PROXY",
    "MOCK",
]

LocationStatusTypeType

Usage Example
from mypy_boto3_apigateway.literals import LocationStatusTypeType

def get_value() -> LocationStatusTypeType:
    return "DOCUMENTED"
Definition
LocationStatusTypeType = Literal[
    "DOCUMENTED",
    "UNDOCUMENTED",
]

OpType

Usage Example
from mypy_boto3_apigateway.literals import OpType

def get_value() -> OpType:
    return "add"
Definition
OpType = Literal[
    "add",
    "copy",
    "move",
    "remove",
    "replace",
    "test",
]

PutModeType

Usage Example
from mypy_boto3_apigateway.literals import PutModeType

def get_value() -> PutModeType:
    return "merge"
Definition
PutModeType = Literal[
    "merge",
    "overwrite",
]

QuotaPeriodTypeType

Usage Example
from mypy_boto3_apigateway.literals import QuotaPeriodTypeType

def get_value() -> QuotaPeriodTypeType:
    return "DAY"
Definition
QuotaPeriodTypeType = Literal[
    "DAY",
    "MONTH",
    "WEEK",
]

SecurityPolicyType

Usage Example
from mypy_boto3_apigateway.literals import SecurityPolicyType

def get_value() -> SecurityPolicyType:
    return "TLS_1_0"
Definition
SecurityPolicyType = Literal[
    "TLS_1_0",
    "TLS_1_2",
]

UnauthorizedCacheControlHeaderStrategyType

Usage Example
from mypy_boto3_apigateway.literals import UnauthorizedCacheControlHeaderStrategyType

def get_value() -> UnauthorizedCacheControlHeaderStrategyType:
    return "FAIL_WITH_403"
Definition
UnauthorizedCacheControlHeaderStrategyType = Literal[
    "FAIL_WITH_403",
    "SUCCEED_WITH_RESPONSE_HEADER",
    "SUCCEED_WITHOUT_RESPONSE_HEADER",
]

VpcLinkStatusType

Usage Example
from mypy_boto3_apigateway.literals import VpcLinkStatusType

def get_value() -> VpcLinkStatusType:
    return "AVAILABLE"
Definition
VpcLinkStatusType = Literal[
    "AVAILABLE",
    "DELETING",
    "FAILED",
    "PENDING",
]

APIGatewayServiceName

Usage Example
from mypy_boto3_apigateway.literals import APIGatewayServiceName

def get_value() -> APIGatewayServiceName:
    return "apigateway"
Definition
APIGatewayServiceName = Literal[
    "apigateway",
]

ServiceName

Usage Example
from mypy_boto3_apigateway.literals import ServiceName

def get_value() -> ServiceName:
    return "accessanalyzer"
Definition
ServiceName = Literal[
    "accessanalyzer",
    "account",
    "acm",
    "acm-pca",
    "alexaforbusiness",
    "amp",
    "amplify",
    "amplifybackend",
    "amplifyuibuilder",
    "apigateway",
    "apigatewaymanagementapi",
    "apigatewayv2",
    "appconfig",
    "appconfigdata",
    "appflow",
    "appintegrations",
    "application-autoscaling",
    "application-insights",
    "applicationcostprofiler",
    "appmesh",
    "apprunner",
    "appstream",
    "appsync",
    "athena",
    "auditmanager",
    "autoscaling",
    "autoscaling-plans",
    "backup",
    "backup-gateway",
    "backupstorage",
    "batch",
    "billingconductor",
    "braket",
    "budgets",
    "ce",
    "chime",
    "chime-sdk-identity",
    "chime-sdk-media-pipelines",
    "chime-sdk-meetings",
    "chime-sdk-messaging",
    "cloud9",
    "cloudcontrol",
    "clouddirectory",
    "cloudformation",
    "cloudfront",
    "cloudhsm",
    "cloudhsmv2",
    "cloudsearch",
    "cloudsearchdomain",
    "cloudtrail",
    "cloudwatch",
    "codeartifact",
    "codebuild",
    "codecommit",
    "codedeploy",
    "codeguru-reviewer",
    "codeguruprofiler",
    "codepipeline",
    "codestar",
    "codestar-connections",
    "codestar-notifications",
    "cognito-identity",
    "cognito-idp",
    "cognito-sync",
    "comprehend",
    "comprehendmedical",
    "compute-optimizer",
    "config",
    "connect",
    "connect-contact-lens",
    "connectcampaigns",
    "connectparticipant",
    "controltower",
    "cur",
    "customer-profiles",
    "databrew",
    "dataexchange",
    "datapipeline",
    "datasync",
    "dax",
    "detective",
    "devicefarm",
    "devops-guru",
    "directconnect",
    "discovery",
    "dlm",
    "dms",
    "docdb",
    "drs",
    "ds",
    "dynamodb",
    "dynamodbstreams",
    "ebs",
    "ec2",
    "ec2-instance-connect",
    "ecr",
    "ecr-public",
    "ecs",
    "efs",
    "eks",
    "elastic-inference",
    "elasticache",
    "elasticbeanstalk",
    "elastictranscoder",
    "elb",
    "elbv2",
    "emr",
    "emr-containers",
    "emr-serverless",
    "es",
    "events",
    "evidently",
    "finspace",
    "finspace-data",
    "firehose",
    "fis",
    "fms",
    "forecast",
    "forecastquery",
    "frauddetector",
    "fsx",
    "gamelift",
    "gamesparks",
    "glacier",
    "globalaccelerator",
    "glue",
    "grafana",
    "greengrass",
    "greengrassv2",
    "groundstation",
    "guardduty",
    "health",
    "healthlake",
    "honeycode",
    "iam",
    "identitystore",
    "imagebuilder",
    "importexport",
    "inspector",
    "inspector2",
    "iot",
    "iot-data",
    "iot-jobs-data",
    "iot1click-devices",
    "iot1click-projects",
    "iotanalytics",
    "iotdeviceadvisor",
    "iotevents",
    "iotevents-data",
    "iotfleethub",
    "iotfleetwise",
    "iotsecuretunneling",
    "iotsitewise",
    "iotthingsgraph",
    "iottwinmaker",
    "iotwireless",
    "ivs",
    "ivschat",
    "kafka",
    "kafkaconnect",
    "kendra",
    "keyspaces",
    "kinesis",
    "kinesis-video-archived-media",
    "kinesis-video-media",
    "kinesis-video-signaling",
    "kinesisanalytics",
    "kinesisanalyticsv2",
    "kinesisvideo",
    "kms",
    "lakeformation",
    "lambda",
    "lex-models",
    "lex-runtime",
    "lexv2-models",
    "lexv2-runtime",
    "license-manager",
    "license-manager-user-subscriptions",
    "lightsail",
    "location",
    "logs",
    "lookoutequipment",
    "lookoutmetrics",
    "lookoutvision",
    "m2",
    "machinelearning",
    "macie",
    "macie2",
    "managedblockchain",
    "marketplace-catalog",
    "marketplace-entitlement",
    "marketplacecommerceanalytics",
    "mediaconnect",
    "mediaconvert",
    "medialive",
    "mediapackage",
    "mediapackage-vod",
    "mediastore",
    "mediastore-data",
    "mediatailor",
    "memorydb",
    "meteringmarketplace",
    "mgh",
    "mgn",
    "migration-hub-refactor-spaces",
    "migrationhub-config",
    "migrationhubstrategy",
    "mobile",
    "mq",
    "mturk",
    "mwaa",
    "neptune",
    "network-firewall",
    "networkmanager",
    "nimble",
    "opensearch",
    "opsworks",
    "opsworkscm",
    "organizations",
    "outposts",
    "panorama",
    "personalize",
    "personalize-events",
    "personalize-runtime",
    "pi",
    "pinpoint",
    "pinpoint-email",
    "pinpoint-sms-voice",
    "pinpoint-sms-voice-v2",
    "polly",
    "pricing",
    "privatenetworks",
    "proton",
    "qldb",
    "qldb-session",
    "quicksight",
    "ram",
    "rbin",
    "rds",
    "rds-data",
    "redshift",
    "redshift-data",
    "redshift-serverless",
    "rekognition",
    "resiliencehub",
    "resource-groups",
    "resourcegroupstaggingapi",
    "robomaker",
    "rolesanywhere",
    "route53",
    "route53-recovery-cluster",
    "route53-recovery-control-config",
    "route53-recovery-readiness",
    "route53domains",
    "route53resolver",
    "rum",
    "s3",
    "s3control",
    "s3outposts",
    "sagemaker",
    "sagemaker-a2i-runtime",
    "sagemaker-edge",
    "sagemaker-featurestore-runtime",
    "sagemaker-runtime",
    "savingsplans",
    "schemas",
    "sdb",
    "secretsmanager",
    "securityhub",
    "serverlessrepo",
    "service-quotas",
    "servicecatalog",
    "servicecatalog-appregistry",
    "servicediscovery",
    "ses",
    "sesv2",
    "shield",
    "signer",
    "sms",
    "sms-voice",
    "snow-device-management",
    "snowball",
    "sns",
    "sqs",
    "ssm",
    "ssm-contacts",
    "ssm-incidents",
    "sso",
    "sso-admin",
    "sso-oidc",
    "stepfunctions",
    "storagegateway",
    "sts",
    "support",
    "support-app",
    "swf",
    "synthetics",
    "textract",
    "timestream-query",
    "timestream-write",
    "transcribe",
    "transfer",
    "translate",
    "voice-id",
    "waf",
    "waf-regional",
    "wafv2",
    "wellarchitected",
    "wisdom",
    "workdocs",
    "worklink",
    "workmail",
    "workmailmessageflow",
    "workspaces",
    "workspaces-web",
    "xray",
]

ResourceServiceName

Usage Example
from mypy_boto3_apigateway.literals import ResourceServiceName

def get_value() -> ResourceServiceName:
    return "cloudformation"
Definition
ResourceServiceName = Literal[
    "cloudformation",
    "cloudwatch",
    "dynamodb",
    "ec2",
    "glacier",
    "iam",
    "opsworks",
    "s3",
    "sns",
    "sqs",
]

PaginatorName

Usage Example
from mypy_boto3_apigateway.literals import PaginatorName

def get_value() -> PaginatorName:
    return "get_api_keys"
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

Usage Example
from mypy_boto3_apigateway.literals import RegionName

def get_value() -> RegionName:
    return "af-south-1"
Definition
RegionName = Literal[
    "af-south-1",
    "ap-east-1",
    "ap-northeast-1",
    "ap-northeast-2",
    "ap-northeast-3",
    "ap-south-1",
    "ap-southeast-1",
    "ap-southeast-2",
    "ap-southeast-3",
    "ca-central-1",
    "eu-central-1",
    "eu-north-1",
    "eu-south-1",
    "eu-west-1",
    "eu-west-2",
    "eu-west-3",
    "me-central-1",
    "me-south-1",
    "sa-east-1",
    "us-east-1",
    "us-east-2",
    "us-west-1",
    "us-west-2",
]