SecretsManager / Client / get_secret_value

get_secret_value

SecretsManager.Client.get_secret_value(**kwargs)

Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.

To retrieve the values for a group of secrets, call BatchGetSecretValue.

We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications.

To retrieve the previous version of a secret, use VersionStage and specify AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:GetSecretValue. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for that key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_secret_value(
    SecretId='string',
    VersionId='string',
    VersionStage='string'
)

Parameters:

• SecretId (string) –

  [REQUIRED]

  The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.

  For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

• VersionId (string) –

  The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don’t specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version.

  This value is typically a UUID-type value with 32 hexadecimal digits.

• VersionStage (string) –

  The staging label of the version of the secret to retrieve.

  Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId, the two parameters must refer to the same secret version. If you don’t specify either a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT version.

Return type:

dict

Returns:

Response Syntax

{
    'ARN': 'string',
    'Name': 'string',
    'VersionId': 'string',
    'SecretBinary': b'bytes',
    'SecretString': 'string',
    'VersionStages': [
        'string',
    ],
    'CreatedDate': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • ARN (string) –

    The ARN of the secret.

  • Name (string) –

    The friendly name of the secret.

  • VersionId (string) –

    The unique identifier of this version of the secret.

  • SecretBinary (bytes) –

    The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.

    If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.

    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

  • SecretString (string) –

    The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.

    If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.

    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

  • VersionStages (list) –

    A list of all of the staging labels currently attached to this version of the secret.

    • (string) –

  • CreatedDate (datetime) –

    The date and time that this version of the secret was created. If you don’t specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.

Exceptions

• SecretsManager.Client.exceptions.ResourceNotFoundException

• SecretsManager.Client.exceptions.InvalidParameterException

• SecretsManager.Client.exceptions.InvalidRequestException

• SecretsManager.Client.exceptions.DecryptionFailure

• SecretsManager.Client.exceptions.InternalServiceError

Examples

The following example shows how to retrieve a secret string value.

response = client.get_secret_value(
    SecretId='MyTestDatabaseSecret',
)

print(response)

Expected Output:

{
    'ARN': 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'CreatedDate': 1523477145.713,
    'Name': 'MyTestDatabaseSecret',
    'SecretString': '{\n  "username":"david",\n  "password":"EXAMPLE-PASSWORD"\n}\n',
    'VersionId': 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1',
    'VersionStages': [
        'AWSPREVIOUS',
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}