ApiGatewayV2 module
Index > ApiGatewayV2
Auto-generated documentation for ApiGatewayV2 type annotations stubs module mypy-boto3-apigatewayv2.
How to install
VSCode extension
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and ApiGatewayV2
.
From PyPI with pip
Install boto3-stubs
for ApiGatewayV2
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[apigatewayv2]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[apigatewayv2]'
# standalone installation
python -m pip install mypy-boto3-apigatewayv2
How to uninstall
Usage
Code samples can be found in Examples.
ApiGatewayV2Client
Type annotations and code completion for boto3.client("apigatewayv2")
as ApiGatewayV2Client
boto3 documentation
Usage example
from boto3.session import Session
from mypy_boto3_apigatewayv2.client import ApiGatewayV2Client
def get_client() -> ApiGatewayV2Client:
return Session().client("apigatewayv2")
Paginators
Type annotations and code completion for paginators
from boto3.client("apigatewayv2").get_paginator("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_apigatewayv2.paginator import GetApisPaginator
def get_get_apis_paginator() -> GetApisPaginator:
return Session().client("apigatewayv2").get_paginator("get_apis"))
- GetApisPaginator
- GetAuthorizersPaginator
- GetDeploymentsPaginator
- GetDomainNamesPaginator
- GetIntegrationResponsesPaginator
- GetIntegrationsPaginator
- GetModelsPaginator
- GetRouteResponsesPaginator
- GetRoutesPaginator
- GetStagesPaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_apigatewayv2.literals import AuthorizationTypeType
def get_value() -> AuthorizationTypeType:
return "AWS_IAM"
- AuthorizationTypeType
- AuthorizerTypeType
- ConnectionTypeType
- ContentHandlingStrategyType
- DeploymentStatusType
- DomainNameStatusType
- EndpointTypeType
- GetApisPaginatorName
- GetAuthorizersPaginatorName
- GetDeploymentsPaginatorName
- GetDomainNamesPaginatorName
- GetIntegrationResponsesPaginatorName
- GetIntegrationsPaginatorName
- GetModelsPaginatorName
- GetRouteResponsesPaginatorName
- GetRoutesPaginatorName
- GetStagesPaginatorName
- IntegrationTypeType
- JSONYAMLType
- LoggingLevelType
- OAS30Type
- PassthroughBehaviorType
- ProtocolTypeType
- SecurityPolicyType
- VpcLinkStatusType
- VpcLinkVersionType
- ApiGatewayV2ServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_apigatewayv2.type_defs import AccessLogSettingsTypeDef
def get_value() -> AccessLogSettingsTypeDef:
return {
"DestinationArn": ...,
}
- AccessLogSettingsTypeDef
- ApiMappingTypeDef
- CorsTypeDef
- JWTConfigurationTypeDef
- CreateApiMappingRequestRequestTypeDef
- ResponseMetadataTypeDef
- CreateDeploymentRequestRequestTypeDef
- DomainNameConfigurationTypeDef
- MutualTlsAuthenticationInputTypeDef
- MutualTlsAuthenticationTypeDef
- TlsConfigInputTypeDef
- CreateIntegrationResponseRequestRequestTypeDef
- TlsConfigTypeDef
- CreateModelRequestRequestTypeDef
- ParameterConstraintsTypeDef
- RouteSettingsTypeDef
- CreateVpcLinkRequestRequestTypeDef
- DeleteAccessLogSettingsRequestRequestTypeDef
- DeleteApiMappingRequestRequestTypeDef
- DeleteApiRequestRequestTypeDef
- DeleteAuthorizerRequestRequestTypeDef
- DeleteCorsConfigurationRequestRequestTypeDef
- DeleteDeploymentRequestRequestTypeDef
- DeleteDomainNameRequestRequestTypeDef
- DeleteIntegrationRequestRequestTypeDef
- DeleteIntegrationResponseRequestRequestTypeDef
- DeleteModelRequestRequestTypeDef
- DeleteRouteRequestParameterRequestRequestTypeDef
- DeleteRouteRequestRequestTypeDef
- DeleteRouteResponseRequestRequestTypeDef
- DeleteRouteSettingsRequestRequestTypeDef
- DeleteStageRequestRequestTypeDef
- DeleteVpcLinkRequestRequestTypeDef
- DeploymentTypeDef
- ExportApiRequestRequestTypeDef
- GetApiMappingRequestRequestTypeDef
- GetApiMappingsRequestRequestTypeDef
- GetApiRequestRequestTypeDef
- PaginatorConfigTypeDef
- GetApisRequestRequestTypeDef
- GetAuthorizerRequestRequestTypeDef
- GetAuthorizersRequestRequestTypeDef
- GetDeploymentRequestRequestTypeDef
- GetDeploymentsRequestRequestTypeDef
- GetDomainNameRequestRequestTypeDef
- GetDomainNamesRequestRequestTypeDef
- GetIntegrationRequestRequestTypeDef
- GetIntegrationResponseRequestRequestTypeDef
- GetIntegrationResponsesRequestRequestTypeDef
- IntegrationResponseTypeDef
- GetIntegrationsRequestRequestTypeDef
- GetModelRequestRequestTypeDef
- GetModelTemplateRequestRequestTypeDef
- GetModelsRequestRequestTypeDef
- ModelTypeDef
- GetRouteRequestRequestTypeDef
- GetRouteResponseRequestRequestTypeDef
- GetRouteResponsesRequestRequestTypeDef
- GetRoutesRequestRequestTypeDef
- GetStageRequestRequestTypeDef
- GetStagesRequestRequestTypeDef
- GetTagsRequestRequestTypeDef
- GetVpcLinkRequestRequestTypeDef
- GetVpcLinksRequestRequestTypeDef
- VpcLinkTypeDef
- ImportApiRequestRequestTypeDef
- ReimportApiRequestRequestTypeDef
- ResetAuthorizersCacheRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateApiMappingRequestRequestTypeDef
- UpdateDeploymentRequestRequestTypeDef
- UpdateIntegrationResponseRequestRequestTypeDef
- UpdateModelRequestRequestTypeDef
- UpdateVpcLinkRequestRequestTypeDef
- ApiTypeDef
- CreateApiRequestRequestTypeDef
- UpdateApiRequestRequestTypeDef
- AuthorizerTypeDef
- CreateAuthorizerRequestRequestTypeDef
- UpdateAuthorizerRequestRequestTypeDef
- CreateApiMappingResponseTypeDef
- CreateApiResponseTypeDef
- CreateAuthorizerResponseTypeDef
- CreateDeploymentResponseTypeDef
- CreateIntegrationResponseResponseTypeDef
- CreateModelResponseTypeDef
- CreateVpcLinkResponseTypeDef
- EmptyResponseMetadataTypeDef
- ExportApiResponseTypeDef
- GetApiMappingResponseTypeDef
- GetApiMappingsResponseTypeDef
- GetApiResponseTypeDef
- GetAuthorizerResponseTypeDef
- GetDeploymentResponseTypeDef
- GetIntegrationResponseResponseTypeDef
- GetModelResponseTypeDef
- GetModelTemplateResponseTypeDef
- GetTagsResponseTypeDef
- GetVpcLinkResponseTypeDef
- ImportApiResponseTypeDef
- ReimportApiResponseTypeDef
- UpdateApiMappingResponseTypeDef
- UpdateApiResponseTypeDef
- UpdateAuthorizerResponseTypeDef
- UpdateDeploymentResponseTypeDef
- UpdateIntegrationResponseResponseTypeDef
- UpdateModelResponseTypeDef
- UpdateVpcLinkResponseTypeDef
- CreateDomainNameRequestRequestTypeDef
- UpdateDomainNameRequestRequestTypeDef
- CreateDomainNameResponseTypeDef
- DomainNameTypeDef
- GetDomainNameResponseTypeDef
- UpdateDomainNameResponseTypeDef
- CreateIntegrationRequestRequestTypeDef
- UpdateIntegrationRequestRequestTypeDef
- CreateIntegrationResultTypeDef
- GetIntegrationResultTypeDef
- IntegrationTypeDef
- UpdateIntegrationResultTypeDef
- CreateRouteRequestRequestTypeDef
- CreateRouteResponseRequestRequestTypeDef
- CreateRouteResponseResponseTypeDef
- CreateRouteResultTypeDef
- GetRouteResponseResponseTypeDef
- GetRouteResultTypeDef
- RouteResponseTypeDef
- RouteTypeDef
- UpdateRouteRequestRequestTypeDef
- UpdateRouteResponseRequestRequestTypeDef
- UpdateRouteResponseResponseTypeDef
- UpdateRouteResultTypeDef
- CreateStageRequestRequestTypeDef
- CreateStageResponseTypeDef
- GetStageResponseTypeDef
- StageTypeDef
- UpdateStageRequestRequestTypeDef
- UpdateStageResponseTypeDef
- GetDeploymentsResponseTypeDef
- GetApisRequestGetApisPaginateTypeDef
- GetAuthorizersRequestGetAuthorizersPaginateTypeDef
- GetDeploymentsRequestGetDeploymentsPaginateTypeDef
- GetDomainNamesRequestGetDomainNamesPaginateTypeDef
- GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef
- GetIntegrationsRequestGetIntegrationsPaginateTypeDef
- GetModelsRequestGetModelsPaginateTypeDef
- GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef
- GetRoutesRequestGetRoutesPaginateTypeDef
- GetStagesRequestGetStagesPaginateTypeDef
- GetIntegrationResponsesResponseTypeDef
- GetModelsResponseTypeDef
- GetVpcLinksResponseTypeDef
- GetApisResponseTypeDef
- GetAuthorizersResponseTypeDef
- GetDomainNamesResponseTypeDef
- GetIntegrationsResponseTypeDef
- GetRouteResponsesResponseTypeDef
- GetRoutesResponseTypeDef
- GetStagesResponseTypeDef