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#
python -m pip uninstall -y mypy-boto3-apigatewayv2
Usage#
Code samples can be found in Examples.
ApiGatewayV2Client#
Type annotations and code completion for boto3.client("apigatewayv2")
as ApiGatewayV2Client
boto3 documentation
# ApiGatewayV2Client 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("...")
.
# GetApisPaginator 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.
# AuthorizationTypeType 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.
# AccessLogSettingsTypeDef usage example
from mypy_boto3_apigatewayv2.type_defs import AccessLogSettingsTypeDef
def get_value() -> AccessLogSettingsTypeDef:
return {
"DestinationArn": ...,
}
- AccessLogSettingsTypeDef
- ApiMappingTypeDef
- CorsTypeDef
- JWTConfigurationTypeDef
- CreateApiMappingRequestRequestTypeDef
- CreateApiMappingResponseTypeDef
- CreateDeploymentRequestRequestTypeDef
- CreateDeploymentResponseTypeDef
- DomainNameConfigurationTypeDef
- MutualTlsAuthenticationInputTypeDef
- MutualTlsAuthenticationTypeDef
- TlsConfigInputTypeDef
- CreateIntegrationResponseRequestRequestTypeDef
- CreateIntegrationResponseResponseTypeDef
- TlsConfigTypeDef
- CreateModelRequestRequestTypeDef
- CreateModelResponseTypeDef
- ParameterConstraintsTypeDef
- RouteSettingsTypeDef
- CreateVpcLinkRequestRequestTypeDef
- CreateVpcLinkResponseTypeDef
- DeleteAccessLogSettingsRequestRequestTypeDef
- DeleteApiMappingRequestRequestTypeDef
- DeleteApiRequestRequestTypeDef
- DeleteAuthorizerRequestRequestTypeDef
- DeleteCorsConfigurationRequestRequestTypeDef
- DeleteDeploymentRequestRequestTypeDef
- DeleteDomainNameRequestRequestTypeDef
- DeleteIntegrationRequestRequestTypeDef
- DeleteIntegrationResponseRequestRequestTypeDef
- DeleteModelRequestRequestTypeDef
- DeleteRouteRequestParameterRequestRequestTypeDef
- DeleteRouteRequestRequestTypeDef
- DeleteRouteResponseRequestRequestTypeDef
- DeleteRouteSettingsRequestRequestTypeDef
- DeleteStageRequestRequestTypeDef
- DeleteVpcLinkRequestRequestTypeDef
- DeploymentTypeDef
- EmptyResponseMetadataTypeDef
- ExportApiRequestRequestTypeDef
- ExportApiResponseTypeDef
- GetApiMappingRequestRequestTypeDef
- GetApiMappingResponseTypeDef
- GetApiMappingsRequestRequestTypeDef
- GetApiRequestRequestTypeDef
- GetApisRequestGetApisPaginateTypeDef
- GetApisRequestRequestTypeDef
- GetAuthorizerRequestRequestTypeDef
- GetAuthorizersRequestGetAuthorizersPaginateTypeDef
- GetAuthorizersRequestRequestTypeDef
- GetDeploymentRequestRequestTypeDef
- GetDeploymentResponseTypeDef
- GetDeploymentsRequestGetDeploymentsPaginateTypeDef
- GetDeploymentsRequestRequestTypeDef
- GetDomainNameRequestRequestTypeDef
- GetDomainNamesRequestGetDomainNamesPaginateTypeDef
- GetDomainNamesRequestRequestTypeDef
- GetIntegrationRequestRequestTypeDef
- GetIntegrationResponseRequestRequestTypeDef
- GetIntegrationResponseResponseTypeDef
- GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef
- GetIntegrationResponsesRequestRequestTypeDef
- IntegrationResponseTypeDef
- GetIntegrationsRequestGetIntegrationsPaginateTypeDef
- GetIntegrationsRequestRequestTypeDef
- GetModelRequestRequestTypeDef
- GetModelResponseTypeDef
- GetModelTemplateRequestRequestTypeDef
- GetModelTemplateResponseTypeDef
- GetModelsRequestGetModelsPaginateTypeDef
- GetModelsRequestRequestTypeDef
- ModelTypeDef
- GetRouteRequestRequestTypeDef
- GetRouteResponseRequestRequestTypeDef
- GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef
- GetRouteResponsesRequestRequestTypeDef
- GetRoutesRequestGetRoutesPaginateTypeDef
- GetRoutesRequestRequestTypeDef
- GetStageRequestRequestTypeDef
- GetStagesRequestGetStagesPaginateTypeDef
- GetStagesRequestRequestTypeDef
- GetTagsRequestRequestTypeDef
- GetTagsResponseTypeDef
- GetVpcLinkRequestRequestTypeDef
- GetVpcLinkResponseTypeDef
- GetVpcLinksRequestRequestTypeDef
- VpcLinkTypeDef
- ImportApiRequestRequestTypeDef
- PaginatorConfigTypeDef
- ReimportApiRequestRequestTypeDef
- ResetAuthorizersCacheRequestRequestTypeDef
- ResponseMetadataTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateApiMappingRequestRequestTypeDef
- UpdateApiMappingResponseTypeDef
- UpdateDeploymentRequestRequestTypeDef
- UpdateDeploymentResponseTypeDef
- UpdateIntegrationResponseRequestRequestTypeDef
- UpdateIntegrationResponseResponseTypeDef
- UpdateModelRequestRequestTypeDef
- UpdateModelResponseTypeDef
- UpdateVpcLinkRequestRequestTypeDef
- UpdateVpcLinkResponseTypeDef
- GetApiMappingsResponseTypeDef
- ApiTypeDef
- CreateApiRequestRequestTypeDef
- CreateApiResponseTypeDef
- GetApiResponseTypeDef
- ImportApiResponseTypeDef
- ReimportApiResponseTypeDef
- UpdateApiRequestRequestTypeDef
- UpdateApiResponseTypeDef
- AuthorizerTypeDef
- CreateAuthorizerRequestRequestTypeDef
- CreateAuthorizerResponseTypeDef
- GetAuthorizerResponseTypeDef
- UpdateAuthorizerRequestRequestTypeDef
- UpdateAuthorizerResponseTypeDef
- 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
- GetIntegrationResponsesResponseTypeDef
- GetModelsResponseTypeDef
- GetVpcLinksResponseTypeDef
- GetApisResponseTypeDef
- GetAuthorizersResponseTypeDef
- GetDomainNamesResponseTypeDef
- GetIntegrationsResponseTypeDef
- GetRouteResponsesResponseTypeDef
- GetRoutesResponseTypeDef
- GetStagesResponseTypeDef