Skip to content

Paginators#

Index > CloudFormation > Paginators

Auto-generated documentation for CloudFormation type annotations stubs module mypy-boto3-cloudformation.

DescribeAccountLimitsPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("describe_account_limits"). boto3 documentation

# DescribeAccountLimitsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import DescribeAccountLimitsPaginator

def get_describe_account_limits_paginator() -> DescribeAccountLimitsPaginator:
    return Session().client("cloudformation").get_paginator("describe_account_limits")
# DescribeAccountLimitsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import DescribeAccountLimitsPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: DescribeAccountLimitsPaginator = client.get_paginator("describe_account_limits")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: DescribeAccountLimitsPaginator
  3. item: DescribeAccountLimitsOutputTypeDef

paginate#

Type annotations and code completion for DescribeAccountLimitsPaginator.paginate method.

# paginate method definition

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

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

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

DescribeChangeSetPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("describe_change_set"). boto3 documentation

# DescribeChangeSetPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import DescribeChangeSetPaginator

def get_describe_change_set_paginator() -> DescribeChangeSetPaginator:
    return Session().client("cloudformation").get_paginator("describe_change_set")
# DescribeChangeSetPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import DescribeChangeSetPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: DescribeChangeSetPaginator = client.get_paginator("describe_change_set")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: DescribeChangeSetPaginator
  3. item: DescribeChangeSetOutputTypeDef

paginate#

Type annotations and code completion for DescribeChangeSetPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeChangeSetInputDescribeChangeSetPaginateTypeDef = {  # (1)
    "ChangeSetName": ...,
}

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

DescribeStackEventsPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("describe_stack_events"). boto3 documentation

# DescribeStackEventsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import DescribeStackEventsPaginator

def get_describe_stack_events_paginator() -> DescribeStackEventsPaginator:
    return Session().client("cloudformation").get_paginator("describe_stack_events")
# DescribeStackEventsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import DescribeStackEventsPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: DescribeStackEventsPaginator = client.get_paginator("describe_stack_events")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: DescribeStackEventsPaginator
  3. item: DescribeStackEventsOutputTypeDef

paginate#

Type annotations and code completion for DescribeStackEventsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeStackEventsInputDescribeStackEventsPaginateTypeDef = {  # (1)
    "StackName": ...,
}

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

DescribeStacksPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("describe_stacks"). boto3 documentation

# DescribeStacksPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import DescribeStacksPaginator

def get_describe_stacks_paginator() -> DescribeStacksPaginator:
    return Session().client("cloudformation").get_paginator("describe_stacks")
# DescribeStacksPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import DescribeStacksPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: DescribeStacksPaginator = client.get_paginator("describe_stacks")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: DescribeStacksPaginator
  3. item: DescribeStacksOutputTypeDef

paginate#

Type annotations and code completion for DescribeStacksPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeStacksInputDescribeStacksPaginateTypeDef = {  # (1)
    "StackName": ...,
}

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

ListChangeSetsPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_change_sets"). boto3 documentation

# ListChangeSetsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListChangeSetsPaginator

def get_list_change_sets_paginator() -> ListChangeSetsPaginator:
    return Session().client("cloudformation").get_paginator("list_change_sets")
# ListChangeSetsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListChangeSetsPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListChangeSetsPaginator = client.get_paginator("list_change_sets")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListChangeSetsPaginator
  3. item: ListChangeSetsOutputTypeDef

paginate#

Type annotations and code completion for ListChangeSetsPaginator.paginate method.

# paginate method definition

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

kwargs: ListChangeSetsInputListChangeSetsPaginateTypeDef = {  # (1)
    "StackName": ...,
}

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

ListExportsPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_exports"). boto3 documentation

# ListExportsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListExportsPaginator

def get_list_exports_paginator() -> ListExportsPaginator:
    return Session().client("cloudformation").get_paginator("list_exports")
# ListExportsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListExportsPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListExportsPaginator = client.get_paginator("list_exports")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListExportsPaginator
  3. item: ListExportsOutputTypeDef

paginate#

Type annotations and code completion for ListExportsPaginator.paginate method.

# paginate method definition

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

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

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

ListImportsPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_imports"). boto3 documentation

# ListImportsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListImportsPaginator

def get_list_imports_paginator() -> ListImportsPaginator:
    return Session().client("cloudformation").get_paginator("list_imports")
# ListImportsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListImportsPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListImportsPaginator = client.get_paginator("list_imports")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListImportsPaginator
  3. item: ListImportsOutputTypeDef

paginate#

Type annotations and code completion for ListImportsPaginator.paginate method.

# paginate method definition

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

kwargs: ListImportsInputListImportsPaginateTypeDef = {  # (1)
    "ExportName": ...,
}

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

ListStackInstancesPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_stack_instances"). boto3 documentation

# ListStackInstancesPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackInstancesPaginator

def get_list_stack_instances_paginator() -> ListStackInstancesPaginator:
    return Session().client("cloudformation").get_paginator("list_stack_instances")
# ListStackInstancesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackInstancesPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListStackInstancesPaginator = client.get_paginator("list_stack_instances")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListStackInstancesPaginator
  3. item: ListStackInstancesOutputTypeDef

paginate#

Type annotations and code completion for ListStackInstancesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    StackSetName: str,
    Filters: Sequence[StackInstanceFilterTypeDef] = ...,  # (1)
    StackInstanceAccount: str = ...,
    StackInstanceRegion: str = ...,
    CallAs: CallAsType = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> _PageIterator[ListStackInstancesOutputTypeDef]:  # (4)
    ...
  1. See StackInstanceFilterTypeDef
  2. See CallAsType
  3. See PaginatorConfigTypeDef
  4. See ListStackInstancesOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListStackInstancesInputListStackInstancesPaginateTypeDef = {  # (1)
    "StackSetName": ...,
}

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

ListStackResourcesPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_stack_resources"). boto3 documentation

# ListStackResourcesPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackResourcesPaginator

def get_list_stack_resources_paginator() -> ListStackResourcesPaginator:
    return Session().client("cloudformation").get_paginator("list_stack_resources")
# ListStackResourcesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackResourcesPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListStackResourcesPaginator = client.get_paginator("list_stack_resources")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListStackResourcesPaginator
  3. item: ListStackResourcesOutputTypeDef

paginate#

Type annotations and code completion for ListStackResourcesPaginator.paginate method.

# paginate method definition

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

kwargs: ListStackResourcesInputListStackResourcesPaginateTypeDef = {  # (1)
    "StackName": ...,
}

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

ListStackSetOperationResultsPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_stack_set_operation_results"). boto3 documentation

# ListStackSetOperationResultsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackSetOperationResultsPaginator

def get_list_stack_set_operation_results_paginator() -> ListStackSetOperationResultsPaginator:
    return Session().client("cloudformation").get_paginator("list_stack_set_operation_results")
# ListStackSetOperationResultsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackSetOperationResultsPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListStackSetOperationResultsPaginator = client.get_paginator("list_stack_set_operation_results")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListStackSetOperationResultsPaginator
  3. item: ListStackSetOperationResultsOutputTypeDef

paginate#

Type annotations and code completion for ListStackSetOperationResultsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    StackSetName: str,
    OperationId: str,
    CallAs: CallAsType = ...,  # (1)
    Filters: Sequence[OperationResultFilterTypeDef] = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> _PageIterator[ListStackSetOperationResultsOutputTypeDef]:  # (4)
    ...
  1. See CallAsType
  2. See OperationResultFilterTypeDef
  3. See PaginatorConfigTypeDef
  4. See ListStackSetOperationResultsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListStackSetOperationResultsInputListStackSetOperationResultsPaginateTypeDef = {  # (1)
    "StackSetName": ...,
    "OperationId": ...,
}

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

ListStackSetOperationsPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_stack_set_operations"). boto3 documentation

# ListStackSetOperationsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackSetOperationsPaginator

def get_list_stack_set_operations_paginator() -> ListStackSetOperationsPaginator:
    return Session().client("cloudformation").get_paginator("list_stack_set_operations")
# ListStackSetOperationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackSetOperationsPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListStackSetOperationsPaginator = client.get_paginator("list_stack_set_operations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListStackSetOperationsPaginator
  3. item: ListStackSetOperationsOutputTypeDef

paginate#

Type annotations and code completion for ListStackSetOperationsPaginator.paginate method.

# paginate method definition

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

kwargs: ListStackSetOperationsInputListStackSetOperationsPaginateTypeDef = {  # (1)
    "StackSetName": ...,
}

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

ListStackSetsPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_stack_sets"). boto3 documentation

# ListStackSetsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackSetsPaginator

def get_list_stack_sets_paginator() -> ListStackSetsPaginator:
    return Session().client("cloudformation").get_paginator("list_stack_sets")
# ListStackSetsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStackSetsPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListStackSetsPaginator = client.get_paginator("list_stack_sets")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListStackSetsPaginator
  3. item: ListStackSetsOutputTypeDef

paginate#

Type annotations and code completion for ListStackSetsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Status: StackSetStatusType = ...,  # (1)
    CallAs: CallAsType = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> _PageIterator[ListStackSetsOutputTypeDef]:  # (4)
    ...
  1. See StackSetStatusType
  2. See CallAsType
  3. See PaginatorConfigTypeDef
  4. See ListStackSetsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListStackSetsInputListStackSetsPaginateTypeDef = {  # (1)
    "Status": ...,
}

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

ListStacksPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_stacks"). boto3 documentation

# ListStacksPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStacksPaginator

def get_list_stacks_paginator() -> ListStacksPaginator:
    return Session().client("cloudformation").get_paginator("list_stacks")
# ListStacksPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListStacksPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListStacksPaginator = client.get_paginator("list_stacks")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListStacksPaginator
  3. item: ListStacksOutputTypeDef

paginate#

Type annotations and code completion for ListStacksPaginator.paginate method.

# paginate method definition

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

kwargs: ListStacksInputListStacksPaginateTypeDef = {  # (1)
    "StackStatusFilter": ...,
}

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

ListTypesPaginator#

Type annotations and code completion for boto3.client("cloudformation").get_paginator("list_types"). boto3 documentation

# ListTypesPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListTypesPaginator

def get_list_types_paginator() -> ListTypesPaginator:
    return Session().client("cloudformation").get_paginator("list_types")
# ListTypesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import ListTypesPaginator

session = Session()

client = Session().client("cloudformation")  # (1)
paginator: ListTypesPaginator = client.get_paginator("list_types")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CloudFormationClient
  2. paginator: ListTypesPaginator
  3. item: ListTypesOutputTypeDef

paginate#

Type annotations and code completion for ListTypesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Visibility: VisibilityType = ...,  # (1)
    ProvisioningType: ProvisioningTypeType = ...,  # (2)
    DeprecatedStatus: DeprecatedStatusType = ...,  # (3)
    Type: RegistryTypeType = ...,  # (4)
    Filters: TypeFiltersTypeDef = ...,  # (5)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (6)
) -> _PageIterator[ListTypesOutputTypeDef]:  # (7)
    ...
  1. See VisibilityType
  2. See ProvisioningTypeType
  3. See DeprecatedStatusType
  4. See RegistryTypeType
  5. See TypeFiltersTypeDef
  6. See PaginatorConfigTypeDef
  7. See ListTypesOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListTypesInputListTypesPaginateTypeDef = {  # (1)
    "Visibility": ...,
}

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