Paginators#
Index > APIGateway > Paginators
Auto-generated documentation for APIGateway type annotations stubs module types-aiobotocore-apigateway.
GetApiKeysPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_api_keys")
.
boto3 documentation
# GetApiKeysPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetApiKeysPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetApiKeysPaginator = client.get_paginator("get_api_keys") # (2)
async for item in paginator.paginate(...):
item: ApiKeysTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetApiKeysPaginator
- item: ApiKeysTypeDef
paginate#
Type annotations and code completion for GetApiKeysPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
nameQuery: str = ...,
customerId: str = ...,
includeValues: bool = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[ApiKeysTypeDef]: # (2)
...
- See PaginatorConfigTypeDef
- See ApiKeysTypeDef
# paginate method usage example with argument unpacking
kwargs: GetApiKeysRequestGetApiKeysPaginateTypeDef = { # (1)
"nameQuery": ...,
}
parent.paginate(**kwargs)
GetAuthorizersPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_authorizers")
.
boto3 documentation
# GetAuthorizersPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetAuthorizersPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetAuthorizersPaginator = client.get_paginator("get_authorizers") # (2)
async for item in paginator.paginate(...):
item: AuthorizersTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetAuthorizersPaginator
- item: AuthorizersTypeDef
paginate#
Type annotations and code completion for GetAuthorizersPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
restApiId: str,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[AuthorizersTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetAuthorizersRequestGetAuthorizersPaginateTypeDef = { # (1)
"restApiId": ...,
}
parent.paginate(**kwargs)
GetBasePathMappingsPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_base_path_mappings")
.
boto3 documentation
# GetBasePathMappingsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetBasePathMappingsPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetBasePathMappingsPaginator = client.get_paginator("get_base_path_mappings") # (2)
async for item in paginator.paginate(...):
item: BasePathMappingsTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetBasePathMappingsPaginator
- item: BasePathMappingsTypeDef
paginate#
Type annotations and code completion for GetBasePathMappingsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
domainName: str,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[BasePathMappingsTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef = { # (1)
"domainName": ...,
}
parent.paginate(**kwargs)
GetClientCertificatesPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_client_certificates")
.
boto3 documentation
# GetClientCertificatesPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetClientCertificatesPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetClientCertificatesPaginator = client.get_paginator("get_client_certificates") # (2)
async for item in paginator.paginate(...):
item: ClientCertificatesTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetClientCertificatesPaginator
- item: ClientCertificatesTypeDef
paginate#
Type annotations and code completion for GetClientCertificatesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[ClientCertificatesTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)
GetDeploymentsPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_deployments")
.
boto3 documentation
# GetDeploymentsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetDeploymentsPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetDeploymentsPaginator = client.get_paginator("get_deployments") # (2)
async for item in paginator.paginate(...):
item: DeploymentsTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetDeploymentsPaginator
- item: DeploymentsTypeDef
paginate#
Type annotations and code completion for GetDeploymentsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
restApiId: str,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[DeploymentsTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetDeploymentsRequestGetDeploymentsPaginateTypeDef = { # (1)
"restApiId": ...,
}
parent.paginate(**kwargs)
GetDocumentationPartsPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_documentation_parts")
.
boto3 documentation
# GetDocumentationPartsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetDocumentationPartsPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetDocumentationPartsPaginator = client.get_paginator("get_documentation_parts") # (2)
async for item in paginator.paginate(...):
item: DocumentationPartsTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetDocumentationPartsPaginator
- item: DocumentationPartsTypeDef
paginate#
Type annotations and code completion for GetDocumentationPartsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
restApiId: str,
type: DocumentationPartTypeType = ..., # (1)
nameQuery: str = ...,
path: str = ...,
locationStatus: LocationStatusTypeType = ..., # (2)
PaginationConfig: PaginatorConfigTypeDef = ..., # (3)
) -> AsyncIterator[DocumentationPartsTypeDef]: # (4)
...
- See DocumentationPartTypeType
- See LocationStatusTypeType
- See PaginatorConfigTypeDef
- See DocumentationPartsTypeDef
# paginate method usage example with argument unpacking
kwargs: GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef = { # (1)
"restApiId": ...,
}
parent.paginate(**kwargs)
GetDocumentationVersionsPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_documentation_versions")
.
boto3 documentation
# GetDocumentationVersionsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetDocumentationVersionsPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetDocumentationVersionsPaginator = client.get_paginator("get_documentation_versions") # (2)
async for item in paginator.paginate(...):
item: DocumentationVersionsTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetDocumentationVersionsPaginator
- item: DocumentationVersionsTypeDef
paginate#
Type annotations and code completion for GetDocumentationVersionsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
restApiId: str,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[DocumentationVersionsTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef = { # (1)
"restApiId": ...,
}
parent.paginate(**kwargs)
GetDomainNamesPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_domain_names")
.
boto3 documentation
# GetDomainNamesPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetDomainNamesPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetDomainNamesPaginator = client.get_paginator("get_domain_names") # (2)
async for item in paginator.paginate(...):
item: DomainNamesTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetDomainNamesPaginator
- item: DomainNamesTypeDef
paginate#
Type annotations and code completion for GetDomainNamesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[DomainNamesTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetDomainNamesRequestGetDomainNamesPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)
GetGatewayResponsesPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_gateway_responses")
.
boto3 documentation
# GetGatewayResponsesPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetGatewayResponsesPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetGatewayResponsesPaginator = client.get_paginator("get_gateway_responses") # (2)
async for item in paginator.paginate(...):
item: GatewayResponsesTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetGatewayResponsesPaginator
- item: GatewayResponsesTypeDef
paginate#
Type annotations and code completion for GetGatewayResponsesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
restApiId: str,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[GatewayResponsesTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef = { # (1)
"restApiId": ...,
}
parent.paginate(**kwargs)
GetModelsPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_models")
.
boto3 documentation
# GetModelsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetModelsPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetModelsPaginator = client.get_paginator("get_models") # (2)
async for item in paginator.paginate(...):
item: ModelsTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetModelsPaginator
- item: ModelsTypeDef
paginate#
Type annotations and code completion for GetModelsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
restApiId: str,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[ModelsTypeDef]: # (2)
...
- See PaginatorConfigTypeDef
- See ModelsTypeDef
# paginate method usage example with argument unpacking
kwargs: GetModelsRequestGetModelsPaginateTypeDef = { # (1)
"restApiId": ...,
}
parent.paginate(**kwargs)
GetRequestValidatorsPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_request_validators")
.
boto3 documentation
# GetRequestValidatorsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetRequestValidatorsPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetRequestValidatorsPaginator = client.get_paginator("get_request_validators") # (2)
async for item in paginator.paginate(...):
item: RequestValidatorsTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetRequestValidatorsPaginator
- item: RequestValidatorsTypeDef
paginate#
Type annotations and code completion for GetRequestValidatorsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
restApiId: str,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[RequestValidatorsTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef = { # (1)
"restApiId": ...,
}
parent.paginate(**kwargs)
GetResourcesPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_resources")
.
boto3 documentation
# GetResourcesPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetResourcesPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetResourcesPaginator = client.get_paginator("get_resources") # (2)
async for item in paginator.paginate(...):
item: ResourcesTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetResourcesPaginator
- item: ResourcesTypeDef
paginate#
Type annotations and code completion for GetResourcesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
restApiId: str,
embed: Sequence[str] = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[ResourcesTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetResourcesRequestGetResourcesPaginateTypeDef = { # (1)
"restApiId": ...,
}
parent.paginate(**kwargs)
GetRestApisPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_rest_apis")
.
boto3 documentation
# GetRestApisPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetRestApisPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetRestApisPaginator = client.get_paginator("get_rest_apis") # (2)
async for item in paginator.paginate(...):
item: RestApisTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetRestApisPaginator
- item: RestApisTypeDef
paginate#
Type annotations and code completion for GetRestApisPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[RestApisTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetRestApisRequestGetRestApisPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)
GetSdkTypesPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_sdk_types")
.
boto3 documentation
# GetSdkTypesPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetSdkTypesPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetSdkTypesPaginator = client.get_paginator("get_sdk_types") # (2)
async for item in paginator.paginate(...):
item: SdkTypesTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetSdkTypesPaginator
- item: SdkTypesTypeDef
paginate#
Type annotations and code completion for GetSdkTypesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[SdkTypesTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetSdkTypesRequestGetSdkTypesPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)
GetUsagePaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_usage")
.
boto3 documentation
# GetUsagePaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetUsagePaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetUsagePaginator = client.get_paginator("get_usage") # (2)
async for item in paginator.paginate(...):
item: UsageTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetUsagePaginator
- item: UsageTypeDef
paginate#
Type annotations and code completion for GetUsagePaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
usagePlanId: str,
startDate: str,
endDate: str,
keyId: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[UsageTypeDef]: # (2)
...
- See PaginatorConfigTypeDef
- See UsageTypeDef
# paginate method usage example with argument unpacking
kwargs: GetUsageRequestGetUsagePaginateTypeDef = { # (1)
"usagePlanId": ...,
"startDate": ...,
"endDate": ...,
}
parent.paginate(**kwargs)
GetUsagePlanKeysPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_usage_plan_keys")
.
boto3 documentation
# GetUsagePlanKeysPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetUsagePlanKeysPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetUsagePlanKeysPaginator = client.get_paginator("get_usage_plan_keys") # (2)
async for item in paginator.paginate(...):
item: UsagePlanKeysTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetUsagePlanKeysPaginator
- item: UsagePlanKeysTypeDef
paginate#
Type annotations and code completion for GetUsagePlanKeysPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
usagePlanId: str,
nameQuery: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[UsagePlanKeysTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef = { # (1)
"usagePlanId": ...,
}
parent.paginate(**kwargs)
GetUsagePlansPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_usage_plans")
.
boto3 documentation
# GetUsagePlansPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetUsagePlansPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetUsagePlansPaginator = client.get_paginator("get_usage_plans") # (2)
async for item in paginator.paginate(...):
item: UsagePlansTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetUsagePlansPaginator
- item: UsagePlansTypeDef
paginate#
Type annotations and code completion for GetUsagePlansPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
keyId: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[UsagePlansTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetUsagePlansRequestGetUsagePlansPaginateTypeDef = { # (1)
"keyId": ...,
}
parent.paginate(**kwargs)
GetVpcLinksPaginator#
Type annotations and code completion for session.create_client("apigateway").get_paginator("get_vpc_links")
.
boto3 documentation
# GetVpcLinksPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigateway.paginator import GetVpcLinksPaginator
session = get_session()
async with session.create_client("apigateway") as client: # (1)
paginator: GetVpcLinksPaginator = client.get_paginator("get_vpc_links") # (2)
async for item in paginator.paginate(...):
item: VpcLinksTypeDef
print(item) # (3)
- client: APIGatewayClient
- paginator: GetVpcLinksPaginator
- item: VpcLinksTypeDef
paginate#
Type annotations and code completion for GetVpcLinksPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[VpcLinksTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: GetVpcLinksRequestGetVpcLinksPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)