AWS API Changes

2021/07/30 - AWS Secrets Manager - 1 updated api methods

Changes Add support for KmsKeyIds in the ListSecretVersionIds API response

ListSecretVersionIds (updated)

Link ¶
Changes (response)

{'Versions': {'KmsKeyIds': ['string']}}

Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached.

Minimum permissions

To run this command, you must have the following permissions:

secretsmanager:ListSecretVersionIds

Related operations

To list the secrets in an account, use ListSecrets.

See also: AWS API Documentation

Request Syntax

client.list_secret_version_ids(
    SecretId='string',
    MaxResults=123,
    NextToken='string',
    IncludeDeprecated=True|False
)

type SecretId:

string

param SecretId:

[REQUIRED]

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

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.

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

type IncludeDeprecated:

boolean

param IncludeDeprecated:

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

rtype:

dict

returns:

Response Syntax

{
    'Versions': [
        {
            'VersionId': 'string',
            'VersionStages': [
                'string',
            ],
            'LastAccessedDate': datetime(2015, 1, 1),
            'CreatedDate': datetime(2015, 1, 1),
            'KmsKeyIds': [
                'string',
            ]
        },
    ],
    'NextToken': 'string',
    'ARN': 'string',
    'Name': 'string'
}

Response Structure

(dict) --
- Versions (list) --
  
  The list of the currently available versions of the specified secret.
  - (dict) --
    
    A structure that contains information about one version of a secret.
    - VersionId (string) --
      
      The unique version identifier of this version of the secret.
    - VersionStages (list) --
      
      An array of staging labels that are currently associated with this version of the secret.
      - (string) --
    - LastAccessedDate (datetime) --
      
      The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.
    - CreatedDate (datetime) --
      
      The date and time this version of the secret was created.
    - KmsKeyIds (list) --
      
      The KMS keys used to encrypt the secret version.
      - (string) --
- NextToken (string) --
  
  If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
- ARN (string) --
  
  The Amazon Resource Name (ARN) for the secret.
  
  Note
  
  Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
- Name (string) --
  
  The friendly name of the secret.