Skip to content

Paginators#

Index > ApiGatewayV2 > Paginators

Auto-generated documentation for ApiGatewayV2 type annotations stubs module types-boto3-apigatewayv2.

GetApisPaginator#

Type annotations and code completion for boto3.client("apigatewayv2").get_paginator("get_apis"). boto3 documentation

# GetApisPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetApisPaginator

def get_get_apis_paginator() -> GetApisPaginator:
    return Session().client("apigatewayv2").get_paginator("get_apis")
# GetApisPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetApisPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetApisPaginator = client.get_paginator("get_apis")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetApisPaginator
  3. item: PageIterator[GetApisResponseTypeDef]

paginate#

Type annotations and code completion for GetApisPaginator.paginate method.

# paginate method definition

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

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

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

GetAuthorizersPaginator#

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

# GetAuthorizersPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetAuthorizersPaginator

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

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetAuthorizersPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetAuthorizersPaginator = client.get_paginator("get_authorizers")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetAuthorizersPaginator
  3. item: PageIterator[GetAuthorizersResponseTypeDef]

paginate#

Type annotations and code completion for GetAuthorizersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetAuthorizersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetAuthorizersResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetAuthorizersRequestPaginateTypeDef = {  # (1)
    "ApiId": ...,
}

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

GetDeploymentsPaginator#

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

# GetDeploymentsPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetDeploymentsPaginator

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

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetDeploymentsPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetDeploymentsPaginator = client.get_paginator("get_deployments")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetDeploymentsPaginator
  3. item: PageIterator[GetDeploymentsResponseTypeDef]

paginate#

Type annotations and code completion for GetDeploymentsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetDeploymentsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetDeploymentsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetDeploymentsRequestPaginateTypeDef = {  # (1)
    "ApiId": ...,
}

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

GetDomainNamesPaginator#

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

# GetDomainNamesPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetDomainNamesPaginator

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

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetDomainNamesPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetDomainNamesPaginator = client.get_paginator("get_domain_names")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetDomainNamesPaginator
  3. item: PageIterator[GetDomainNamesResponseTypeDef]

paginate#

Type annotations and code completion for GetDomainNamesPaginator.paginate method.

# paginate method definition

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

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

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

GetIntegrationResponsesPaginator#

Type annotations and code completion for boto3.client("apigatewayv2").get_paginator("get_integration_responses"). boto3 documentation

# GetIntegrationResponsesPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetIntegrationResponsesPaginator

def get_get_integration_responses_paginator() -> GetIntegrationResponsesPaginator:
    return Session().client("apigatewayv2").get_paginator("get_integration_responses")
# GetIntegrationResponsesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetIntegrationResponsesPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetIntegrationResponsesPaginator = client.get_paginator("get_integration_responses")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetIntegrationResponsesPaginator
  3. item: PageIterator[GetIntegrationResponsesResponseTypeDef]

paginate#

Type annotations and code completion for GetIntegrationResponsesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ApiId: str,
    IntegrationId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetIntegrationResponsesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetIntegrationResponsesResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetIntegrationResponsesRequestPaginateTypeDef = {  # (1)
    "ApiId": ...,
    "IntegrationId": ...,
}

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

GetIntegrationsPaginator#

Type annotations and code completion for boto3.client("apigatewayv2").get_paginator("get_integrations"). boto3 documentation

# GetIntegrationsPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetIntegrationsPaginator

def get_get_integrations_paginator() -> GetIntegrationsPaginator:
    return Session().client("apigatewayv2").get_paginator("get_integrations")
# GetIntegrationsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetIntegrationsPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetIntegrationsPaginator = client.get_paginator("get_integrations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetIntegrationsPaginator
  3. item: PageIterator[GetIntegrationsResponseTypeDef]

paginate#

Type annotations and code completion for GetIntegrationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetIntegrationsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetIntegrationsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetIntegrationsRequestPaginateTypeDef = {  # (1)
    "ApiId": ...,
}

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

GetModelsPaginator#

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

# GetModelsPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetModelsPaginator

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

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetModelsPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetModelsPaginator = client.get_paginator("get_models")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetModelsPaginator
  3. item: PageIterator[GetModelsResponseTypeDef]

paginate#

Type annotations and code completion for GetModelsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetModelsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetModelsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetModelsRequestPaginateTypeDef = {  # (1)
    "ApiId": ...,
}

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

GetRouteResponsesPaginator#

Type annotations and code completion for boto3.client("apigatewayv2").get_paginator("get_route_responses"). boto3 documentation

# GetRouteResponsesPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetRouteResponsesPaginator

def get_get_route_responses_paginator() -> GetRouteResponsesPaginator:
    return Session().client("apigatewayv2").get_paginator("get_route_responses")
# GetRouteResponsesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetRouteResponsesPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetRouteResponsesPaginator = client.get_paginator("get_route_responses")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetRouteResponsesPaginator
  3. item: PageIterator[GetRouteResponsesResponseTypeDef]

paginate#

Type annotations and code completion for GetRouteResponsesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ApiId: str,
    RouteId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetRouteResponsesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetRouteResponsesResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetRouteResponsesRequestPaginateTypeDef = {  # (1)
    "ApiId": ...,
    "RouteId": ...,
}

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

GetRoutesPaginator#

Type annotations and code completion for boto3.client("apigatewayv2").get_paginator("get_routes"). boto3 documentation

# GetRoutesPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetRoutesPaginator

def get_get_routes_paginator() -> GetRoutesPaginator:
    return Session().client("apigatewayv2").get_paginator("get_routes")
# GetRoutesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetRoutesPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetRoutesPaginator = client.get_paginator("get_routes")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetRoutesPaginator
  3. item: PageIterator[GetRoutesResponseTypeDef]

paginate#

Type annotations and code completion for GetRoutesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetRoutesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetRoutesResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetRoutesRequestPaginateTypeDef = {  # (1)
    "ApiId": ...,
}

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

GetStagesPaginator#

Type annotations and code completion for boto3.client("apigatewayv2").get_paginator("get_stages"). boto3 documentation

# GetStagesPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetStagesPaginator

def get_get_stages_paginator() -> GetStagesPaginator:
    return Session().client("apigatewayv2").get_paginator("get_stages")
# GetStagesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import GetStagesPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: GetStagesPaginator = client.get_paginator("get_stages")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: GetStagesPaginator
  3. item: PageIterator[GetStagesResponseTypeDef]

paginate#

Type annotations and code completion for GetStagesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ApiId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetStagesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetStagesResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetStagesRequestPaginateTypeDef = {  # (1)
    "ApiId": ...,
}

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

ListRoutingRulesPaginator#

Type annotations and code completion for boto3.client("apigatewayv2").get_paginator("list_routing_rules"). boto3 documentation

# ListRoutingRulesPaginator usage example

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import ListRoutingRulesPaginator

def get_list_routing_rules_paginator() -> ListRoutingRulesPaginator:
    return Session().client("apigatewayv2").get_paginator("list_routing_rules")
# ListRoutingRulesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_apigatewayv2.paginator import ListRoutingRulesPaginator

session = Session()

client = Session().client("apigatewayv2")  # (1)
paginator: ListRoutingRulesPaginator = client.get_paginator("list_routing_rules")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ApiGatewayV2Client
  2. paginator: ListRoutingRulesPaginator
  3. item: PageIterator[ListRoutingRulesResponseTypeDef]

paginate#

Type annotations and code completion for ListRoutingRulesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DomainName: str,
    DomainNameId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListRoutingRulesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[ListRoutingRulesResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListRoutingRulesRequestPaginateTypeDef = {  # (1)
    "DomainName": ...,
}

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