Skip to content

Paginators#

Index > APIGateway > Paginators

Auto-generated documentation for APIGateway type annotations stubs module mypy-boto3-apigateway.

GetApiKeysPaginator#

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

# GetApiKeysPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetApiKeysPaginator

def get_get_api_keys_paginator() -> GetApiKeysPaginator:
    return Session().client("apigateway").get_paginator("get_api_keys")
# GetApiKeysPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetApiKeysPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetApiKeysPaginator = client.get_paginator("get_api_keys")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetApiKeysPaginator
  3. 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)
) -> _PageIterator[ApiKeysTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ApiKeysTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetApiKeysRequestGetApiKeysPaginateTypeDef

GetAuthorizersPaginator#

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

# GetAuthorizersPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetAuthorizersPaginator

def get_get_authorizers_paginator() -> GetAuthorizersPaginator:
    return Session().client("apigateway").get_paginator("get_authorizers")
# GetAuthorizersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetAuthorizersPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetAuthorizersPaginator = client.get_paginator("get_authorizers")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetAuthorizersPaginator
  3. item: AuthorizersTypeDef

paginate#

Type annotations and code completion for GetAuthorizersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[AuthorizersTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AuthorizersTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetAuthorizersRequestGetAuthorizersPaginateTypeDef

GetBasePathMappingsPaginator#

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

# GetBasePathMappingsPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetBasePathMappingsPaginator

def get_get_base_path_mappings_paginator() -> GetBasePathMappingsPaginator:
    return Session().client("apigateway").get_paginator("get_base_path_mappings")
# GetBasePathMappingsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetBasePathMappingsPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetBasePathMappingsPaginator = client.get_paginator("get_base_path_mappings")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetBasePathMappingsPaginator
  3. item: BasePathMappingsTypeDef

paginate#

Type annotations and code completion for GetBasePathMappingsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    domainName: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[BasePathMappingsTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See BasePathMappingsTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef

GetClientCertificatesPaginator#

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

# GetClientCertificatesPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetClientCertificatesPaginator

def get_get_client_certificates_paginator() -> GetClientCertificatesPaginator:
    return Session().client("apigateway").get_paginator("get_client_certificates")
# GetClientCertificatesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetClientCertificatesPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetClientCertificatesPaginator = client.get_paginator("get_client_certificates")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetClientCertificatesPaginator
  3. item: ClientCertificatesTypeDef

paginate#

Type annotations and code completion for GetClientCertificatesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ClientCertificatesTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ClientCertificatesTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef

GetDeploymentsPaginator#

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

# GetDeploymentsPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetDeploymentsPaginator

def get_get_deployments_paginator() -> GetDeploymentsPaginator:
    return Session().client("apigateway").get_paginator("get_deployments")
# GetDeploymentsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetDeploymentsPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetDeploymentsPaginator = client.get_paginator("get_deployments")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetDeploymentsPaginator
  3. item: DeploymentsTypeDef

paginate#

Type annotations and code completion for GetDeploymentsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DeploymentsTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DeploymentsTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetDeploymentsRequestGetDeploymentsPaginateTypeDef

GetDocumentationPartsPaginator#

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

# GetDocumentationPartsPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetDocumentationPartsPaginator

def get_get_documentation_parts_paginator() -> GetDocumentationPartsPaginator:
    return Session().client("apigateway").get_paginator("get_documentation_parts")
# GetDocumentationPartsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetDocumentationPartsPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetDocumentationPartsPaginator = client.get_paginator("get_documentation_parts")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetDocumentationPartsPaginator
  3. 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)
) -> _PageIterator[DocumentationPartsTypeDef]:  # (4)
    ...
  1. See DocumentationPartTypeType
  2. See LocationStatusTypeType
  3. See PaginatorConfigTypeDef
  4. See DocumentationPartsTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef

GetDocumentationVersionsPaginator#

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

# GetDocumentationVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetDocumentationVersionsPaginator

def get_get_documentation_versions_paginator() -> GetDocumentationVersionsPaginator:
    return Session().client("apigateway").get_paginator("get_documentation_versions")
# GetDocumentationVersionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetDocumentationVersionsPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetDocumentationVersionsPaginator = client.get_paginator("get_documentation_versions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetDocumentationVersionsPaginator
  3. item: DocumentationVersionsTypeDef

paginate#

Type annotations and code completion for GetDocumentationVersionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DocumentationVersionsTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DocumentationVersionsTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef

GetDomainNamesPaginator#

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

# GetDomainNamesPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetDomainNamesPaginator

def get_get_domain_names_paginator() -> GetDomainNamesPaginator:
    return Session().client("apigateway").get_paginator("get_domain_names")
# GetDomainNamesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetDomainNamesPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetDomainNamesPaginator = client.get_paginator("get_domain_names")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetDomainNamesPaginator
  3. item: DomainNamesPaginatorTypeDef

paginate#

Type annotations and code completion for GetDomainNamesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DomainNamesPaginatorTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DomainNamesPaginatorTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetDomainNamesRequestGetDomainNamesPaginateTypeDef

GetGatewayResponsesPaginator#

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

# GetGatewayResponsesPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetGatewayResponsesPaginator

def get_get_gateway_responses_paginator() -> GetGatewayResponsesPaginator:
    return Session().client("apigateway").get_paginator("get_gateway_responses")
# GetGatewayResponsesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetGatewayResponsesPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetGatewayResponsesPaginator = client.get_paginator("get_gateway_responses")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetGatewayResponsesPaginator
  3. item: GatewayResponsesTypeDef

paginate#

Type annotations and code completion for GetGatewayResponsesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    restApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[GatewayResponsesTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See GatewayResponsesTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef

GetModelsP