Skip to content

Literals#

Index > ApiGatewayV2 > Literals

Auto-generated documentation for ApiGatewayV2 type annotations stubs module mypy-boto3-apigatewayv2.

AuthorizationTypeType#

# AuthorizationTypeType usage example

from mypy_boto3_apigatewayv2.literals import AuthorizationTypeType

def get_value() -> AuthorizationTypeType:
    return "AWS_IAM"
# AuthorizationTypeType definition

AuthorizationTypeType = Literal[
    "AWS_IAM",
    "CUSTOM",
    "JWT",
    "NONE",
]

AuthorizerTypeType#

# AuthorizerTypeType usage example

from mypy_boto3_apigatewayv2.literals import AuthorizerTypeType

def get_value() -> AuthorizerTypeType:
    return "JWT"
# AuthorizerTypeType definition

AuthorizerTypeType = Literal[
    "JWT",
    "REQUEST",
]

ConnectionTypeType#

# ConnectionTypeType usage example

from mypy_boto3_apigatewayv2.literals import ConnectionTypeType

def get_value() -> ConnectionTypeType:
    return "INTERNET"
# ConnectionTypeType definition

ConnectionTypeType = Literal[
    "INTERNET",
    "VPC_LINK",
]

ContentHandlingStrategyType#

# ContentHandlingStrategyType usage example

from mypy_boto3_apigatewayv2.literals import ContentHandlingStrategyType

def get_value() -> ContentHandlingStrategyType:
    return "CONVERT_TO_BINARY"
# ContentHandlingStrategyType definition

ContentHandlingStrategyType = Literal[
    "CONVERT_TO_BINARY",
    "CONVERT_TO_TEXT",
]

DeploymentStatusType#

# DeploymentStatusType usage example

from mypy_boto3_apigatewayv2.literals import DeploymentStatusType

def get_value() -> DeploymentStatusType:
    return "DEPLOYED"
# DeploymentStatusType definition

DeploymentStatusType = Literal[
    "DEPLOYED",
    "FAILED",
    "PENDING",
]

DomainNameStatusType#

# DomainNameStatusType usage example

from mypy_boto3_apigatewayv2.literals import DomainNameStatusType

def get_value() -> DomainNameStatusType:
    return "AVAILABLE"
# DomainNameStatusType definition

DomainNameStatusType = Literal[
    "AVAILABLE",
    "PENDING_CERTIFICATE_REIMPORT",
    "PENDING_OWNERSHIP_VERIFICATION",
    "UPDATING",
]

EndpointTypeType#

# EndpointTypeType usage example

from mypy_boto3_apigatewayv2.literals import EndpointTypeType

def get_value() -> EndpointTypeType:
    return "EDGE"
# EndpointTypeType definition

EndpointTypeType = Literal[
    "EDGE",
    "REGIONAL",
]

GetApisPaginatorName#

# GetApisPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetApisPaginatorName

def get_value() -> GetApisPaginatorName:
    return "get_apis"
# GetApisPaginatorName definition

GetApisPaginatorName = Literal[
    "get_apis",
]

GetAuthorizersPaginatorName#

# GetAuthorizersPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetAuthorizersPaginatorName

def get_value() -> GetAuthorizersPaginatorName:
    return "get_authorizers"
# GetAuthorizersPaginatorName definition

GetAuthorizersPaginatorName = Literal[
    "get_authorizers",
]

GetDeploymentsPaginatorName#

# GetDeploymentsPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetDeploymentsPaginatorName

def get_value() -> GetDeploymentsPaginatorName:
    return "get_deployments"
# GetDeploymentsPaginatorName definition

GetDeploymentsPaginatorName = Literal[
    "get_deployments",
]

GetDomainNamesPaginatorName#

# GetDomainNamesPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetDomainNamesPaginatorName

def get_value() -> GetDomainNamesPaginatorName:
    return "get_domain_names"
# GetDomainNamesPaginatorName definition

GetDomainNamesPaginatorName = Literal[
    "get_domain_names",
]

GetIntegrationResponsesPaginatorName#

# GetIntegrationResponsesPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetIntegrationResponsesPaginatorName

def get_value() -> GetIntegrationResponsesPaginatorName:
    return "get_integration_responses"
# GetIntegrationResponsesPaginatorName definition

GetIntegrationResponsesPaginatorName = Literal[
    "get_integration_responses",
]

GetIntegrationsPaginatorName#

# GetIntegrationsPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetIntegrationsPaginatorName

def get_value() -> GetIntegrationsPaginatorName:
    return "get_integrations"
# GetIntegrationsPaginatorName definition

GetIntegrationsPaginatorName = Literal[
    "get_integrations",
]

GetModelsPaginatorName#

# GetModelsPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetModelsPaginatorName

def get_value() -> GetModelsPaginatorName:
    return "get_models"
# GetModelsPaginatorName definition

GetModelsPaginatorName = Literal[
    "get_models",
]

GetRouteResponsesPaginatorName#

# GetRouteResponsesPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetRouteResponsesPaginatorName

def get_value() -> GetRouteResponsesPaginatorName:
    return "get_route_responses"
# GetRouteResponsesPaginatorName definition

GetRouteResponsesPaginatorName = Literal[
    "get_route_responses",
]

GetRoutesPaginatorName#

# GetRoutesPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetRoutesPaginatorName

def get_value() -> GetRoutesPaginatorName:
    return "get_routes"
# GetRoutesPaginatorName definition

GetRoutesPaginatorName = Literal[
    "get_routes",
]

GetStagesPaginatorName#

# GetStagesPaginatorName usage example

from mypy_boto3_apigatewayv2.literals import GetStagesPaginatorName

def get_value() -> GetStagesPaginatorName:
    return "get_stages"
# GetStagesPaginatorName definition

GetStagesPaginatorName = Literal[
    "get_stages",
]

IntegrationTypeType#

# IntegrationTypeType usage example

from mypy_boto3_apigatewayv2.literals import IntegrationTypeType

def get_value() -> IntegrationTypeType:
    return "AWS"
# IntegrationTypeType definition

IntegrationTypeType = Literal[
    "AWS",
    "AWS_PROXY",
    "HTTP",
    "HTTP_PROXY",
    "MOCK",
]

JSONYAMLType#

# JSONYAMLType usage example

from mypy_boto3_apigatewayv2.literals import JSONYAMLType

def get_value() -> JSONYAMLType:
    return "JSON"
# JSONYAMLType definition

JSONYAMLType = Literal[
    "JSON",
    "YAML",
]

LoggingLevelType#

# LoggingLevelType usage example

from mypy_boto3_apigatewayv2.literals import LoggingLevelType

def get_value() -> LoggingLevelType:
    return "ERROR"
# LoggingLevelType definition

LoggingLevelType = Literal[
    "ERROR",
    "INFO",
    "OFF",
]

OAS30Type#

# OAS30Type usage example

from mypy_boto3_apigatewayv2.literals import OAS30Type

def get_value() -> OAS30Type:
    return "OAS30"
# OAS30Type definition

OAS30Type = Literal[
    "OAS30",
]

PassthroughBehaviorType#

# PassthroughBehaviorType usage example

from mypy_boto3_apigatewayv2.literals import PassthroughBehaviorType

def get_value() -> PassthroughBehaviorType:
    return "NEVER"
# PassthroughBehaviorType definition

PassthroughBehaviorType = Literal[
    "NEVER",
    "WHEN_NO_MATCH",
    "WHEN_NO_TEMPLATES",
]

ProtocolTypeType#

# ProtocolTypeType usage example

from mypy_boto3_apigatewayv2.literals import ProtocolTypeType

def get_value() -> ProtocolTypeType:
    return "HTTP"
# ProtocolTypeType definition

ProtocolTypeType = Literal[
    "HTTP",
    "WEBSOCKET",
]

SecurityPolicyType#

# SecurityPolicyType usage example

from mypy_boto3_apigatewayv2.literals import SecurityPolicyType

def get_value() -> SecurityPolicyType:
    return "TLS_1_0"
# SecurityPolicyType definition

SecurityPolicyType = Literal[
    "TLS_1_0",
    "TLS_1_2",
]

VpcLinkStatusType#

# VpcLinkStatusType usage example

from mypy_boto3_apigatewayv2.literals import VpcLinkStatusType

def get_value() -> VpcLinkStatusType:
    return "AVAILABLE"
# VpcLinkStatusType definition

VpcLinkStatusType = Literal[
    "AVAILABLE",
    "DELETING",
    "FAILED",
    "INACTIVE",
    "PENDING",
]

VpcLinkVersionType#

# VpcLinkVersionType usage example

from mypy_boto3_apigatewayv2.literals import VpcLinkVersionType

def get_value() -> VpcLinkVersionType:
    return "V2"
# VpcLinkVersionType definition

VpcLinkVersionType = Literal[
    "V2",
]

ApiGatewayV2ServiceName#

# ApiGatewayV2ServiceName usage example

from mypy_boto3_apigatewayv2.literals import ApiGatewayV2ServiceName

def get_value() -> ApiGatewayV2ServiceName:
    return "apigatewayv2"
# ApiGatewayV2ServiceName definition

ApiGatewayV2ServiceName = Literal[
    "apigatewayv2",
]

ServiceName#

# ServiceName usage example

from mypy_boto3_apigatewayv2.literals import ServiceName

def get_value() -> ServiceName:
    return "accessanalyzer"
# ServiceName definition

ServiceName = Literal[
    "accessanalyzer",
    "account",
    "acm",
    "acm-pca",
    "alexaforbusiness",
    "amp",
    "amplify",
    "amplifybackend",
    "amplifyuibuilder",
    "apigateway",
    "apigatewaymanagementapi",
    "apigatewayv2",
    "appconfig",
    "appconfigdata",
    "appfabric",
    "appflow",
    "appintegrations",
    "application-autoscaling",
    "application-insights",
    "applicationcostprofiler",
    "appmesh",
    "apprunner",
    "appstream",
    "appsync",
    "arc-zonal-shift",
    "artifact",
    "athena",
    "auditmanager",
    "autoscaling",
    "autoscaling-plans",
    "b2bi",
    "backup",
    "backup-gateway",
    "backupstorage",
    "batch",
    "bcm-data-exports",
    "bedrock",
    "bedrock-agent",
    "bedrock-agent-runtime",
    "bedrock-runtime",
    "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",
    "codedeploy",
    "codeguru-reviewer",
    "codeguru-security",
    "codeguruprofiler",
    "codepipeline",
    "codestar",
    "codestar-connections",
    "codestar-notifications",
    "cognito-identity",
    "cognito-idp",
    "cognito-sync",
    "comprehend",
    "comprehendmedical",
    "compute-optimizer",
    "config",
    "connect",
    "connect-contact-lens",
    "connectcampaigns",
    "connectcases",
    "connectparticipant",
    "controltower",
    "cost-optimization-hub",
    "cur",
    "customer-profiles",
    "databrew",
    "dataexchange",
    "datapipeline",
    "datasync",
    "datazone",
    "dax",
    "detective",
    "devicefarm",
    "devops-guru",
    "directconnect",
    "discovery",
    "dlm",
    "dms",
    "docdb",
    "docdb-elastic",
    "drs",
    "ds",
    "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",
    "glacier",
    "globalaccelerator",
    "glue",
    "grafana",
    "greengrass",
    "greengrassv2",
    "groundstation",
    "guardduty",
    "health",
    "healthlake",
    "honeycode",
    "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",
    "managedblockchain",
    "managedblockchain-query",
    "marketplace-agreement",
    "marketplace-catalog",
    "marketplace-deployment",
    "marketplace-entitlement",
    "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",
    "mobile",
    "mq",
    "mturk",
    "mwaa",
    "neptune",
    "neptune-graph",
    "neptunedata",
    "network-firewall",
    "networkmanager",
    "networkmonitor",
    "nimble",
    "oam",
    "omics",
    "opensearch",
    "opensearchserverless",
    "opsworks",
    "opsworkscm",
    "organizations",
    "osis",
    "outposts",
    "panorama",
    "payment-cryptography",
    "payment-cryptography-data",
    "pca-connector-ad",
    "personalize",
    "personalize-events",
    "personalize-runtime",
    "pi",
    "pinpoint",
    "pinpoint-email",
    "pinpoint-sms-voice",
    "pinpoint-sms-voice-v2",
    "pipes",
    "polly",
    "pricing",
    "privatenetworks",
    "proton",
    "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",
    "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",
    "sqs",
    "ssm",
    "ssm-contacts",
    "ssm-incidents",
    "ssm-sap",
    "sso",
    "sso-admin",
    "sso-oidc",
    "stepfunctions",
    "storagegateway",
    "sts",
    "supplychain",
    "support",
    "support-app",
    "swf",
    "synthetics",
    "textract",
    "timestream-influxdb",
    "timestream-query",
    "timestream-write",
    "tnb",
    "transcribe",
    "transfer",
    "translate",
    "trustedadvisor",
    "verifiedpermissions",
    "voice-id",
    "vpc-lattice",
    "waf",
    "waf-regional",
    "wafv2",
    "wellarchitected",
    "wisdom",
    "workdocs",
    "worklink",
    "workmail",
    "workmailmessageflow",
    "workspaces",
    "workspaces-thin-client",
    "workspaces-web",
    "xray",
]

ResourceServiceName#

# ResourceServiceName usage example

from mypy_boto3_apigatewayv2.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_apigatewayv2.literals import PaginatorName

def get_value() -> PaginatorName:
    return "get_apis"
# PaginatorName definition

PaginatorName = Literal[
    "get_apis",
    "get_authorizers",
    "get_deployments",
    "get_domain_names",
    "get_integration_responses",
    "get_integrations",
    "get_models",
    "get_route_responses",
    "get_routes",
    "get_stages",
]

RegionName#

# RegionName usage example

from mypy_boto3_apigatewayv2.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",
    "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",
]