class Aws::SecretsManager::Types::ListSecretVersionIdsRequest

@note When making an API call, you may pass ListSecretVersionIdsRequest

data as a hash:

    {
      secret_id: "SecretIdType", # required
      max_results: 1,
      next_token: "NextTokenType",
      include_deprecated: false,
    }

@!attribute [rw] secret_id

The identifier for the secret containing the versions you want to
list. You can specify either the Amazon Resource Name (ARN) or the
friendly name of the secret.

<note markdown="1"> If you specify an ARN, we generally recommend that you specify a
complete ARN. You can specify a partial ARN too—for example, if you
don’t include the final hyphen and six random characters that
Secrets Manager adds at the end of the ARN when you created the
secret. A partial ARN match can work as long as it uniquely matches
only one secret. However, if your secret has a name that ends in a
hyphen followed by six characters (before Secrets Manager adds the
hyphen and six characters to the ARN) and you try to use that as a
partial ARN, then those characters cause Secrets Manager to assume
that you’re specifying a complete ARN. This confusion can cause
unexpected results. To avoid this situation, we recommend that you
don’t create secret names ending with a hyphen followed by six
characters.

 If you specify an incomplete ARN without the random suffix, and
instead provide the 'friendly name', you *must* not include the
random suffix. If you do include the random suffix added by Secrets
Manager, you receive either a *ResourceNotFoundException* or an
*AccessDeniedException* error, depending on your permissions.

 </note>
@return [String]

@!attribute [rw] max_results

(Optional) Limits the number of results you want to include in the
response. If you don't include this parameter, it defaults to a
value that's specific to the operation. If additional items exist
beyond the maximum you specify, the `NextToken` response element is
present and has a value (isn't null). Include that value as the
`NextToken` request parameter in the next call to the operation to
get the next part of the results. Note that Secrets Manager might
return fewer results than the maximum even when there are more
results available. You should check `NextToken` after every
operation to ensure that you receive all of the results.
@return [Integer]

@!attribute [rw] next_token

(Optional) Use this parameter in a request if you receive a
`NextToken` response in a previous request indicating there's more
output available. In a subsequent call, set it to the value of the
previous call `NextToken` response to indicate where the output
should continue from.
@return [String]

@!attribute [rw] include_deprecated

(Optional) Specifies that you want the results to include versions
that do not have any staging labels attached to them. Such versions
are considered deprecated and are subject to deletion by Secrets
Manager as needed.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ListSecretVersionIdsRequest AWS API Documentation

Constants

SENSITIVE