Paginators

Index > APIGateway > Paginators

Auto-generated documentation for APIGateway type annotations stubs module types-aiobotocore-apigateway.

GetApiKeysPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_api_keys"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetApiKeysPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetApiKeysPaginator
3. item: ApiKeysTypeDef

paginate

Type annotations and code completion for GetApiKeysPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    nameQuery: str = ...,
    customerId: str = ...,
    includeValues: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ApiKeysTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ApiKeysTypeDef

Usage example with kwargs

kwargs: GetApiKeysRequestGetApiKeysPaginateTypeDef = {  # (1)
    "nameQuery": ...,
}

parent.paginate(**kwargs)

1. See GetApiKeysRequestGetApiKeysPaginateTypeDef

GetAuthorizersPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_authorizers"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetAuthorizersPaginator

session = Session()

session = get_session()
async with session.client("apigateway") as client:  # (1)
    paginator: GetAuthorizersPaginator = client.get_paginator("get_authorizers")  # (2)
    async for item in paginator.paginate(...):
        item: AuthorizersTypeDef
        print(item)  # (3)

1. client: APIGatewayClient
2. paginator: GetAuthorizersPaginator
3. item: AuthorizersTypeDef

paginate

Type annotations and code completion for GetAuthorizersPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[AuthorizersTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See AuthorizersTypeDef

Usage example with kwargs

kwargs: GetAuthorizersRequestGetAuthorizersPaginateTypeDef = {  # (1)
    "restApiId": ...,
}

parent.paginate(**kwargs)

1. See GetAuthorizersRequestGetAuthorizersPaginateTypeDef

GetBasePathMappingsPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_base_path_mappings"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetBasePathMappingsPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetBasePathMappingsPaginator
3. item: BasePathMappingsTypeDef

paginate

Type annotations and code completion for GetBasePathMappingsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    domainName: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[BasePathMappingsTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See BasePathMappingsTypeDef

Usage example with kwargs

kwargs: GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef = {  # (1)
    "domainName": ...,
}

parent.paginate(**kwargs)

1. See GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef

GetClientCertificatesPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_client_certificates"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetClientCertificatesPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetClientCertificatesPaginator
3. item: ClientCertificatesTypeDef

paginate

Type annotations and code completion for GetClientCertificatesPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ClientCertificatesTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ClientCertificatesTypeDef

Usage example with kwargs

kwargs: GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef

GetDeploymentsPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_deployments"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetDeploymentsPaginator

session = Session()

session = get_session()
async with session.client("apigateway") as client:  # (1)
    paginator: GetDeploymentsPaginator = client.get_paginator("get_deployments")  # (2)
    async for item in paginator.paginate(...):
        item: DeploymentsTypeDef
        print(item)  # (3)

1. client: APIGatewayClient
2. paginator: GetDeploymentsPaginator
3. item: DeploymentsTypeDef

paginate

Type annotations and code completion for GetDeploymentsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DeploymentsTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DeploymentsTypeDef

Usage example with kwargs

kwargs: GetDeploymentsRequestGetDeploymentsPaginateTypeDef = {  # (1)
    "restApiId": ...,
}

parent.paginate(**kwargs)

1. See GetDeploymentsRequestGetDeploymentsPaginateTypeDef

GetDocumentationPartsPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_documentation_parts"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetDocumentationPartsPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetDocumentationPartsPaginator
3. item: DocumentationPartsTypeDef

paginate

Type annotations and code completion for GetDocumentationPartsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    restApiId: str,
    type: DocumentationPartTypeType = ...,  # (1)
    nameQuery: str = ...,
    path: str = ...,
    locationStatus: LocationStatusTypeType = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> AsyncIterator[DocumentationPartsTypeDef]:  # (4)
    ...

1. See DocumentationPartTypeType
2. See LocationStatusTypeType
3. See PaginatorConfigTypeDef
4. See DocumentationPartsTypeDef

Usage example with kwargs

kwargs: GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef = {  # (1)
    "restApiId": ...,
}

parent.paginate(**kwargs)

1. See GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef

GetDocumentationVersionsPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_documentation_versions"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetDocumentationVersionsPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetDocumentationVersionsPaginator
3. item: DocumentationVersionsTypeDef

paginate

Type annotations and code completion for GetDocumentationVersionsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DocumentationVersionsTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DocumentationVersionsTypeDef

Usage example with kwargs

kwargs: GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef = {  # (1)
    "restApiId": ...,
}

parent.paginate(**kwargs)

1. See GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef

GetDomainNamesPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_domain_names"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetDomainNamesPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetDomainNamesPaginator
3. item: DomainNamesTypeDef

paginate

Type annotations and code completion for GetDomainNamesPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DomainNamesTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DomainNamesTypeDef

Usage example with kwargs

kwargs: GetDomainNamesRequestGetDomainNamesPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See GetDomainNamesRequestGetDomainNamesPaginateTypeDef

GetGatewayResponsesPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_gateway_responses"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetGatewayResponsesPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetGatewayResponsesPaginator
3. item: GatewayResponsesTypeDef

paginate

Type annotations and code completion for GetGatewayResponsesPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[GatewayResponsesTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See GatewayResponsesTypeDef

Usage example with kwargs

kwargs: GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef = {  # (1)
    "restApiId": ...,
}

parent.paginate(**kwargs)

1. See GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef

GetModelsPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_models"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetModelsPaginator

session = Session()

session = get_session()
async with session.client("apigateway") as client:  # (1)
    paginator: GetModelsPaginator = client.get_paginator("get_models")  # (2)
    async for item in paginator.paginate(...):
        item: ModelsTypeDef
        print(item)  # (3)

1. client: APIGatewayClient
2. paginator: GetModelsPaginator
3. item: ModelsTypeDef

paginate

Type annotations and code completion for GetModelsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ModelsTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ModelsTypeDef

Usage example with kwargs

kwargs: GetModelsRequestGetModelsPaginateTypeDef = {  # (1)
    "restApiId": ...,
}

parent.paginate(**kwargs)

1. See GetModelsRequestGetModelsPaginateTypeDef

GetRequestValidatorsPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_request_validators"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetRequestValidatorsPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetRequestValidatorsPaginator
3. item: RequestValidatorsTypeDef

paginate

Type annotations and code completion for GetRequestValidatorsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[RequestValidatorsTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See RequestValidatorsTypeDef

Usage example with kwargs

kwargs: GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef = {  # (1)
    "restApiId": ...,
}

parent.paginate(**kwargs)

1. See GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef

GetResourcesPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_resources"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetResourcesPaginator

session = Session()

session = get_session()
async with session.client("apigateway") as client:  # (1)
    paginator: GetResourcesPaginator = client.get_paginator("get_resources")  # (2)
    async for item in paginator.paginate(...):
        item: ResourcesTypeDef
        print(item)  # (3)

1. client: APIGatewayClient
2. paginator: GetResourcesPaginator
3. item: ResourcesTypeDef

paginate

Type annotations and code completion for GetResourcesPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    restApiId: str,
    embed: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ResourcesTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ResourcesTypeDef

Usage example with kwargs

kwargs: GetResourcesRequestGetResourcesPaginateTypeDef = {  # (1)
    "restApiId": ...,
}

parent.paginate(**kwargs)

1. See GetResourcesRequestGetResourcesPaginateTypeDef

GetRestApisPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_rest_apis"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetRestApisPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetRestApisPaginator
3. item: RestApisTypeDef

paginate

Type annotations and code completion for GetRestApisPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[RestApisTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See RestApisTypeDef

Usage example with kwargs

kwargs: GetRestApisRequestGetRestApisPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See GetRestApisRequestGetRestApisPaginateTypeDef

GetSdkTypesPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_sdk_types"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetSdkTypesPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetSdkTypesPaginator
3. item: SdkTypesTypeDef

paginate

Type annotations and code completion for GetSdkTypesPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[SdkTypesTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See SdkTypesTypeDef

Usage example with kwargs

kwargs: GetSdkTypesRequestGetSdkTypesPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See GetSdkTypesRequestGetSdkTypesPaginateTypeDef

GetUsagePaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_usage"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetUsagePaginator

session = Session()

session = get_session()
async with session.client("apigateway") as client:  # (1)
    paginator: GetUsagePaginator = client.get_paginator("get_usage")  # (2)
    async for item in paginator.paginate(...):
        item: UsageTypeDef
        print(item)  # (3)

1. client: APIGatewayClient
2. paginator: GetUsagePaginator
3. item: UsageTypeDef

paginate

Type annotations and code completion for GetUsagePaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    usagePlanId: str,
    startDate: str,
    endDate: str,
    keyId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[UsageTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See UsageTypeDef

Usage example with kwargs

kwargs: GetUsageRequestGetUsagePaginateTypeDef = {  # (1)
    "usagePlanId": ...,
    "startDate": ...,
    "endDate": ...,
}

parent.paginate(**kwargs)

1. See GetUsageRequestGetUsagePaginateTypeDef

GetUsagePlanKeysPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_usage_plan_keys"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetUsagePlanKeysPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetUsagePlanKeysPaginator
3. item: UsagePlanKeysTypeDef

paginate

Type annotations and code completion for GetUsagePlanKeysPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    usagePlanId: str,
    nameQuery: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[UsagePlanKeysTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See UsagePlanKeysTypeDef

Usage example with kwargs

kwargs: GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef = {  # (1)
    "usagePlanId": ...,
}

parent.paginate(**kwargs)

1. See GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef

GetUsagePlansPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_usage_plans"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetUsagePlansPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetUsagePlansPaginator
3. item: UsagePlansTypeDef

paginate

Type annotations and code completion for GetUsagePlansPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    keyId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[UsagePlansTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See UsagePlansTypeDef

Usage example with kwargs

kwargs: GetUsagePlansRequestGetUsagePlansPaginateTypeDef = {  # (1)
    "keyId": ...,
}

parent.paginate(**kwargs)

1. See GetUsagePlansRequestGetUsagePlansPaginateTypeDef

GetVpcLinksPaginator

Type annotations and code completion for session.client("apigateway").get_paginator("get_vpc_links"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_apigateway.paginator import GetVpcLinksPaginator

session = Session()

session = get_session()
async with session.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)

1. client: APIGatewayClient
2. paginator: GetVpcLinksPaginator
3. item: VpcLinksTypeDef

paginate

Type annotations and code completion for GetVpcLinksPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[VpcLinksTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See VpcLinksTypeDef

Usage example with kwargs

kwargs: GetVpcLinksRequestGetVpcLinksPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See GetVpcLinksRequestGetVpcLinksPaginateTypeDef