NAME

Paws::SecretsManager::ListSecretVersionIds - Arguments for method ListSecretVersionIds on Paws::SecretsManager

DESCRIPTION

This class represents the parameters used for calling the method ListSecretVersionIds on the AWS Secrets Manager service. Use the attributes of this class as arguments to method ListSecretVersionIds.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListSecretVersionIds.

SYNOPSIS

    my $secretsmanager = Paws->service('SecretsManager');
# To list all of the secret versions associated with a secret
# The following example shows how to retrieve a list of all of the versions of a
# secret, including those without any staging labels.
    my $ListSecretVersionIdsResponse = $secretsmanager->ListSecretVersionIds(
      'IncludeDeprecated' => 1,
      'SecretId'          => 'MyTestDatabaseSecret'
    );
    # Results:
    my $ARN      = $ListSecretVersionIdsResponse->ARN;
    my $Name     = $ListSecretVersionIdsResponse->Name;
    my $Versions = $ListSecretVersionIdsResponse->Versions;
    # Returns a L<Paws::SecretsManager::ListSecretVersionIdsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/ListSecretVersionIds>

ATTRIBUTES

IncludeDeprecated => Bool

(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.

MaxResults => Int

(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.

NextToken => Str

(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.

REQUIRED SecretId => Str

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.

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.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>