Skip to content

ListSecretsRequest

Source code in docs_src/capo_secrets_manager/types/list_secrets_request.py
class ListSecretsRequest(TypedDict, closed=True):
    include_planned_deletion: NotRequired[
        "capo_secrets_manager.types.boolean_type.BooleanType"
    ]
    """<p>Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.</p>"""
    max_results: NotRequired[
        "capo_secrets_manager.types.max_results_type.MaxResultsType"
    ]
    """<p>The number of results to include in the response.</p> <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>. To get the next results, call <code>ListSecrets</code> again with the value from <code>NextToken</code>.</p>"""
    next_token: NotRequired["capo_secrets_manager.types.next_token_type.NextTokenType"]
    """<p>A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call <code>ListSecrets</code> again with this value.</p>"""
    filters: NotRequired["capo_secrets_manager.types.filters_list_type.FiltersListType"]
    """<p>The filters to apply to the list of secrets.</p>"""
    sort_order: NotRequired["capo_secrets_manager.types.sort_order_type.SortOrderType"]
    """<p>Secrets are listed by <code>CreatedDate</code>. </p>"""
    sort_by: NotRequired["capo_secrets_manager.types.sort_by_type.SortByType"]
    """<p>If not specified, secrets are listed by <code>CreatedDate</code>.</p>"""

filters instance-attribute

filters: NotRequired[FiltersListType]

The filters to apply to the list of secrets.

include_planned_deletion instance-attribute

include_planned_deletion: NotRequired[BooleanType]

Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

max_results instance-attribute

max_results: NotRequired[MaxResultsType]

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.

next_token instance-attribute

next_token: NotRequired[NextTokenType]

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.

sort_by instance-attribute

sort_by: NotRequired[SortByType]

If not specified, secrets are listed by CreatedDate.

sort_order instance-attribute

sort_order: NotRequired[SortOrderType]

Secrets are listed by CreatedDate.