Skip to content

BatchGetSecretValueRequest

Source code in docs_src/capo_secrets_manager/types/batch_get_secret_value_request.py
class BatchGetSecretValueRequest(TypedDict, closed=True):
    secret_id_list: NotRequired[
        "capo_secrets_manager.types.secret_id_list_type.SecretIdListType"
    ]
    """<p>The ARN or names of the secrets to retrieve. You must include <code>Filters</code> or <code>SecretIdList</code>, but not both.</p>"""
    filters: NotRequired["capo_secrets_manager.types.filters_list_type.FiltersListType"]
    """<p>The filters to choose which secrets to retrieve. You must include <code>Filters</code> or <code>SecretIdList</code>, but not both.</p>"""
    max_results: NotRequired[
        "capo_secrets_manager.types.max_results_batch_type.MaxResultsBatchType"
    ]
    """<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>BatchGetSecretValue</code> again with the value from <code>NextToken</code>. To use this parameter, you must also use the <code>Filters</code> parameter.</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>BatchGetSecretValue</code> again with this value.</p>"""

filters instance-attribute

filters: NotRequired[FiltersListType]

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

max_results instance-attribute

max_results: NotRequired[MaxResultsBatchType]

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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

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 BatchGetSecretValue again with this value.

secret_id_list instance-attribute

secret_id_list: NotRequired[SecretIdListType]

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.