ApiGatewayV2 module#
Index > ApiGatewayV2
Auto-generated documentation for ApiGatewayV2 type annotations stubs module types-boto3-apigatewayv2.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
ApiGatewayV2
service. - Use provided commands to install generated packages.
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 types-boto3
for ApiGatewayV2
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[apigatewayv2]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[apigatewayv2]'
# standalone installation
python -m pip install types-boto3-apigatewayv2
How to uninstall#
python -m pip uninstall -y types-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 types_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 types_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 schema.
# AuthorizationTypeType usage example
from types_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
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccessLogSettingsTypeDef
- ApiMappingTypeDef
- CorsOutputTypeDef
- JWTConfigurationOutputTypeDef
- CorsTypeDef
- CreateApiMappingRequestTypeDef
- ResponseMetadataTypeDef
- CreateDeploymentRequestTypeDef
- MutualTlsAuthenticationInputTypeDef
- DomainNameConfigurationOutputTypeDef
- MutualTlsAuthenticationTypeDef
- TlsConfigInputTypeDef
- CreateIntegrationResponseRequestTypeDef
- TlsConfigTypeDef
- CreateModelRequestTypeDef
- ParameterConstraintsTypeDef
- RouteSettingsTypeDef
- CreateVpcLinkRequestTypeDef
- DeleteAccessLogSettingsRequestTypeDef
- DeleteApiMappingRequestTypeDef
- DeleteApiRequestTypeDef
- DeleteAuthorizerRequestTypeDef
- DeleteCorsConfigurationRequestTypeDef
- DeleteDeploymentRequestTypeDef
- DeleteDomainNameRequestTypeDef
- DeleteIntegrationRequestTypeDef
- DeleteIntegrationResponseRequestTypeDef
- DeleteModelRequestTypeDef
- DeleteRouteRequestParameterRequestTypeDef
- DeleteRouteRequestTypeDef
- DeleteRouteResponseRequestTypeDef
- DeleteRouteSettingsRequestTypeDef
- DeleteStageRequestTypeDef
- DeleteVpcLinkRequestTypeDef
- DeploymentTypeDef
- TimestampTypeDef
- ExportApiRequestTypeDef
- GetApiMappingRequestTypeDef
- GetApiMappingsRequestTypeDef
- GetApiRequestTypeDef
- PaginatorConfigTypeDef
- GetApisRequestTypeDef
- GetAuthorizerRequestTypeDef
- GetAuthorizersRequestTypeDef
- GetDeploymentRequestTypeDef
- GetDeploymentsRequestTypeDef
- GetDomainNameRequestTypeDef
- GetDomainNamesRequestTypeDef
- GetIntegrationRequestTypeDef
- GetIntegrationResponseRequestTypeDef
- GetIntegrationResponsesRequestTypeDef
- IntegrationResponseTypeDef
- GetIntegrationsRequestTypeDef
- GetModelRequestTypeDef
- GetModelTemplateRequestTypeDef
- GetModelsRequestTypeDef
- ModelTypeDef
- GetRouteRequestTypeDef
- GetRouteResponseRequestTypeDef
- GetRouteResponsesRequestTypeDef
- GetRoutesRequestTypeDef
- GetStageRequestTypeDef
- GetStagesRequestTypeDef
- GetTagsRequestTypeDef
- GetVpcLinkRequestTypeDef
- GetVpcLinksRequestTypeDef
- VpcLinkTypeDef
- ImportApiRequestTypeDef
- JWTConfigurationTypeDef
- ReimportApiRequestTypeDef
- ResetAuthorizersCacheRequestTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateApiMappingRequestTypeDef
- UpdateDeploymentRequestTypeDef
- UpdateIntegrationResponseRequestTypeDef
- UpdateModelRequestTypeDef
- UpdateVpcLinkRequestTypeDef
- ApiTypeDef
- AuthorizerTypeDef
- CorsUnionTypeDef
- 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
- CreateDomainNameResponseTypeDef
- DomainNameTypeDef
- GetDomainNameResponseTypeDef
- UpdateDomainNameResponseTypeDef
- CreateIntegrationRequestTypeDef
- UpdateIntegrationRequestTypeDef
- CreateIntegrationResultTypeDef
- GetIntegrationResultTypeDef
- IntegrationTypeDef
- UpdateIntegrationResultTypeDef
- CreateRouteRequestTypeDef
- CreateRouteResponseRequestTypeDef
- CreateRouteResponseResponseTypeDef
- CreateRouteResultTypeDef
- GetRouteResponseResponseTypeDef
- GetRouteResultTypeDef
- RouteResponseTypeDef
- RouteTypeDef
- UpdateRouteRequestTypeDef
- UpdateRouteResponseRequestTypeDef
- UpdateRouteResponseResponseTypeDef
- UpdateRouteResultTypeDef
- CreateStageRequestTypeDef
- CreateStageResponseTypeDef
- GetStageResponseTypeDef
- StageTypeDef
- UpdateStageRequestTypeDef
- UpdateStageResponseTypeDef
- GetDeploymentsResponseTypeDef
- DomainNameConfigurationTypeDef
- GetApisRequestPaginateTypeDef
- GetAuthorizersRequestPaginateTypeDef
- GetDeploymentsRequestPaginateTypeDef
- GetDomainNamesRequestPaginateTypeDef
- GetIntegrationResponsesRequestPaginateTypeDef
- GetIntegrationsRequestPaginateTypeDef
- GetModelsRequestPaginateTypeDef
- GetRouteResponsesRequestPaginateTypeDef
- GetRoutesRequestPaginateTypeDef
- GetStagesRequestPaginateTypeDef
- GetIntegrationResponsesResponseTypeDef
- GetModelsResponseTypeDef
- GetVpcLinksResponseTypeDef
- JWTConfigurationUnionTypeDef
- GetApisResponseTypeDef
- GetAuthorizersResponseTypeDef
- CreateApiRequestTypeDef
- UpdateApiRequestTypeDef
- GetDomainNamesResponseTypeDef
- GetIntegrationsResponseTypeDef
- GetRouteResponsesResponseTypeDef
- GetRoutesResponseTypeDef
- GetStagesResponseTypeDef
- DomainNameConfigurationUnionTypeDef
- CreateAuthorizerRequestTypeDef
- UpdateAuthorizerRequestTypeDef
- CreateDomainNameRequestTypeDef
- UpdateDomainNameRequestTypeDef