Paginators

Index > SecretsManager > Paginators

Auto-generated documentation for SecretsManager type annotations stubs module types-boto3-secretsmanager.

ListSecretsPaginator

Type annotations and code completion for boto3.client("secretsmanager").get_paginator("list_secrets"). boto3 documentation

# ListSecretsPaginator usage example

from boto3.session import Session

from types_boto3_secretsmanager.paginator import ListSecretsPaginator

def get_list_secrets_paginator() -> ListSecretsPaginator:
    return Session().client("secretsmanager").get_paginator("list_secrets")

# ListSecretsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_secretsmanager.paginator import ListSecretsPaginator

session = Session()

client = Session().client("secretsmanager")  # (1)
paginator: ListSecretsPaginator = client.get_paginator("list_secrets")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SecretsManagerClient
2. paginator: ListSecretsPaginator
3. item: PageIterator[ListSecretsResponseTypeDef]

paginate

Type annotations and code completion for ListSecretsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    IncludePlannedDeletion: bool = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    SortOrder: SortOrderTypeType = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> botocore.paginate.PageIterator[ListSecretsResponseTypeDef]:  # (4)
    ...

1. See Sequence[FilterTypeDef]
2. See SortOrderTypeType
3. See PaginatorConfigTypeDef
4. See PageIterator[ListSecretsResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListSecretsRequestPaginateTypeDef = {  # (1)
    "IncludePlannedDeletion": ...,
}

parent.paginate(**kwargs)

1. See ListSecretsRequestPaginateTypeDef