PyPI 官网下载 | mypy-boto3-apigatewayv2-1.14.55.2.tar.gz

# mypy-boto3-apigatewayv2 [](https://pypi.org/project/mypy-boto3-apigatewayv2) [](https://pypi.org/project/mypy-boto3-apigatewayv2) [](https://mypy-boto3-builder.readthedocs.io/) Type annotations for [boto3.ApiGatewayV2 1.14.55](https://boto3.amazonaws.com/v1/documentation/api/1.14.55/reference/services/apigatewayv2.html#ApiGatewayV2) service compatible with [VSCode](https://code.visualstudio.com/), [PyCharm](https://www.jetbrains.com/pycharm/), [mypy](https://github.com/python/mypy), [pyright](https://github.com/microsoft/pyright) and other tools. Generated by [mypy-boto3-buider 3.0.4](https://github.com/vemel/mypy_boto3_builder). More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page. - [mypy-boto3-apigatewayv2](#mypy-boto3-apigatewayv2) - [How to install](#how-to-install) - [Usage](#usage) - [VSCode](#vscode) - [PyCharm](#pycharm) - [Other IDEs](#other-ides) - [mypy](#mypy) - [pyright](#pyright) - [Explicit type annotations](#explicit-type-annotations) - [Client annotations](#client-annotations) - [Paginators annotations](#paginators-annotations) - [Waiters annotations](#waiters-annotations) - [Service Resource annotations](#service-resource-annotations) - [Other resources annotations](#other-resources-annotations) - [Collections annotations](#collections-annotations) - [Typed dictionations](#typed-dictionations) ## How to install Install `boto3-stubs` for `ApiGatewayV2` service. ```bash python -m pip install boto3-stubs[apigatewayv2] ``` ## Usage ### VSCode - Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) - Set `Pylance` as your Python Language Server - Install `boto-stubs[apigatewayv2]` in your environment: `python -m pip install 'boto3-stubs[apigatewayv2]'` Both type checking and auto-complete should work for `ApiGatewayV2` service. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm - Install `boto-stubs[apigatewayv2]` in your environment: `python -m pip install 'boto3-stubs[apigatewayv2]'` Both type checking and auto-complete should work for `ApiGatewayV2` service. No explicit type annotations required, write your `boto3` code as usual. Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules. ### Other IDEs Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work. ### mypy - Install `mypy`: `python -m pip install mypy` - Install `boto-stubs[apigatewayv2]` in your environment: `python -m pip install 'boto3-stubs[apigatewayv2]'` - Run `mypy` as usual Type checking should work for `ApiGatewayV2` service. No explicit type annotations required, write your `boto3` code as usual. ### pyright - Install `pyright`: `yarn global add pyright` - Install `boto-stubs[apigatewayv2]` in your environment: `python -m pip install 'boto3-stubs[apigatewayv2]'` - Optionally, you can install `boto3-stubs` to `typings` folder. Type checking should work for `ApiGatewayV2` service. No explicit type annotations required, write your `boto3` code as usual. ## Explicit type annotations ### Client annotations `ApiGatewayV2Client` provides annotations for `boto3.client("apigatewayv2")`. ```python import boto3 from mypy_boto3_apigatewayv2 import ApiGatewayV2Client client: ApiGatewayV2Client = boto3.client("apigatewayv2") # now client usage is checked by mypy and IDE should provide code auto-complete # works for session as well session = boto3.session.Session(region="us-west-1") session_client: ApiGatewayV2Client = session.client("apigatewayv2") ``` ### Paginators annotations `mypy_boto3_apigatewayv2.paginator` module contains type annotations for all paginators. ```python from mypy_boto3_apigatewayv2 import ApiGatewayV2Client from mypy_boto3_apigatewayv2.paginator import ( GetApisPaginator, GetAuthorizersPaginator, GetDeploymentsPaginator, GetDomainNamesPaginator, GetIntegrationResponsesPaginator, GetIntegrationsPaginator, GetModelsPaginator, GetRouteResponsesPaginator, GetRoutesPaginator, GetStagesPaginator, ) client: ApiGatewayV2Client = boto3.client("apigatewayv2") # Explicit type annotations are optional here # Type should be correctly discovered by mypy and IDEs # VSCode requires explicit type annotations get_apis_paginator: GetApisPaginator = client.get_paginator("get_apis") get_authorizers_paginator: GetAuthorizersPaginator = client.get_paginator("get_authorizers") get_deployments_paginator: GetDeploymentsPaginator = client.get_paginator("get_deployments") get_domain_names_paginator: GetDomainNamesPaginator = client.get_paginator("get_domain_names") get_integration_responses_paginator: GetIntegrationResponsesPaginator = client.get_paginator("get_integration_responses") get_integrations_paginator: GetIntegrationsPaginator = client.get_paginator("get_integrations") get_models_paginator: GetModelsPaginator = client.get_paginator("get_models") get_route_responses_paginator: GetRouteResponsesPaginator = client.get_paginator("get_route_responses") get_routes_paginator: GetRoutesPaginator = client.get_paginator("get_routes") get_stages_paginator: GetStagesPaginator = client.get_paginator("get_stages") ``` ### Typed dictionations `mypy_boto3_apigatewayv2.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python from mypy_boto3_apigatewayv2.type_defs import ( AccessLogSettingsTypeDef, ApiMappingTypeDef, ApiTypeDef, AuthorizerTypeDef, CorsTypeDef, CreateApiMappingResponseTypeDef, CreateApiResponseTypeDef, CreateAuthorizerResponseTypeDef, CreateDeploymentResponseTypeDef, CreateDomainNameResponseTypeDef, CreateIntegrationResponseResponseTypeDef, CreateIntegrationResultTypeDef, CreateModelResponseTypeDef, CreateRouteResponseResponseTypeDef, CreateRouteResultTypeDef, CreateStageResponseTypeDef, CreateVpcLinkResponseTypeDef, DeploymentTypeDef, DomainNameConfigurationTypeDef, DomainNameTypeDef, ExportApiResponseTypeDef, GetApiMappingResponseTypeDef, GetApiMappingsResponseTypeDef, GetApiResponseTypeDef, GetApisResponseTypeDef, GetAuthorizerResponseTypeDef, GetAuthorizersResponseTypeDef, GetDeploymentResponseTypeDef, GetDeploymentsResponseTypeDef, GetDomainNameResponseTypeDef, GetDomainNamesResponseTypeDef, GetIntegrationResponseResponseTypeDef, GetIntegrationResponsesResponseTypeDef, GetIntegrationResultTypeDef, GetIntegrationsResponseTypeDef, GetModelResponseTypeDef, GetModelsResponseTypeDef, GetModelTemplateResponseTypeDef, GetRouteResponseResponseTypeDef, GetRouteResponsesResponseTypeDef, GetRouteResultTypeDef, GetRoutesResponseTypeDef, GetStageResponseTypeDef, GetStagesResponseTypeDef, GetTagsResponseTypeDef, GetVpcLinkResponseTypeDef, GetVpcLinksResponseTypeDef, ImportApiResponseTypeDef, IntegrationResponseTypeDef, IntegrationTypeDef, JWTConfigurationTypeDef, ModelTypeDef, PaginatorConfigTypeDef, ParameterConstraintsTypeDef, ReimportApiResponseTypeDef, RouteResponseTypeDef, RouteSettingsTypeDef, RouteTypeDef, StageTypeDef, TlsConfigInputTypeDef, TlsConfigTypeDef, UpdateApiMappingResponseTypeDef, UpdateApiResponseTypeDef, UpdateAuthorizerResponseTypeDef, UpdateDeploymentResponseTypeDef, UpdateDomainNameResponseTypeDef, UpdateIntegrationResponseR