Skip to content

Paginators#

Index > KMS > Paginators

Auto-generated documentation for KMS type annotations stubs module types-boto3-kms.

DescribeCustomKeyStoresPaginator#

Type annotations and code completion for boto3.client("kms").get_paginator("describe_custom_key_stores"). boto3 documentation

# DescribeCustomKeyStoresPaginator usage example

from boto3.session import Session

from types_boto3_kms.paginator import DescribeCustomKeyStoresPaginator

def get_describe_custom_key_stores_paginator() -> DescribeCustomKeyStoresPaginator:
    return Session().client("kms").get_paginator("describe_custom_key_stores")
# DescribeCustomKeyStoresPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kms.paginator import DescribeCustomKeyStoresPaginator

session = Session()

client = Session().client("kms")  # (1)
paginator: DescribeCustomKeyStoresPaginator = client.get_paginator("describe_custom_key_stores")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KMSClient
  2. paginator: DescribeCustomKeyStoresPaginator
  3. item: PageIterator[DescribeCustomKeyStoresResponseTypeDef]

paginate#

Type annotations and code completion for DescribeCustomKeyStoresPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeCustomKeyStoresRequestPaginateTypeDef = {  # (1)
    "CustomKeyStoreId": ...,
}

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

ListAliasesPaginator#

Type annotations and code completion for boto3.client("kms").get_paginator("list_aliases"). boto3 documentation

# ListAliasesPaginator usage example

from boto3.session import Session

from types_boto3_kms.paginator import ListAliasesPaginator

def get_list_aliases_paginator() -> ListAliasesPaginator:
    return Session().client("kms").get_paginator("list_aliases")
# ListAliasesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kms.paginator import ListAliasesPaginator

session = Session()

client = Session().client("kms")  # (1)
paginator: ListAliasesPaginator = client.get_paginator("list_aliases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KMSClient
  2. paginator: ListAliasesPaginator
  3. item: PageIterator[ListAliasesResponseTypeDef]

paginate#

Type annotations and code completion for ListAliasesPaginator.paginate method.

# paginate method definition

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

kwargs: ListAliasesRequestPaginateTypeDef = {  # (1)
    "KeyId": ...,
}

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

ListGrantsPaginator#

Type annotations and code completion for boto3.client("kms").get_paginator("list_grants"). boto3 documentation

# ListGrantsPaginator usage example

from boto3.session import Session

from types_boto3_kms.paginator import ListGrantsPaginator

def get_list_grants_paginator() -> ListGrantsPaginator:
    return Session().client("kms").get_paginator("list_grants")
# ListGrantsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kms.paginator import ListGrantsPaginator

session = Session()

client = Session().client("kms")  # (1)
paginator: ListGrantsPaginator = client.get_paginator("list_grants")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KMSClient
  2. paginator: ListGrantsPaginator
  3. item: PageIterator[ListGrantsResponseTypeDef]

paginate#

Type annotations and code completion for ListGrantsPaginator.paginate method.

# paginate method definition

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

kwargs: ListGrantsRequestPaginateTypeDef = {  # (1)
    "KeyId": ...,
}

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

ListKeyPoliciesPaginator#

Type annotations and code completion for boto3.client("kms").get_paginator("list_key_policies"). boto3 documentation

# ListKeyPoliciesPaginator usage example

from boto3.session import Session

from types_boto3_kms.paginator import ListKeyPoliciesPaginator

def get_list_key_policies_paginator() -> ListKeyPoliciesPaginator:
    return Session().client("kms").get_paginator("list_key_policies")
# ListKeyPoliciesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kms.paginator import ListKeyPoliciesPaginator

session = Session()

client = Session().client("kms")  # (1)
paginator: ListKeyPoliciesPaginator = client.get_paginator("list_key_policies")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KMSClient
  2. paginator: ListKeyPoliciesPaginator
  3. item: PageIterator[ListKeyPoliciesResponseTypeDef]

paginate#

Type annotations and code completion for ListKeyPoliciesPaginator.paginate method.

# paginate method definition

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

kwargs: ListKeyPoliciesRequestPaginateTypeDef = {  # (1)
    "KeyId": ...,
}

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

ListKeyRotationsPaginator#

Type annotations and code completion for boto3.client("kms").get_paginator("list_key_rotations"). boto3 documentation

# ListKeyRotationsPaginator usage example

from boto3.session import Session

from types_boto3_kms.paginator import ListKeyRotationsPaginator

def get_list_key_rotations_paginator() -> ListKeyRotationsPaginator:
    return Session().client("kms").get_paginator("list_key_rotations")
# ListKeyRotationsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kms.paginator import ListKeyRotationsPaginator

session = Session()

client = Session().client("kms")  # (1)
paginator: ListKeyRotationsPaginator = client.get_paginator("list_key_rotations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KMSClient
  2. paginator: ListKeyRotationsPaginator
  3. item: PageIterator[ListKeyRotationsResponseTypeDef]

paginate#

Type annotations and code completion for ListKeyRotationsPaginator.paginate method.

# paginate method definition

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

kwargs: ListKeyRotationsRequestPaginateTypeDef = {  # (1)
    "KeyId": ...,
}

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

ListKeysPaginator#

Type annotations and code completion for boto3.client("kms").get_paginator("list_keys"). boto3 documentation

# ListKeysPaginator usage example

from boto3.session import Session

from types_boto3_kms.paginator import ListKeysPaginator

def get_list_keys_paginator() -> ListKeysPaginator:
    return Session().client("kms").get_paginator("list_keys")
# ListKeysPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kms.paginator import ListKeysPaginator

session = Session()

client = Session().client("kms")  # (1)
paginator: ListKeysPaginator = client.get_paginator("list_keys")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KMSClient
  2. paginator: ListKeysPaginator
  3. item: PageIterator[ListKeysResponseTypeDef]

paginate#

Type annotations and code completion for ListKeysPaginator.paginate method.

# paginate method definition

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

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

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

ListResourceTagsPaginator#

Type annotations and code completion for boto3.client("kms").get_paginator("list_resource_tags"). boto3 documentation

# ListResourceTagsPaginator usage example

from boto3.session import Session

from types_boto3_kms.paginator import ListResourceTagsPaginator

def get_list_resource_tags_paginator() -> ListResourceTagsPaginator:
    return Session().client("kms").get_paginator("list_resource_tags")
# ListResourceTagsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kms.paginator import ListResourceTagsPaginator

session = Session()

client = Session().client("kms")  # (1)
paginator: ListResourceTagsPaginator = client.get_paginator("list_resource_tags")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KMSClient
  2. paginator: ListResourceTagsPaginator
  3. item: PageIterator[ListResourceTagsResponseTypeDef]

paginate#

Type annotations and code completion for ListResourceTagsPaginator.paginate method.

# paginate method definition

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

kwargs: ListResourceTagsRequestPaginateTypeDef = {  # (1)
    "KeyId": ...,
}

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

ListRetirableGrantsPaginator#

Type annotations and code completion for boto3.client("kms").get_paginator("list_retirable_grants"). boto3 documentation

# ListRetirableGrantsPaginator usage example

from boto3.session import Session

from types_boto3_kms.paginator import ListRetirableGrantsPaginator

def get_list_retirable_grants_paginator() -> ListRetirableGrantsPaginator:
    return Session().client("kms").get_paginator("list_retirable_grants")
# ListRetirableGrantsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kms.paginator import ListRetirableGrantsPaginator

session = Session()

client = Session().client("kms")  # (1)
paginator: ListRetirableGrantsPaginator = client.get_paginator("list_retirable_grants")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KMSClient
  2. paginator: ListRetirableGrantsPaginator
  3. item: PageIterator[ListGrantsResponseTypeDef]

paginate#

Type annotations and code completion for ListRetirableGrantsPaginator.paginate method.

# paginate method definition

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

kwargs: ListRetirableGrantsRequestPaginateTypeDef = {  # (1)
    "RetiringPrincipal": ...,
}

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