APIGateway module
Index > APIGateway
Auto-generated documentation for APIGateway type annotations stubs module types-aiobotocore-apigateway.
How to install
From PyPI with pip
Install types-aioboto3
for APIGateway
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[apigateway]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[apigateway]'
# standalone installation
python -m pip install types-aiobotocore-apigateway
How to uninstall
Usage
Code samples can be found in Examples.
APIGatewayClient
Type annotations and code completion for session.client("apigateway")
as APIGatewayClient
boto3 documentation
Usage example
from aioboto3.session import Session
from types_aiobotocore_apigateway.client import APIGatewayClient
session = Session()
async with session.client("apigateway") as client:
client: APIGatewayClient
Paginators
Type annotations and code completion for
paginators
from session.client("apigateway").get_paginator("...")
.
Usage example
from types_aiobotocore_apigateway.paginator import GetApiKeysPaginator
def get_get_api_keys_paginator() -> GetApiKeysPaginator:
return client.get_paginator("get_api_keys"))
- GetApiKeysPaginator
- GetAuthorizersPaginator
- GetBasePathMappingsPaginator
- GetClientCertificatesPaginator
- GetDeploymentsPaginator
- GetDocumentationPartsPaginator
- GetDocumentationVersionsPaginator
- GetDomainNamesPaginator
- GetGatewayResponsesPaginator
- GetModelsPaginator
- GetRequestValidatorsPaginator
- GetResourcesPaginator
- GetRestApisPaginator
- GetSdkTypesPaginator
- GetUsagePaginator
- GetUsagePlanKeysPaginator
- GetUsagePlansPaginator
- GetVpcLinksPaginator
Literals
Type annotations for literals used in methods and schema.
Usage example
from types_aiobotocore_apigateway.literals import ApiKeySourceTypeType
def get_value() -> ApiKeySourceTypeType:
return "AUTHORIZER"
- 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
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from types_aiobotocore_apigateway.type_defs import AccessLogSettingsTypeDef
def get_value() -> AccessLogSettingsTypeDef:
return {
"format": ...,
}
- 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