greengrasssdk.SecretsManager module

exception greengrasssdk.SecretsManager.SecretsManagerError[source]

Bases: Exception

class greengrasssdk.SecretsManager.Client[source]

Bases: object

get_secret_value(**kwargs)[source]

Call secrets manager lambda to obtain the requested secret value.

Keyword Arguments:
 

  • SecretId (string) – [REQUIRED] Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

  • VersionId (string) – Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don’t specify VersionStage . If you don’t specify either a VersionStage or SecretVersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT .

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

  • VersionStage (string) – Specifies the secret version that you want to retrieve by the staging label attached to the version.

    Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don’t specify SecretVersionId . If you don’t specify either a VersionStage or SecretVersionId , then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT .
Returns:

(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 part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.

    This parameter is not used if the secret is created by the Secrets Manager console.

    If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.

  • SecretString (string) – The decrypted part of the protected secret information that was originally provided as a string.

    If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

    If you store custom information in the secret by using the CreateSecret , UpdateSecret , or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.

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