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: DomainNamesTypeDef

paginate#

Type annotations and code completion for GetDomainNamesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DomainNamesTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DomainNamesTypeDef 
# 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

GetModelsPaginator#

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

# GetModelsPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetModelsPaginator

def get_get_models_paginator() -> GetModelsPaginator:
    return Session().client("apigateway").get_paginator("get_models")
# GetModelsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetModelsPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetModelsPaginator = client.get_paginator("get_models")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetModelsPaginator
  3. item: ModelsTypeDef

paginate#

Type annotations and code completion for GetModelsPaginator.paginate method.

# paginate method definition

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

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

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

GetRequestValidatorsPaginator#

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

# GetRequestValidatorsPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetRequestValidatorsPaginator

def get_get_request_validators_paginator() -> GetRequestValidatorsPaginator:
    return Session().client("apigateway").get_paginator("get_request_validators")
# GetRequestValidatorsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetRequestValidatorsPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetRequestValidatorsPaginator = client.get_paginator("get_request_validators")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetRequestValidatorsPaginator
  3. item: RequestValidatorsTypeDef

paginate#

Type annotations and code completion for GetRequestValidatorsPaginator.paginate method.

# paginate method definition

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

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

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

GetResourcesPaginator#

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

# GetResourcesPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetResourcesPaginator

def get_get_resources_paginator() -> GetResourcesPaginator:
    return Session().client("apigateway").get_paginator("get_resources")
# GetResourcesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetResourcesPaginator

session = Session()

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

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

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

GetRestApisPaginator#

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

# GetRestApisPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetRestApisPaginator

def get_get_rest_apis_paginator() -> GetRestApisPaginator:
    return Session().client("apigateway").get_paginator("get_rest_apis")
# GetRestApisPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetRestApisPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetRestApisPaginator = client.get_paginator("get_rest_apis")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetRestApisPaginator
  3. item: RestApisTypeDef

paginate#

Type annotations and code completion for GetRestApisPaginator.paginate method.

# paginate method definition

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

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

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

GetSdkTypesPaginator#

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

# GetSdkTypesPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetSdkTypesPaginator

def get_get_sdk_types_paginator() -> GetSdkTypesPaginator:
    return Session().client("apigateway").get_paginator("get_sdk_types")
# GetSdkTypesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetSdkTypesPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetSdkTypesPaginator = client.get_paginator("get_sdk_types")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetSdkTypesPaginator
  3. item: SdkTypesTypeDef

paginate#

Type annotations and code completion for GetSdkTypesPaginator.paginate method.

# paginate method definition

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

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

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

GetUsagePaginator#

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

# GetUsagePaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetUsagePaginator

def get_get_usage_paginator() -> GetUsagePaginator:
    return Session().client("apigateway").get_paginator("get_usage")
# GetUsagePaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetUsagePaginator

session = Session()

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

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

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

GetUsagePlanKeysPaginator#

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

# GetUsagePlanKeysPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetUsagePlanKeysPaginator

def get_get_usage_plan_keys_paginator() -> GetUsagePlanKeysPaginator:
    return Session().client("apigateway").get_paginator("get_usage_plan_keys")
# GetUsagePlanKeysPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetUsagePlanKeysPaginator

session = Session()

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

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

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

GetUsagePlansPaginator#

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

# GetUsagePlansPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetUsagePlansPaginator

def get_get_usage_plans_paginator() -> GetUsagePlansPaginator:
    return Session().client("apigateway").get_paginator("get_usage_plans")
# GetUsagePlansPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetUsagePlansPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetUsagePlansPaginator = client.get_paginator("get_usage_plans")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetUsagePlansPaginator
  3. item: UsagePlansTypeDef

paginate#

Type annotations and code completion for GetUsagePlansPaginator.paginate method.

# paginate method definition

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

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

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

GetVpcLinksPaginator#

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

# GetVpcLinksPaginator usage example

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetVpcLinksPaginator

def get_get_vpc_links_paginator() -> GetVpcLinksPaginator:
    return Session().client("apigateway").get_paginator("get_vpc_links")
# GetVpcLinksPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigateway.paginator import GetVpcLinksPaginator

session = Session()

client = Session().client("apigateway")  # (1)
paginator: GetVpcLinksPaginator = client.get_paginator("get_vpc_links")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: APIGatewayClient
  2. paginator: GetVpcLinksPaginator
  3. item: VpcLinksTypeDef

paginate#

Type annotations and code completion for GetVpcLinksPaginator.paginate method.

# paginate method definition

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

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

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