diff options
author | CoprDistGit <infra@openeuler.org> | 2023-04-11 05:59:56 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 05:59:56 +0000 |
commit | 33aebac7421d40e8d1c244a003d01201452b2c90 (patch) | |
tree | c6d95548d6f24bbf6eed67a161f338f95d5f6f29 | |
parent | c3c36beb16b5c6f0cdbf45b07ec9572791ac83b1 (diff) |
automatic import of python-mypy-boto3-apigateway
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-mypy-boto3-apigateway.spec | 2164 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 2166 insertions, 0 deletions
@@ -0,0 +1 @@ +/mypy-boto3-apigateway-1.26.40.tar.gz diff --git a/python-mypy-boto3-apigateway.spec b/python-mypy-boto3-apigateway.spec new file mode 100644 index 0000000..1f40c23 --- /dev/null +++ b/python-mypy-boto3-apigateway.spec @@ -0,0 +1,2164 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-apigateway +Version: 1.26.40 +Release: 1 +Summary: Type annotations for boto3.APIGateway 1.26.40 service generated with mypy-boto3-builder 7.12.2 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/2d/bc/b2511813ff73a92b077144cd1506bf288886fe4dbe89a24e046e31ffa7c7/mypy-boto3-apigateway-1.26.40.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-apigateway"></a> + +# mypy-boto3-apigateway + +[](https://pypi.org/project/mypy-boto3-apigateway) +[](https://pypi.org/project/mypy-boto3-apigateway) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-apigateway) + + + +Type annotations for +[boto3.APIGateway 1.26.40](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/apigateway.html#APIGateway) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.12.2](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-apigateway docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_apigateway/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-apigateway](#mypy-boto3-apigateway) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `APIGateway`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `APIGateway` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[apigateway]' + + +# 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[apigateway]' + + +# standalone installation +python -m pip install mypy-boto3-apigateway +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-apigateway +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### 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 `boto3-stubs[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[apigateway]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[apigateway]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`APIGatewayClient` provides annotations for `boto3.client("apigateway")`. + +```python +from boto3.session import Session + +from mypy_boto3_apigateway import APIGatewayClient + +client: APIGatewayClient = Session().client("apigateway") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_apigateway.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_apigateway import APIGatewayClient +from mypy_boto3_apigateway.paginator import ( + GetApiKeysPaginator, + GetAuthorizersPaginator, + GetBasePathMappingsPaginator, + GetClientCertificatesPaginator, + GetDeploymentsPaginator, + GetDocumentationPartsPaginator, + GetDocumentationVersionsPaginator, + GetDomainNamesPaginator, + GetGatewayResponsesPaginator, + GetModelsPaginator, + GetRequestValidatorsPaginator, + GetResourcesPaginator, + GetRestApisPaginator, + GetSdkTypesPaginator, + GetUsagePaginator, + GetUsagePlanKeysPaginator, + GetUsagePlansPaginator, + GetVpcLinksPaginator, +) + +client: APIGatewayClient = Session().client("apigateway") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +get_api_keys_paginator: GetApiKeysPaginator = client.get_paginator("get_api_keys") +get_authorizers_paginator: GetAuthorizersPaginator = client.get_paginator("get_authorizers") +get_base_path_mappings_paginator: GetBasePathMappingsPaginator = client.get_paginator( + "get_base_path_mappings" +) +get_client_certificates_paginator: GetClientCertificatesPaginator = client.get_paginator( + "get_client_certificates" +) +get_deployments_paginator: GetDeploymentsPaginator = client.get_paginator("get_deployments") +get_documentation_parts_paginator: GetDocumentationPartsPaginator = client.get_paginator( + "get_documentation_parts" +) +get_documentation_versions_paginator: GetDocumentationVersionsPaginator = client.get_paginator( + "get_documentation_versions" +) +get_domain_names_paginator: GetDomainNamesPaginator = client.get_paginator("get_domain_names") +get_gateway_responses_paginator: GetGatewayResponsesPaginator = client.get_paginator( + "get_gateway_responses" +) +get_models_paginator: GetModelsPaginator = client.get_paginator("get_models") +get_request_validators_paginator: GetRequestValidatorsPaginator = client.get_paginator( + "get_request_validators" +) +get_resources_paginator: GetResourcesPaginator = client.get_paginator("get_resources") +get_rest_apis_paginator: GetRestApisPaginator = client.get_paginator("get_rest_apis") +get_sdk_types_paginator: GetSdkTypesPaginator = client.get_paginator("get_sdk_types") +get_usage_paginator: GetUsagePaginator = client.get_paginator("get_usage") +get_usage_plan_keys_paginator: GetUsagePlanKeysPaginator = client.get_paginator( + "get_usage_plan_keys" +) +get_usage_plans_paginator: GetUsagePlansPaginator = client.get_paginator("get_usage_plans") +get_vpc_links_paginator: GetVpcLinksPaginator = client.get_paginator("get_vpc_links") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_apigateway.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_apigateway.literals import ( + ApiKeySourceTypeType, + ApiKeysFormatType, + AuthorizerTypeType, + CacheClusterSizeType, + CacheClusterStatusType, + ConnectionTypeType, + ContentHandlingStrategyType, + DocumentationPartTypeType, + DomainNameStatusType, + EndpointTypeType, + GatewayResponseTypeType, + GetApiKeysPaginatorName, + GetAuthorizersPaginatorName, + GetBasePathMappingsPaginatorName, + GetClientCertificatesPaginatorName, + GetDeploymentsPaginatorName, + GetDocumentationPartsPaginatorName, + GetDocumentationVersionsPaginatorName, + GetDomainNamesPaginatorName, + GetGatewayResponsesPaginatorName, + GetModelsPaginatorName, + GetRequestValidatorsPaginatorName, + GetResourcesPaginatorName, + GetRestApisPaginatorName, + GetSdkTypesPaginatorName, + GetUsagePaginatorName, + GetUsagePlanKeysPaginatorName, + GetUsagePlansPaginatorName, + GetVpcLinksPaginatorName, + IntegrationTypeType, + LocationStatusTypeType, + OpType, + PutModeType, + QuotaPeriodTypeType, + SecurityPolicyType, + UnauthorizedCacheControlHeaderStrategyType, + VpcLinkStatusType, + APIGatewayServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ApiKeySourceTypeType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_apigateway.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_apigateway.type_defs import ( + AccessLogSettingsTypeDef, + ResponseMetadataTypeDef, + ThrottleSettingsTypeDef, + ApiKeyTypeDef, + AuthorizerTypeDef, + BasePathMappingTypeDef, + CanarySettingsTypeDef, + ClientCertificateTypeDef, + StageKeyTypeDef, + CreateAuthorizerRequestRequestTypeDef, + CreateBasePathMappingRequestRequestTypeDef, + DeploymentCanarySettingsTypeDef, + DocumentationPartLocationTypeDef, + CreateDocumentationVersionRequestRequestTypeDef, + EndpointConfigurationTypeDef, + MutualTlsAuthenticationInputTypeDef, + CreateModelRequestRequestTypeDef, + CreateRequestValidatorRequestRequestTypeDef, + CreateResourceRequestRequestTypeDef, + CreateUsagePlanKeyRequestRequestTypeDef, + QuotaSettingsTypeDef, + CreateVpcLinkRequestRequestTypeDef, + DeleteApiKeyRequestRequestTypeDef, + DeleteAuthorizerRequestRequestTypeDef, + DeleteBasePathMappingRequestRequestTypeDef, + DeleteClientCertificateRequestRequestTypeDef, + DeleteDeploymentRequestRequestTypeDef, + DeleteDocumentationPartRequestRequestTypeDef, + DeleteDocumentationVersionRequestRequestTypeDef, + DeleteDomainNameRequestRequestTypeDef, + DeleteGatewayResponseRequestRequestTypeDef, + DeleteIntegrationRequestRequestTypeDef, + DeleteIntegrationResponseRequestRequestTypeDef, + DeleteMethodRequestRequestTypeDef, + DeleteMethodResponseRequestRequestTypeDef, + DeleteModelRequestRequestTypeDef, + DeleteRequestValidatorRequestRequestTypeDef, + DeleteResourceRequestRequestTypeDef, + DeleteRestApiRequestRequestTypeDef, + DeleteStageRequestRequestTypeDef, + DeleteUsagePlanKeyRequestRequestTypeDef, + DeleteUsagePlanRequestRequestTypeDef, + DeleteVpcLinkRequestRequestTypeDef, + MethodSnapshotTypeDef, + DocumentationVersionTypeDef, + MutualTlsAuthenticationTypeDef, + FlushStageAuthorizersCacheRequestRequestTypeDef, + FlushStageCacheRequestRequestTypeDef, + GatewayResponseTypeDef, + GenerateClientCertificateRequestRequestTypeDef, + GetApiKeyRequestRequestTypeDef, + PaginatorConfigTypeDef, + GetApiKeysRequestRequestTypeDef, + GetAuthorizerRequestRequestTypeDef, + GetAuthorizersRequestRequestTypeDef, + GetBasePathMappingRequestRequestTypeDef, + GetBasePathMappingsRequestRequestTypeDef, + GetClientCertificateRequestRequestTypeDef, + GetClientCertificatesRequestRequestTypeDef, + GetDeploymentRequestRequestTypeDef, + GetDeploymentsRequestRequestTypeDef, + GetDocumentationPartRequestRequestTypeDef, + GetDocumentationPartsRequestRequestTypeDef, + GetDocumentationVersionRequestRequestTypeDef, + GetDocumentationVersionsRequestRequestTypeDef, + GetDomainNameRequestRequestTypeDef, + GetDomainNamesRequestRequestTypeDef, + GetExportRequestRequestTypeDef, + GetGatewayResponseRequestRequestTypeDef, + GetGatewayResponsesRequestRequestTypeDef, + GetIntegrationRequestRequestTypeDef, + GetIntegrationResponseRequestRequestTypeDef, + GetMethodRequestRequestTypeDef, + GetMethodResponseRequestRequestTypeDef, + GetModelRequestRequestTypeDef, + GetModelTemplateRequestRequestTypeDef, + GetModelsRequestRequestTypeDef, + GetRequestValidatorRequestRequestTypeDef, + GetRequestValidatorsRequestRequestTypeDef, + GetResourceRequestRequestTypeDef, + GetResourcesRequestRequestTypeDef, + GetRestApiRequestRequestTypeDef, + GetRestApisRequestRequestTypeDef, + GetSdkRequestRequestTypeDef, + GetSdkTypeRequestRequestTypeDef, + GetSdkTypesRequestRequestTypeDef, + GetStageRequestRequestTypeDef, + GetStagesRequestRequestTypeDef, + GetTagsRequestRequestTypeDef, + GetUsagePlanKeyRequestRequestTypeDef, + GetUsagePlanKeysRequestRequestTypeDef, + GetUsagePlanRequestRequestTypeDef, + GetUsagePlansRequestRequestTypeDef, + GetUsageRequestRequestTypeDef, + GetVpcLinkRequestRequestTypeDef, + GetVpcLinksRequestRequestTypeDef, + ImportApiKeysRequestRequestTypeDef, + ImportDocumentationPartsRequestRequestTypeDef, + ImportRestApiRequestRequestTypeDef, + IntegrationResponseTypeDef, + TlsConfigTypeDef, + MethodResponseTypeDef, + MethodSettingTypeDef, + ModelTypeDef, + PatchOperationTypeDef, + PutGatewayResponseRequestRequestTypeDef, + PutIntegrationResponseRequestRequestTypeDef, + PutMethodRequestRequestTypeDef, + PutMethodResponseRequestRequestTypeDef, + PutRestApiRequestRequestTypeDef, + RequestValidatorTypeDef, + SdkConfigurationPropertyTypeDef, + TagResourceRequestRequestTypeDef, + TestInvokeAuthorizerRequestRequestTypeDef, + TestInvokeMethodRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UsagePlanKeyTypeDef, + VpcLinkTypeDef, + ApiKeyIdsTypeDef, + ApiKeyResponseMetadataTypeDef, + AuthorizerResponseMetadataTypeDef, + BasePathMappingResponseMetadataTypeDef, + ClientCertificateResponseMetadataTypeDef, + DocumentationPartIdsTypeDef, + DocumentationVersionResponseMetadataTypeDef, + EmptyResponseMetadataTypeDef, + ExportResponseTypeDef, + GatewayResponseResponseMetadataTypeDef, + IntegrationResponseResponseMetadataTypeDef, + MethodResponseResponseMetadataTypeDef, + ModelResponseMetadataTypeDef, + RequestValidatorResponseMetadataTypeDef, + SdkResponseTypeDef, + TagsTypeDef, + TemplateTypeDef, + TestInvokeAuthorizerResponseTypeDef, + TestInvokeMethodResponseTypeDef, + UsagePlanKeyResponseMetadataTypeDef, + UsageTypeDef, + VpcLinkResponseMetadataTypeDef, + AccountTypeDef, + ApiStageTypeDef, + ApiKeysTypeDef, + AuthorizersTypeDef, + BasePathMappingsTypeDef, + CreateStageRequestRequestTypeDef, + ClientCertificatesTypeDef, + CreateApiKeyRequestRequestTypeDef, + CreateDeploymentRequestRequestTypeDef, + CreateDocumentationPartRequestRequestTypeDef, + DocumentationPartResponseMetadataTypeDef, + DocumentationPartTypeDef, + CreateRestApiRequestRequestTypeDef, + RestApiResponseMetadataTypeDef, + RestApiTypeDef, + CreateDomainNameRequestRequestTypeDef, + DeploymentResponseMetadataTypeDef, + DeploymentTypeDef, + DocumentationVersionsTypeDef, + DomainNameResponseMetadataTypeDef, + DomainNameTypeDef, + GatewayResponsesTypeDef, + GetApiKeysRequestGetApiKeysPaginateTypeDef, + GetAuthorizersRequestGetAuthorizersPaginateTypeDef, + GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef, + GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef, + GetDeploymentsRequestGetDeploymentsPaginateTypeDef, + GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef, + GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef, + GetDomainNamesRequestGetDomainNamesPaginateTypeDef, + GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef, + GetModelsRequestGetModelsPaginateTypeDef, + GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef, + GetResourcesRequestGetResourcesPaginateTypeDef, + GetRestApisRequestGetRestApisPaginateTypeDef, + GetSdkTypesRequestGetSdkTypesPaginateTypeDef, + GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef, + GetUsagePlansRequestGetUsagePlansPaginateTypeDef, + GetUsageRequestGetUsagePaginateTypeDef, + GetVpcLinksRequestGetVpcLinksPaginateTypeDef, + IntegrationResponseMetadataTypeDef, + IntegrationTypeDef, + PutIntegrationRequestRequestTypeDef, + StageResponseMetadataTypeDef, + StageTypeDef, + ModelsTypeDef, + UpdateAccountRequestRequestTypeDef, + UpdateApiKeyRequestRequestTypeDef, + UpdateAuthorizerRequestRequestTypeDef, + UpdateBasePathMappingRequestRequestTypeDef, + UpdateClientCertificateRequestRequestTypeDef, + UpdateDeploymentRequestRequestTypeDef, + UpdateDocumentationPartRequestRequestTypeDef, + UpdateDocumentationVersionRequestRequestTypeDef, + UpdateDomainNameRequestRequestTypeDef, + UpdateGatewayResponseRequestRequestTypeDef, + UpdateIntegrationRequestRequestTypeDef, + UpdateIntegrationResponseRequestRequestTypeDef, + UpdateMethodRequestRequestTypeDef, + UpdateMethodResponseRequestRequestTypeDef, + UpdateModelRequestRequestTypeDef, + UpdateRequestValidatorRequestRequestTypeDef, + UpdateResourceRequestRequestTypeDef, + UpdateRestApiRequestRequestTypeDef, + UpdateStageRequestRequestTypeDef, + UpdateUsagePlanRequestRequestTypeDef, + UpdateUsageRequestRequestTypeDef, + UpdateVpcLinkRequestRequestTypeDef, + RequestValidatorsTypeDef, + SdkTypeResponseMetadataTypeDef, + SdkTypeTypeDef, + UsagePlanKeysTypeDef, + VpcLinksTypeDef, + CreateUsagePlanRequestRequestTypeDef, + UsagePlanResponseMetadataTypeDef, + UsagePlanTypeDef, + DocumentationPartsTypeDef, + RestApisTypeDef, + DeploymentsTypeDef, + DomainNamesTypeDef, + MethodResponseMetadataTypeDef, + MethodTypeDef, + StagesTypeDef, + SdkTypesTypeDef, + UsagePlansTypeDef, + ResourceResponseMetadataTypeDef, + ResourceTypeDef, + ResourcesTypeDef, +) + + +def get_structure() -> AccessLogSettingsTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-apigateway` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_apigateway/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package -n python3-mypy-boto3-apigateway +Summary: Type annotations for boto3.APIGateway 1.26.40 service generated with mypy-boto3-builder 7.12.2 +Provides: python-mypy-boto3-apigateway +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-apigateway +<a id="mypy-boto3-apigateway"></a> + +# mypy-boto3-apigateway + +[](https://pypi.org/project/mypy-boto3-apigateway) +[](https://pypi.org/project/mypy-boto3-apigateway) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-apigateway) + + + +Type annotations for +[boto3.APIGateway 1.26.40](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/apigateway.html#APIGateway) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.12.2](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-apigateway docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_apigateway/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-apigateway](#mypy-boto3-apigateway) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `APIGateway`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `APIGateway` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[apigateway]' + + +# 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[apigateway]' + + +# standalone installation +python -m pip install mypy-boto3-apigateway +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-apigateway +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### 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 `boto3-stubs[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[apigateway]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[apigateway]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`APIGatewayClient` provides annotations for `boto3.client("apigateway")`. + +```python +from boto3.session import Session + +from mypy_boto3_apigateway import APIGatewayClient + +client: APIGatewayClient = Session().client("apigateway") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_apigateway.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_apigateway import APIGatewayClient +from mypy_boto3_apigateway.paginator import ( + GetApiKeysPaginator, + GetAuthorizersPaginator, + GetBasePathMappingsPaginator, + GetClientCertificatesPaginator, + GetDeploymentsPaginator, + GetDocumentationPartsPaginator, + GetDocumentationVersionsPaginator, + GetDomainNamesPaginator, + GetGatewayResponsesPaginator, + GetModelsPaginator, + GetRequestValidatorsPaginator, + GetResourcesPaginator, + GetRestApisPaginator, + GetSdkTypesPaginator, + GetUsagePaginator, + GetUsagePlanKeysPaginator, + GetUsagePlansPaginator, + GetVpcLinksPaginator, +) + +client: APIGatewayClient = Session().client("apigateway") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +get_api_keys_paginator: GetApiKeysPaginator = client.get_paginator("get_api_keys") +get_authorizers_paginator: GetAuthorizersPaginator = client.get_paginator("get_authorizers") +get_base_path_mappings_paginator: GetBasePathMappingsPaginator = client.get_paginator( + "get_base_path_mappings" +) +get_client_certificates_paginator: GetClientCertificatesPaginator = client.get_paginator( + "get_client_certificates" +) +get_deployments_paginator: GetDeploymentsPaginator = client.get_paginator("get_deployments") +get_documentation_parts_paginator: GetDocumentationPartsPaginator = client.get_paginator( + "get_documentation_parts" +) +get_documentation_versions_paginator: GetDocumentationVersionsPaginator = client.get_paginator( + "get_documentation_versions" +) +get_domain_names_paginator: GetDomainNamesPaginator = client.get_paginator("get_domain_names") +get_gateway_responses_paginator: GetGatewayResponsesPaginator = client.get_paginator( + "get_gateway_responses" +) +get_models_paginator: GetModelsPaginator = client.get_paginator("get_models") +get_request_validators_paginator: GetRequestValidatorsPaginator = client.get_paginator( + "get_request_validators" +) +get_resources_paginator: GetResourcesPaginator = client.get_paginator("get_resources") +get_rest_apis_paginator: GetRestApisPaginator = client.get_paginator("get_rest_apis") +get_sdk_types_paginator: GetSdkTypesPaginator = client.get_paginator("get_sdk_types") +get_usage_paginator: GetUsagePaginator = client.get_paginator("get_usage") +get_usage_plan_keys_paginator: GetUsagePlanKeysPaginator = client.get_paginator( + "get_usage_plan_keys" +) +get_usage_plans_paginator: GetUsagePlansPaginator = client.get_paginator("get_usage_plans") +get_vpc_links_paginator: GetVpcLinksPaginator = client.get_paginator("get_vpc_links") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_apigateway.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_apigateway.literals import ( + ApiKeySourceTypeType, + ApiKeysFormatType, + AuthorizerTypeType, + CacheClusterSizeType, + CacheClusterStatusType, + ConnectionTypeType, + ContentHandlingStrategyType, + DocumentationPartTypeType, + DomainNameStatusType, + EndpointTypeType, + GatewayResponseTypeType, + GetApiKeysPaginatorName, + GetAuthorizersPaginatorName, + GetBasePathMappingsPaginatorName, + GetClientCertificatesPaginatorName, + GetDeploymentsPaginatorName, + GetDocumentationPartsPaginatorName, + GetDocumentationVersionsPaginatorName, + GetDomainNamesPaginatorName, + GetGatewayResponsesPaginatorName, + GetModelsPaginatorName, + GetRequestValidatorsPaginatorName, + GetResourcesPaginatorName, + GetRestApisPaginatorName, + GetSdkTypesPaginatorName, + GetUsagePaginatorName, + GetUsagePlanKeysPaginatorName, + GetUsagePlansPaginatorName, + GetVpcLinksPaginatorName, + IntegrationTypeType, + LocationStatusTypeType, + OpType, + PutModeType, + QuotaPeriodTypeType, + SecurityPolicyType, + UnauthorizedCacheControlHeaderStrategyType, + VpcLinkStatusType, + APIGatewayServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ApiKeySourceTypeType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_apigateway.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_apigateway.type_defs import ( + AccessLogSettingsTypeDef, + ResponseMetadataTypeDef, + ThrottleSettingsTypeDef, + ApiKeyTypeDef, + AuthorizerTypeDef, + BasePathMappingTypeDef, + CanarySettingsTypeDef, + ClientCertificateTypeDef, + StageKeyTypeDef, + CreateAuthorizerRequestRequestTypeDef, + CreateBasePathMappingRequestRequestTypeDef, + DeploymentCanarySettingsTypeDef, + DocumentationPartLocationTypeDef, + CreateDocumentationVersionRequestRequestTypeDef, + EndpointConfigurationTypeDef, + MutualTlsAuthenticationInputTypeDef, + CreateModelRequestRequestTypeDef, + CreateRequestValidatorRequestRequestTypeDef, + CreateResourceRequestRequestTypeDef, + CreateUsagePlanKeyRequestRequestTypeDef, + QuotaSettingsTypeDef, + CreateVpcLinkRequestRequestTypeDef, + DeleteApiKeyRequestRequestTypeDef, + DeleteAuthorizerRequestRequestTypeDef, + DeleteBasePathMappingRequestRequestTypeDef, + DeleteClientCertificateRequestRequestTypeDef, + DeleteDeploymentRequestRequestTypeDef, + DeleteDocumentationPartRequestRequestTypeDef, + DeleteDocumentationVersionRequestRequestTypeDef, + DeleteDomainNameRequestRequestTypeDef, + DeleteGatewayResponseRequestRequestTypeDef, + DeleteIntegrationRequestRequestTypeDef, + DeleteIntegrationResponseRequestRequestTypeDef, + DeleteMethodRequestRequestTypeDef, + DeleteMethodResponseRequestRequestTypeDef, + DeleteModelRequestRequestTypeDef, + DeleteRequestValidatorRequestRequestTypeDef, + DeleteResourceRequestRequestTypeDef, + DeleteRestApiRequestRequestTypeDef, + DeleteStageRequestRequestTypeDef, + DeleteUsagePlanKeyRequestRequestTypeDef, + DeleteUsagePlanRequestRequestTypeDef, + DeleteVpcLinkRequestRequestTypeDef, + MethodSnapshotTypeDef, + DocumentationVersionTypeDef, + MutualTlsAuthenticationTypeDef, + FlushStageAuthorizersCacheRequestRequestTypeDef, + FlushStageCacheRequestRequestTypeDef, + GatewayResponseTypeDef, + GenerateClientCertificateRequestRequestTypeDef, + GetApiKeyRequestRequestTypeDef, + PaginatorConfigTypeDef, + GetApiKeysRequestRequestTypeDef, + GetAuthorizerRequestRequestTypeDef, + GetAuthorizersRequestRequestTypeDef, + GetBasePathMappingRequestRequestTypeDef, + GetBasePathMappingsRequestRequestTypeDef, + GetClientCertificateRequestRequestTypeDef, + GetClientCertificatesRequestRequestTypeDef, + GetDeploymentRequestRequestTypeDef, + GetDeploymentsRequestRequestTypeDef, + GetDocumentationPartRequestRequestTypeDef, + GetDocumentationPartsRequestRequestTypeDef, + GetDocumentationVersionRequestRequestTypeDef, + GetDocumentationVersionsRequestRequestTypeDef, + GetDomainNameRequestRequestTypeDef, + GetDomainNamesRequestRequestTypeDef, + GetExportRequestRequestTypeDef, + GetGatewayResponseRequestRequestTypeDef, + GetGatewayResponsesRequestRequestTypeDef, + GetIntegrationRequestRequestTypeDef, + GetIntegrationResponseRequestRequestTypeDef, + GetMethodRequestRequestTypeDef, + GetMethodResponseRequestRequestTypeDef, + GetModelRequestRequestTypeDef, + GetModelTemplateRequestRequestTypeDef, + GetModelsRequestRequestTypeDef, + GetRequestValidatorRequestRequestTypeDef, + GetRequestValidatorsRequestRequestTypeDef, + GetResourceRequestRequestTypeDef, + GetResourcesRequestRequestTypeDef, + GetRestApiRequestRequestTypeDef, + GetRestApisRequestRequestTypeDef, + GetSdkRequestRequestTypeDef, + GetSdkTypeRequestRequestTypeDef, + GetSdkTypesRequestRequestTypeDef, + GetStageRequestRequestTypeDef, + GetStagesRequestRequestTypeDef, + GetTagsRequestRequestTypeDef, + GetUsagePlanKeyRequestRequestTypeDef, + GetUsagePlanKeysRequestRequestTypeDef, + GetUsagePlanRequestRequestTypeDef, + GetUsagePlansRequestRequestTypeDef, + GetUsageRequestRequestTypeDef, + GetVpcLinkRequestRequestTypeDef, + GetVpcLinksRequestRequestTypeDef, + ImportApiKeysRequestRequestTypeDef, + ImportDocumentationPartsRequestRequestTypeDef, + ImportRestApiRequestRequestTypeDef, + IntegrationResponseTypeDef, + TlsConfigTypeDef, + MethodResponseTypeDef, + MethodSettingTypeDef, + ModelTypeDef, + PatchOperationTypeDef, + PutGatewayResponseRequestRequestTypeDef, + PutIntegrationResponseRequestRequestTypeDef, + PutMethodRequestRequestTypeDef, + PutMethodResponseRequestRequestTypeDef, + PutRestApiRequestRequestTypeDef, + RequestValidatorTypeDef, + SdkConfigurationPropertyTypeDef, + TagResourceRequestRequestTypeDef, + TestInvokeAuthorizerRequestRequestTypeDef, + TestInvokeMethodRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UsagePlanKeyTypeDef, + VpcLinkTypeDef, + ApiKeyIdsTypeDef, + ApiKeyResponseMetadataTypeDef, + AuthorizerResponseMetadataTypeDef, + BasePathMappingResponseMetadataTypeDef, + ClientCertificateResponseMetadataTypeDef, + DocumentationPartIdsTypeDef, + DocumentationVersionResponseMetadataTypeDef, + EmptyResponseMetadataTypeDef, + ExportResponseTypeDef, + GatewayResponseResponseMetadataTypeDef, + IntegrationResponseResponseMetadataTypeDef, + MethodResponseResponseMetadataTypeDef, + ModelResponseMetadataTypeDef, + RequestValidatorResponseMetadataTypeDef, + SdkResponseTypeDef, + TagsTypeDef, + TemplateTypeDef, + TestInvokeAuthorizerResponseTypeDef, + TestInvokeMethodResponseTypeDef, + UsagePlanKeyResponseMetadataTypeDef, + UsageTypeDef, + VpcLinkResponseMetadataTypeDef, + AccountTypeDef, + ApiStageTypeDef, + ApiKeysTypeDef, + AuthorizersTypeDef, + BasePathMappingsTypeDef, + CreateStageRequestRequestTypeDef, + ClientCertificatesTypeDef, + CreateApiKeyRequestRequestTypeDef, + CreateDeploymentRequestRequestTypeDef, + CreateDocumentationPartRequestRequestTypeDef, + DocumentationPartResponseMetadataTypeDef, + DocumentationPartTypeDef, + CreateRestApiRequestRequestTypeDef, + RestApiResponseMetadataTypeDef, + RestApiTypeDef, + CreateDomainNameRequestRequestTypeDef, + DeploymentResponseMetadataTypeDef, + DeploymentTypeDef, + DocumentationVersionsTypeDef, + DomainNameResponseMetadataTypeDef, + DomainNameTypeDef, + GatewayResponsesTypeDef, + GetApiKeysRequestGetApiKeysPaginateTypeDef, + GetAuthorizersRequestGetAuthorizersPaginateTypeDef, + GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef, + GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef, + GetDeploymentsRequestGetDeploymentsPaginateTypeDef, + GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef, + GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef, + GetDomainNamesRequestGetDomainNamesPaginateTypeDef, + GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef, + GetModelsRequestGetModelsPaginateTypeDef, + GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef, + GetResourcesRequestGetResourcesPaginateTypeDef, + GetRestApisRequestGetRestApisPaginateTypeDef, + GetSdkTypesRequestGetSdkTypesPaginateTypeDef, + GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef, + GetUsagePlansRequestGetUsagePlansPaginateTypeDef, + GetUsageRequestGetUsagePaginateTypeDef, + GetVpcLinksRequestGetVpcLinksPaginateTypeDef, + IntegrationResponseMetadataTypeDef, + IntegrationTypeDef, + PutIntegrationRequestRequestTypeDef, + StageResponseMetadataTypeDef, + StageTypeDef, + ModelsTypeDef, + UpdateAccountRequestRequestTypeDef, + UpdateApiKeyRequestRequestTypeDef, + UpdateAuthorizerRequestRequestTypeDef, + UpdateBasePathMappingRequestRequestTypeDef, + UpdateClientCertificateRequestRequestTypeDef, + UpdateDeploymentRequestRequestTypeDef, + UpdateDocumentationPartRequestRequestTypeDef, + UpdateDocumentationVersionRequestRequestTypeDef, + UpdateDomainNameRequestRequestTypeDef, + UpdateGatewayResponseRequestRequestTypeDef, + UpdateIntegrationRequestRequestTypeDef, + UpdateIntegrationResponseRequestRequestTypeDef, + UpdateMethodRequestRequestTypeDef, + UpdateMethodResponseRequestRequestTypeDef, + UpdateModelRequestRequestTypeDef, + UpdateRequestValidatorRequestRequestTypeDef, + UpdateResourceRequestRequestTypeDef, + UpdateRestApiRequestRequestTypeDef, + UpdateStageRequestRequestTypeDef, + UpdateUsagePlanRequestRequestTypeDef, + UpdateUsageRequestRequestTypeDef, + UpdateVpcLinkRequestRequestTypeDef, + RequestValidatorsTypeDef, + SdkTypeResponseMetadataTypeDef, + SdkTypeTypeDef, + UsagePlanKeysTypeDef, + VpcLinksTypeDef, + CreateUsagePlanRequestRequestTypeDef, + UsagePlanResponseMetadataTypeDef, + UsagePlanTypeDef, + DocumentationPartsTypeDef, + RestApisTypeDef, + DeploymentsTypeDef, + DomainNamesTypeDef, + MethodResponseMetadataTypeDef, + MethodTypeDef, + StagesTypeDef, + SdkTypesTypeDef, + UsagePlansTypeDef, + ResourceResponseMetadataTypeDef, + ResourceTypeDef, + ResourcesTypeDef, +) + + +def get_structure() -> AccessLogSettingsTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-apigateway` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_apigateway/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package help +Summary: Development documents and examples for mypy-boto3-apigateway +Provides: python3-mypy-boto3-apigateway-doc +%description help +<a id="mypy-boto3-apigateway"></a> + +# mypy-boto3-apigateway + +[](https://pypi.org/project/mypy-boto3-apigateway) +[](https://pypi.org/project/mypy-boto3-apigateway) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-apigateway) + + + +Type annotations for +[boto3.APIGateway 1.26.40](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/apigateway.html#APIGateway) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.12.2](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-apigateway docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_apigateway/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-apigateway](#mypy-boto3-apigateway) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `APIGateway`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `APIGateway` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[apigateway]' + + +# 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[apigateway]' + + +# standalone installation +python -m pip install mypy-boto3-apigateway +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-apigateway +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### 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 `boto3-stubs[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[apigateway]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[apigateway]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[apigateway]` in your environment: + +```bash +python -m pip install 'boto3-stubs[apigateway]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`APIGatewayClient` provides annotations for `boto3.client("apigateway")`. + +```python +from boto3.session import Session + +from mypy_boto3_apigateway import APIGatewayClient + +client: APIGatewayClient = Session().client("apigateway") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_apigateway.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_apigateway import APIGatewayClient +from mypy_boto3_apigateway.paginator import ( + GetApiKeysPaginator, + GetAuthorizersPaginator, + GetBasePathMappingsPaginator, + GetClientCertificatesPaginator, + GetDeploymentsPaginator, + GetDocumentationPartsPaginator, + GetDocumentationVersionsPaginator, + GetDomainNamesPaginator, + GetGatewayResponsesPaginator, + GetModelsPaginator, + GetRequestValidatorsPaginator, + GetResourcesPaginator, + GetRestApisPaginator, + GetSdkTypesPaginator, + GetUsagePaginator, + GetUsagePlanKeysPaginator, + GetUsagePlansPaginator, + GetVpcLinksPaginator, +) + +client: APIGatewayClient = Session().client("apigateway") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +get_api_keys_paginator: GetApiKeysPaginator = client.get_paginator("get_api_keys") +get_authorizers_paginator: GetAuthorizersPaginator = client.get_paginator("get_authorizers") +get_base_path_mappings_paginator: GetBasePathMappingsPaginator = client.get_paginator( + "get_base_path_mappings" +) +get_client_certificates_paginator: GetClientCertificatesPaginator = client.get_paginator( + "get_client_certificates" +) +get_deployments_paginator: GetDeploymentsPaginator = client.get_paginator("get_deployments") +get_documentation_parts_paginator: GetDocumentationPartsPaginator = client.get_paginator( + "get_documentation_parts" +) +get_documentation_versions_paginator: GetDocumentationVersionsPaginator = client.get_paginator( + "get_documentation_versions" +) +get_domain_names_paginator: GetDomainNamesPaginator = client.get_paginator("get_domain_names") +get_gateway_responses_paginator: GetGatewayResponsesPaginator = client.get_paginator( + "get_gateway_responses" +) +get_models_paginator: GetModelsPaginator = client.get_paginator("get_models") +get_request_validators_paginator: GetRequestValidatorsPaginator = client.get_paginator( + "get_request_validators" +) +get_resources_paginator: GetResourcesPaginator = client.get_paginator("get_resources") +get_rest_apis_paginator: GetRestApisPaginator = client.get_paginator("get_rest_apis") +get_sdk_types_paginator: GetSdkTypesPaginator = client.get_paginator("get_sdk_types") +get_usage_paginator: GetUsagePaginator = client.get_paginator("get_usage") +get_usage_plan_keys_paginator: GetUsagePlanKeysPaginator = client.get_paginator( + "get_usage_plan_keys" +) +get_usage_plans_paginator: GetUsagePlansPaginator = client.get_paginator("get_usage_plans") +get_vpc_links_paginator: GetVpcLinksPaginator = client.get_paginator("get_vpc_links") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_apigateway.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_apigateway.literals import ( + ApiKeySourceTypeType, + ApiKeysFormatType, + AuthorizerTypeType, + CacheClusterSizeType, + CacheClusterStatusType, + ConnectionTypeType, + ContentHandlingStrategyType, + DocumentationPartTypeType, + DomainNameStatusType, + EndpointTypeType, + GatewayResponseTypeType, + GetApiKeysPaginatorName, + GetAuthorizersPaginatorName, + GetBasePathMappingsPaginatorName, + GetClientCertificatesPaginatorName, + GetDeploymentsPaginatorName, + GetDocumentationPartsPaginatorName, + GetDocumentationVersionsPaginatorName, + GetDomainNamesPaginatorName, + GetGatewayResponsesPaginatorName, + GetModelsPaginatorName, + GetRequestValidatorsPaginatorName, + GetResourcesPaginatorName, + GetRestApisPaginatorName, + GetSdkTypesPaginatorName, + GetUsagePaginatorName, + GetUsagePlanKeysPaginatorName, + GetUsagePlansPaginatorName, + GetVpcLinksPaginatorName, + IntegrationTypeType, + LocationStatusTypeType, + OpType, + PutModeType, + QuotaPeriodTypeType, + SecurityPolicyType, + UnauthorizedCacheControlHeaderStrategyType, + VpcLinkStatusType, + APIGatewayServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ApiKeySourceTypeType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_apigateway.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_apigateway.type_defs import ( + AccessLogSettingsTypeDef, + ResponseMetadataTypeDef, + ThrottleSettingsTypeDef, + ApiKeyTypeDef, + AuthorizerTypeDef, + BasePathMappingTypeDef, + CanarySettingsTypeDef, + ClientCertificateTypeDef, + StageKeyTypeDef, + CreateAuthorizerRequestRequestTypeDef, + CreateBasePathMappingRequestRequestTypeDef, + DeploymentCanarySettingsTypeDef, + DocumentationPartLocationTypeDef, + CreateDocumentationVersionRequestRequestTypeDef, + EndpointConfigurationTypeDef, + MutualTlsAuthenticationInputTypeDef, + CreateModelRequestRequestTypeDef, + CreateRequestValidatorRequestRequestTypeDef, + CreateResourceRequestRequestTypeDef, + CreateUsagePlanKeyRequestRequestTypeDef, + QuotaSettingsTypeDef, + CreateVpcLinkRequestRequestTypeDef, + DeleteApiKeyRequestRequestTypeDef, + DeleteAuthorizerRequestRequestTypeDef, + DeleteBasePathMappingRequestRequestTypeDef, + DeleteClientCertificateRequestRequestTypeDef, + DeleteDeploymentRequestRequestTypeDef, + DeleteDocumentationPartRequestRequestTypeDef, + DeleteDocumentationVersionRequestRequestTypeDef, + DeleteDomainNameRequestRequestTypeDef, + DeleteGatewayResponseRequestRequestTypeDef, + DeleteIntegrationRequestRequestTypeDef, + DeleteIntegrationResponseRequestRequestTypeDef, + DeleteMethodRequestRequestTypeDef, + DeleteMethodResponseRequestRequestTypeDef, + DeleteModelRequestRequestTypeDef, + DeleteRequestValidatorRequestRequestTypeDef, + DeleteResourceRequestRequestTypeDef, + DeleteRestApiRequestRequestTypeDef, + DeleteStageRequestRequestTypeDef, + DeleteUsagePlanKeyRequestRequestTypeDef, + DeleteUsagePlanRequestRequestTypeDef, + DeleteVpcLinkRequestRequestTypeDef, + MethodSnapshotTypeDef, + DocumentationVersionTypeDef, + MutualTlsAuthenticationTypeDef, + FlushStageAuthorizersCacheRequestRequestTypeDef, + FlushStageCacheRequestRequestTypeDef, + GatewayResponseTypeDef, + GenerateClientCertificateRequestRequestTypeDef, + GetApiKeyRequestRequestTypeDef, + PaginatorConfigTypeDef, + GetApiKeysRequestRequestTypeDef, + GetAuthorizerRequestRequestTypeDef, + GetAuthorizersRequestRequestTypeDef, + GetBasePathMappingRequestRequestTypeDef, + GetBasePathMappingsRequestRequestTypeDef, + GetClientCertificateRequestRequestTypeDef, + GetClientCertificatesRequestRequestTypeDef, + GetDeploymentRequestRequestTypeDef, + GetDeploymentsRequestRequestTypeDef, + GetDocumentationPartRequestRequestTypeDef, + GetDocumentationPartsRequestRequestTypeDef, + GetDocumentationVersionRequestRequestTypeDef, + GetDocumentationVersionsRequestRequestTypeDef, + GetDomainNameRequestRequestTypeDef, + GetDomainNamesRequestRequestTypeDef, + GetExportRequestRequestTypeDef, + GetGatewayResponseRequestRequestTypeDef, + GetGatewayResponsesRequestRequestTypeDef, + GetIntegrationRequestRequestTypeDef, + GetIntegrationResponseRequestRequestTypeDef, + GetMethodRequestRequestTypeDef, + GetMethodResponseRequestRequestTypeDef, + GetModelRequestRequestTypeDef, + GetModelTemplateRequestRequestTypeDef, + GetModelsRequestRequestTypeDef, + GetRequestValidatorRequestRequestTypeDef, + GetRequestValidatorsRequestRequestTypeDef, + GetResourceRequestRequestTypeDef, + GetResourcesRequestRequestTypeDef, + GetRestApiRequestRequestTypeDef, + GetRestApisRequestRequestTypeDef, + GetSdkRequestRequestTypeDef, + GetSdkTypeRequestRequestTypeDef, + GetSdkTypesRequestRequestTypeDef, + GetStageRequestRequestTypeDef, + GetStagesRequestRequestTypeDef, + GetTagsRequestRequestTypeDef, + GetUsagePlanKeyRequestRequestTypeDef, + GetUsagePlanKeysRequestRequestTypeDef, + GetUsagePlanRequestRequestTypeDef, + GetUsagePlansRequestRequestTypeDef, + GetUsageRequestRequestTypeDef, + GetVpcLinkRequestRequestTypeDef, + GetVpcLinksRequestRequestTypeDef, + ImportApiKeysRequestRequestTypeDef, + ImportDocumentationPartsRequestRequestTypeDef, + ImportRestApiRequestRequestTypeDef, + IntegrationResponseTypeDef, + TlsConfigTypeDef, + MethodResponseTypeDef, + MethodSettingTypeDef, + ModelTypeDef, + PatchOperationTypeDef, + PutGatewayResponseRequestRequestTypeDef, + PutIntegrationResponseRequestRequestTypeDef, + PutMethodRequestRequestTypeDef, + PutMethodResponseRequestRequestTypeDef, + PutRestApiRequestRequestTypeDef, + RequestValidatorTypeDef, + SdkConfigurationPropertyTypeDef, + TagResourceRequestRequestTypeDef, + TestInvokeAuthorizerRequestRequestTypeDef, + TestInvokeMethodRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UsagePlanKeyTypeDef, + VpcLinkTypeDef, + ApiKeyIdsTypeDef, + ApiKeyResponseMetadataTypeDef, + AuthorizerResponseMetadataTypeDef, + BasePathMappingResponseMetadataTypeDef, + ClientCertificateResponseMetadataTypeDef, + DocumentationPartIdsTypeDef, + DocumentationVersionResponseMetadataTypeDef, + EmptyResponseMetadataTypeDef, + ExportResponseTypeDef, + GatewayResponseResponseMetadataTypeDef, + IntegrationResponseResponseMetadataTypeDef, + MethodResponseResponseMetadataTypeDef, + ModelResponseMetadataTypeDef, + RequestValidatorResponseMetadataTypeDef, + SdkResponseTypeDef, + TagsTypeDef, + TemplateTypeDef, + TestInvokeAuthorizerResponseTypeDef, + TestInvokeMethodResponseTypeDef, + UsagePlanKeyResponseMetadataTypeDef, + UsageTypeDef, + VpcLinkResponseMetadataTypeDef, + AccountTypeDef, + ApiStageTypeDef, + ApiKeysTypeDef, + AuthorizersTypeDef, + BasePathMappingsTypeDef, + CreateStageRequestRequestTypeDef, + ClientCertificatesTypeDef, + CreateApiKeyRequestRequestTypeDef, + CreateDeploymentRequestRequestTypeDef, + CreateDocumentationPartRequestRequestTypeDef, + DocumentationPartResponseMetadataTypeDef, + DocumentationPartTypeDef, + CreateRestApiRequestRequestTypeDef, + RestApiResponseMetadataTypeDef, + RestApiTypeDef, + CreateDomainNameRequestRequestTypeDef, + DeploymentResponseMetadataTypeDef, + DeploymentTypeDef, + DocumentationVersionsTypeDef, + DomainNameResponseMetadataTypeDef, + DomainNameTypeDef, + GatewayResponsesTypeDef, + GetApiKeysRequestGetApiKeysPaginateTypeDef, + GetAuthorizersRequestGetAuthorizersPaginateTypeDef, + GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef, + GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef, + GetDeploymentsRequestGetDeploymentsPaginateTypeDef, + GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef, + GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef, + GetDomainNamesRequestGetDomainNamesPaginateTypeDef, + GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef, + GetModelsRequestGetModelsPaginateTypeDef, + GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef, + GetResourcesRequestGetResourcesPaginateTypeDef, + GetRestApisRequestGetRestApisPaginateTypeDef, + GetSdkTypesRequestGetSdkTypesPaginateTypeDef, + GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef, + GetUsagePlansRequestGetUsagePlansPaginateTypeDef, + GetUsageRequestGetUsagePaginateTypeDef, + GetVpcLinksRequestGetVpcLinksPaginateTypeDef, + IntegrationResponseMetadataTypeDef, + IntegrationTypeDef, + PutIntegrationRequestRequestTypeDef, + StageResponseMetadataTypeDef, + StageTypeDef, + ModelsTypeDef, + UpdateAccountRequestRequestTypeDef, + UpdateApiKeyRequestRequestTypeDef, + UpdateAuthorizerRequestRequestTypeDef, + UpdateBasePathMappingRequestRequestTypeDef, + UpdateClientCertificateRequestRequestTypeDef, + UpdateDeploymentRequestRequestTypeDef, + UpdateDocumentationPartRequestRequestTypeDef, + UpdateDocumentationVersionRequestRequestTypeDef, + UpdateDomainNameRequestRequestTypeDef, + UpdateGatewayResponseRequestRequestTypeDef, + UpdateIntegrationRequestRequestTypeDef, + UpdateIntegrationResponseRequestRequestTypeDef, + UpdateMethodRequestRequestTypeDef, + UpdateMethodResponseRequestRequestTypeDef, + UpdateModelRequestRequestTypeDef, + UpdateRequestValidatorRequestRequestTypeDef, + UpdateResourceRequestRequestTypeDef, + UpdateRestApiRequestRequestTypeDef, + UpdateStageRequestRequestTypeDef, + UpdateUsagePlanRequestRequestTypeDef, + UpdateUsageRequestRequestTypeDef, + UpdateVpcLinkRequestRequestTypeDef, + RequestValidatorsTypeDef, + SdkTypeResponseMetadataTypeDef, + SdkTypeTypeDef, + UsagePlanKeysTypeDef, + VpcLinksTypeDef, + CreateUsagePlanRequestRequestTypeDef, + UsagePlanResponseMetadataTypeDef, + UsagePlanTypeDef, + DocumentationPartsTypeDef, + RestApisTypeDef, + DeploymentsTypeDef, + DomainNamesTypeDef, + MethodResponseMetadataTypeDef, + MethodTypeDef, + StagesTypeDef, + SdkTypesTypeDef, + UsagePlansTypeDef, + ResourceResponseMetadataTypeDef, + ResourceTypeDef, + ResourcesTypeDef, +) + + +def get_structure() -> AccessLogSettingsTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-apigateway` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_apigateway/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%prep +%autosetup -n mypy-boto3-apigateway-1.26.40 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-apigateway -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.40-1 +- Package Spec generated @@ -0,0 +1 @@ +76c2f884ba6dc51dcab446b00e5bc660 mypy-boto3-apigateway-1.26.40.tar.gz |