API version 2017-10-17 of the Amazon Secrets Manager SDK configuration.

Secrets Manager can't decrypt the protected secret text using the provided KMS key.

Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.

An error occurred on the server side.

The NextToken value is invalid.

The parameter name or value is invalid.

A parameter value is not valid for the current state of the resource.

Possible causes:

• The secret is scheduled for deletion.
• You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

The request failed because it would exceed one of the Secrets Manager quotas.

The resource policy has syntax errors.

The request failed because you did not complete all the prerequisite steps.

The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.

A resource with the ID you requested already exists.

Secrets Manager can't find the resource that you asked for.

See: newCancelRotateSecret smart constructor.

Create a value of CancelRotateSecret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:secretId:CancelRotateSecret', cancelRotateSecret_secretId - The ARN or name of the secret.

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

See: newCancelRotateSecretResponse smart constructor.

Create a value of CancelRotateSecretResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CancelRotateSecretResponse, cancelRotateSecretResponse_arn - The ARN of the secret.

CancelRotateSecretResponse, cancelRotateSecretResponse_name - The name of the secret.

CancelRotateSecretResponse, cancelRotateSecretResponse_versionId - The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage value AWSPENDING from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.

$sel:httpStatus:CancelRotateSecretResponse', cancelRotateSecretResponse_httpStatus - The response's http status code.

See: newCreateSecret smart constructor.

Create a value of CreateSecret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:addReplicaRegions:CreateSecret', createSecret_addReplicaRegions - A list of Regions and KMS keys to replicate secrets.

$sel:clientRequestToken:CreateSecret', createSecret_clientRequestToken - If you include SecretString or SecretBinary, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for the new version and include the value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

• If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.
• If a version with this value already exists and the version SecretString and SecretBinary values are the same as those in the request, then the request is ignored.
• If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.

This value becomes the VersionId of the new version.

CreateSecret, createSecret_description - The description of the secret.

$sel:forceOverwriteReplicaSecret:CreateSecret', createSecret_forceOverwriteReplicaSecret - Specifies whether to overwrite a secret with the same name in the destination Region.

CreateSecret, createSecret_kmsKeyId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.

To use a KMS key in a different account, use the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.

If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.

$sel:secretBinary:CreateSecret', createSecret_secretBinary - The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

Either SecretString or SecretBinary must have a value, but not both.

This parameter is not available in the Secrets Manager console.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:secretString:CreateSecret', createSecret_secretString - The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.

Either SecretString or SecretBinary must have a value, but not both.

If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.

CreateSecret, createSecret_tags - A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".

If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.

For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

The following restrictions apply to tags:

• Maximum number of tags per secret: 50
• Maximum key length: 127 Unicode characters in UTF-8
• Maximum value length: 255 Unicode characters in UTF-8
• Tag keys and values are case sensitive.
• Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
• If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

CreateSecret, createSecret_name - The name of the new secret.

The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-

Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.

See: newCreateSecretResponse smart constructor.

Create a value of CreateSecretResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateSecretResponse, createSecretResponse_arn - The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.

CreateSecret, createSecretResponse_name - The name of the new secret.

$sel:replicationStatus:CreateSecretResponse', createSecretResponse_replicationStatus - A list of the replicas of this secret and their status:

• Failed, which indicates that the replica was not created.
• InProgress, which indicates that Secrets Manager is in the process of creating the replica.
• InSync, which indicates that the replica was created.

CreateSecretResponse, createSecretResponse_versionId - The unique identifier associated with the version of the new secret.

$sel:httpStatus:CreateSecretResponse', createSecretResponse_httpStatus - The response's http status code.

See: newDeleteResourcePolicy smart constructor.

Create a value of DeleteResourcePolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:secretId:DeleteResourcePolicy', deleteResourcePolicy_secretId - The ARN or name of the secret to delete the attached resource-based policy for.

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

See: newDeleteResourcePolicyResponse smart constructor.

Create a value of DeleteResourcePolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteResourcePolicyResponse, deleteResourcePolicyResponse_arn - The ARN of the secret that the resource-based policy was deleted for.

DeleteResourcePolicyResponse, deleteResourcePolicyResponse_name - The name of the secret that the resource-based policy was deleted for.

$sel:httpStatus:DeleteResourcePolicyResponse', deleteResourcePolicyResponse_httpStatus - The response's http status code.

See: newDeleteSecret smart constructor.

Create a value of DeleteSecret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:forceDeleteWithoutRecovery:DeleteSecret', deleteSecret_forceDeleteWithoutRecovery - Specifies whether to delete the secret without any recovery window. You can't use both this parameter and RecoveryWindowInDays in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.

Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.

Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.

$sel:recoveryWindowInDays:DeleteSecret', deleteSecret_recoveryWindowInDays - The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret. You can't use both this parameter and ForceDeleteWithoutRecovery in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.

$sel:secretId:DeleteSecret', deleteSecret_secretId - The ARN or name of the secret to delete.

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

See: newDeleteSecretResponse smart constructor.

Create a value of DeleteSecretResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteSecretResponse, deleteSecretResponse_arn - The ARN of the secret.

$sel:deletionDate:DeleteSecretResponse', deleteSecretResponse_deletionDate - The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays.

DeleteSecretResponse, deleteSecretResponse_name - The name of the secret.

$sel:httpStatus:DeleteSecretResponse', deleteSecretResponse_httpStatus - The response's http status code.

See: newDescribeSecret smart constructor.

Create a value of DescribeSecret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:secretId:DescribeSecret', describeSecret_secretId - The ARN or name of the secret.

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

See: newDescribeSecretResponse smart constructor.

Create a value of DescribeSecretResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSecretResponse, describeSecretResponse_arn - The ARN of the secret.

DescribeSecretResponse, describeSecretResponse_createdDate - The date the secret was created.

DescribeSecretResponse, describeSecretResponse_deletedDate - The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.

If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.

DescribeSecretResponse, describeSecretResponse_description - The description of the secret.

DescribeSecretResponse, describeSecretResponse_kmsKeyId - The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted. Secrets created using the console use an KMS key ID.

DescribeSecretResponse, describeSecretResponse_lastAccessedDate - The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

DescribeSecretResponse, describeSecretResponse_lastChangedDate - The last date and time that this secret was modified in any way.

DescribeSecretResponse, describeSecretResponse_lastRotatedDate - The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.

DescribeSecretResponse, describeSecretResponse_name - The name of the secret.

DescribeSecretResponse, describeSecretResponse_nextRotationDate - Undocumented member.

DescribeSecretResponse, describeSecretResponse_owningService - The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.

DescribeSecretResponse, describeSecretResponse_primaryRegion - The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.

$sel:replicationStatus:DescribeSecretResponse', describeSecretResponse_replicationStatus - A list of the replicas of this secret and their status:

• Failed, which indicates that the replica was not created.
• InProgress, which indicates that Secrets Manager is in the process of creating the replica.
• InSync, which indicates that the replica was created.

DescribeSecretResponse, describeSecretResponse_rotationEnabled - Specifies whether automatic rotation is turned on for this secret.

To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.

DescribeSecretResponse, describeSecretResponse_rotationLambdaARN - The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

DescribeSecretResponse, describeSecretResponse_rotationRules - The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.

DescribeSecretResponse, describeSecretResponse_tags - The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

$sel:versionIdsToStages:DescribeSecretResponse', describeSecretResponse_versionIdsToStages - A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.

Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:

• AWSCURRENT, which indicates the current version of the secret.

• AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.

  During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.

• AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.

For more information about rotation and staging labels, see How rotation works.

$sel:httpStatus:DescribeSecretResponse', describeSecretResponse_httpStatus - The response's http status code.

See: newGetRandomPassword smart constructor.

Create a value of GetRandomPassword with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:excludeCharacters:GetRandomPassword', getRandomPassword_excludeCharacters - A string of the characters that you don't want in the password.

$sel:excludeLowercase:GetRandomPassword', getRandomPassword_excludeLowercase - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

$sel:excludeNumbers:GetRandomPassword', getRandomPassword_excludeNumbers - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

$sel:excludePunctuation:GetRandomPassword', getRandomPassword_excludePunctuation - Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.

$sel:excludeUppercase:GetRandomPassword', getRandomPassword_excludeUppercase - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

$sel:includeSpace:GetRandomPassword', getRandomPassword_includeSpace - Specifies whether to include the space character. If you include this switch, the password can contain space characters.

$sel:passwordLength:GetRandomPassword', getRandomPassword_passwordLength - The length of the password. If you don't include this parameter, the default length is 32 characters.

$sel:requireEachIncludedType:GetRandomPassword', getRandomPassword_requireEachIncludedType - Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.

See: newGetRandomPasswordResponse smart constructor.

Create a value of GetRandomPasswordResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:randomPassword:GetRandomPasswordResponse', getRandomPasswordResponse_randomPassword - A string with the password.

$sel:httpStatus:GetRandomPasswordResponse', getRandomPasswordResponse_httpStatus - The response's http status code.

See: newGetResourcePolicy smart constructor.

Create a value of GetResourcePolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:secretId:GetResourcePolicy', getResourcePolicy_secretId - The ARN or name of the secret to retrieve the attached resource-based policy for.

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

See: newGetResourcePolicyResponse smart constructor.

Create a value of GetResourcePolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetResourcePolicyResponse, getResourcePolicyResponse_arn - The ARN of the secret that the resource-based policy was retrieved for.

GetResourcePolicyResponse, getResourcePolicyResponse_name - The name of the secret that the resource-based policy was retrieved for.

$sel:resourcePolicy:GetResourcePolicyResponse', getResourcePolicyResponse_resourcePolicy - A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.

$sel:httpStatus:GetResourcePolicyResponse', getResourcePolicyResponse_httpStatus - The response's http status code.

See: newGetSecretValue smart constructor.

Create a value of GetSecretValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSecretValue, getSecretValue_versionId - 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.

$sel:versionStage:GetSecretValue', getSecretValue_versionStage - 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.

$sel:secretId:GetSecretValue', getSecretValue_secretId - The ARN or name of the secret to retrieve.

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

See: newGetSecretValueResponse smart constructor.

Create a value of GetSecretValueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSecretValueResponse, getSecretValueResponse_arn - The ARN of the secret.

GetSecretValueResponse, getSecretValueResponse_createdDate - 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.

GetSecretValueResponse, getSecretValueResponse_name - The friendly name of the secret.

$sel:secretBinary:GetSecretValueResponse', getSecretValueResponse_secretBinary - The decrypted secret value, if the secret value 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.

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.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:secretString:GetSecretValueResponse', getSecretValueResponse_secretString - 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.

GetSecretValue, getSecretValueResponse_versionId - The unique identifier of this version of the secret.

GetSecretValueResponse, getSecretValueResponse_versionStages - A list of all of the staging labels currently attached to this version of the secret.