AWS SDK for PHP 3.x

Client: Aws\SecretsManager\SecretsManagerClient

Service ID: secretsmanager

Version: 2017-10-17

This page describes the parameters and results for the operations of the AWS Secrets Manager (2017-10-17), and shows how to use the Aws\SecretsManager\SecretsManagerClient object to call the described operations. This documentation is specific to the 2017-10-17 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelRotateSecret ( array $params = [] )
Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.
CreateSecret ( array $params = [] )
Creates a new secret.
DeleteResourcePolicy ( array $params = [] )
Deletes the resource-based permission policy that's attached to the secret.
DeleteSecret ( array $params = [] )
Deletes an entire secret and all of its versions.
DescribeSecret ( array $params = [] )
Retrieves the details of a secret.
GetRandomPassword ( array $params = [] )
Generates a random password of the specified complexity.
GetResourcePolicy ( array $params = [] )
Retrieves the JSON text of the resource-based policy document that's attached to the specified secret.
GetSecretValue ( array $params = [] )
Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.
ListSecretVersionIds ( array $params = [] )
Lists all of the versions attached to the specified secret.
ListSecrets ( array $params = [] )
Lists all of the secrets that are stored by Secrets Manager in the AWS account.
PutResourcePolicy ( array $params = [] )
Attaches the contents of the specified resource-based permission policy to a secret.
PutSecretValue ( array $params = [] )
Stores a new encrypted secret value in the specified secret.
RestoreSecret ( array $params = [] )
Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp.
RotateSecret ( array $params = [] )
Configures and starts the asynchronous process of rotating this secret.
TagResource ( array $params = [] )
Attaches one or more tags, each consisting of a key name and a value, to the specified secret.
UntagResource ( array $params = [] )
Removes one or more tags from the specified secret.
UpdateSecret ( array $params = [] )
Modifies many of the details of the specified secret.
UpdateSecretVersionStage ( array $params = [] )
Modifies the staging labels attached to a version of a secret.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListSecretVersionIds
ListSecrets

Operations

CancelRotateSecret

$result = $client->cancelRotateSecret([/* ... */]);
$promise = $client->cancelRotateSecretAsync([/* ... */]);

Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.

To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.

If you cancel a rotation that is in progress, it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field.

To successfully start a rotation, the staging label AWSPENDING must be in one of the following states:

Not be attached to any version at all
Attached to the same version as the staging label AWSCURRENT

If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails.

Minimum permissions

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

secretsmanager:CancelRotateSecret

Related operations

To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.
To get the rotation configuration details for a secret, use DescribeSecret.
To list all of the currently available secrets, use ListSecrets.
To list all of the versions currently associated with a secret, use ListSecretVersionIds.

Parameter Syntax

$result = $client->cancelRotateSecret([
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SecretId

Required: Yes
Type: string

Specifies the secret for which you want to cancel a rotation request. 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 that end with a hyphen followed by six characters.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
    'VersionId' => '<string>',
]

Result Details

Members

ARN

Type: string

The ARN of the secret for which rotation was canceled.

Name

Type: string

The friendly name of the secret for which rotation was canceled.

VersionId

Type: string

The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage value AWSPENDING to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InvalidParameterException:
You provided an invalid value for a parameter.
InternalServiceError:
An error occurred on the server side.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.

Examples

Example 1: To cancel scheduled rotation for a secret

The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation.

$result = $client->cancelRotateSecret([
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'Name',
]

CreateSecret

$result = $client->createSecret([/* ... */]);
$promise = $client->createSecretAsync([/* ... */]);

Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more "staging labels" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list.

You provide the secret data to be encrypted by putting text in either the SecretString parameter or binary data in the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT to the new version.

If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

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

secretsmanager:CreateSecret
kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
secretsmanager:TagResource - needed only if you include the Tags parameter.

Related operations

To delete a secret, use DeleteSecret.
To modify an existing secret, use UpdateSecret.
To create a new version of a secret, use PutSecretValue.
To retrieve the encrypted secure string and secure binary values, use GetSecretValue.
To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.
To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value.

Parameter Syntax

$result = $client->createSecret([
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'KmsKeyId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'SecretBinary' => <string || resource || Psr\Http\Message\StreamInterface>,
    'SecretString' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK 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 that 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 that version's SecretString and SecretBinary values are the same as those in the request, then the request is ignored (the operation is idempotent).
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.

Description

Type: string

(Optional) Specifies a user-provided description of the secret.

KmsKeyId

Type: string

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field.

Name

Required: Yes
Type: string

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or the following characters : /_+=.@-

Don't 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. This is because Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.

SecretBinary

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.

SecretString

Type: string

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

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 the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{"username":"bob"},{"password":"abc123xyz456"}]

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.

Tags

Type: Array of Tag structures

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

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

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 basic 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 it is reserved for AWS 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 your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
    'VersionId' => '<string>',
]

Result Details

Members

ARN

Type: string

The Amazon Resource Name (ARN) of the secret that you just created.

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

Type: string

The friendly name of the secret that you just created.

VersionId

Type: string

The unique identifier that's associated with the version of the secret you just created.

Errors

InvalidParameterException:
You provided an invalid value for a parameter.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
LimitExceededException:
The request failed because it would exceed one of the Secrets Manager internal limits.
EncryptionFailure:
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.
ResourceExistsException:
A resource with the ID you requested already exists.
ResourceNotFoundException:
We can't find the resource that you asked for.
MalformedPolicyDocumentException:
The policy document that you provided isn't valid.
InternalServiceError:
An error occurred on the server side.
PreconditionNotMetException:
The request failed because you did not complete all the prerequisite steps.

Examples

Example 1: To create a basic secret

The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json.

$result = $client->createSecret([
    'ClientRequestToken' => 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1',
    'Description' => 'My test database secret created with the CLI',
    'Name' => 'MyTestDatabaseSecret',
    'SecretString' => '{"username":"david","password":"BnQw!XDWgaEeT9XGTT29"}',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
    'VersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1',
]

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the resource-based permission policy that's attached to the secret.

Minimum permissions

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

secretsmanager:DeleteResourcePolicy

Related operations

To attach a resource policy to a secret, use PutResourcePolicy.
To retrieve the current resource-based policy that's attached to a secret, use GetResourcePolicy.
To list all of the currently available secrets, use ListSecrets.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SecretId

Required: Yes
Type: string

Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
]

Result Details

Members

ARN

Type: string

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

Name

Type: string

The friendly name of the secret that the resource-based policy was deleted for.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InternalServiceError:
An error occurred on the server side.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.

Examples

Example 1: To delete the resource-based policy attached to a secret

The following example shows how to delete the resource-based policy that is attached to a secret.

$result = $client->deleteResourcePolicy([
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseMasterSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
]

DeleteSecret

$result = $client->deleteSecret([/* ... */]);
$promise = $client->deleteSecretAsync([/* ... */]);

Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.

At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.

You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.

There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the VersionStage field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions that do not have any staging labels do not show up in ListSecretVersionIds unless you specify IncludeDeprecated.
The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.

Minimum permissions

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

secretsmanager:DeleteSecret

Related operations

To create a secret, use CreateSecret.
To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret.

Parameter Syntax

$result = $client->deleteSecret([
    'ForceDeleteWithoutRecovery' => true || false,
    'RecoveryWindowInDays' => <integer>,
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ForceDeleteWithoutRecovery

Type: boolean

(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays parameter in the same API call.

An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.

Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. It is permanently lost.

RecoveryWindowInDays

Type: long (int|float)

(Optional) Specifies the number of days that Secrets Manager waits before it can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.

This value can range from 7 to 30 days. The default value is 30.

SecretId

Required: Yes
Type: string

Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Result Syntax

[
    'ARN' => '<string>',
    'DeletionDate' => <DateTime>,
    'Name' => '<string>',
]

Result Details

Members

ARN

Type: string

The ARN of the secret that is now scheduled for deletion.

DeletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays.

Name

Type: string

The friendly name of the secret that is now scheduled for deletion.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InvalidParameterException:
You provided an invalid value for a parameter.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To delete a secret

The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the DeletionDate response field has passed, you can no longer recover this secret with restore-secret.

$result = $client->deleteSecret([
    'RecoveryWindowInDays' => 7,
    'SecretId' => 'MyTestDatabaseSecret1',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'DeletionDate' => ,
    'Name' => 'MyTestDatabaseSecret',
]

DescribeSecret

$result = $client->describeSecret([/* ... */]);
$promise = $client->describeSecretAsync([/* ... */]);

Retrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response.

Minimum permissions

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

secretsmanager:DescribeSecret

Related operations

To create a secret, use CreateSecret.
To modify a secret, use UpdateSecret.
To retrieve the encrypted secret information in a version of the secret, use GetSecretValue.
To list all of the secrets in the AWS account, use ListSecrets.

Parameter Syntax

$result = $client->describeSecret([
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SecretId

Required: Yes
Type: string

The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Result Syntax

[
    'ARN' => '<string>',
    'DeletedDate' => <DateTime>,
    'Description' => '<string>',
    'KmsKeyId' => '<string>',
    'LastAccessedDate' => <DateTime>,
    'LastChangedDate' => <DateTime>,
    'LastRotatedDate' => <DateTime>,
    'Name' => '<string>',
    'OwningService' => '<string>',
    'RotationEnabled' => true || false,
    'RotationLambdaARN' => '<string>',
    'RotationRules' => [
        'AutomaticallyAfterDays' => <integer>,
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VersionIdsToStages' => [
        '<SecretVersionIdType>' => ['<string>', ...],
        // ...
    ],
]

Result Details

Members

ARN

Type: string

The ARN of the secret.

DeletedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.

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

Description

Type: string

The user-provided description of the secret.

KmsKeyId

Type: string

The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString or SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default AWS KMS CMK (the one named awssecretsmanager) for this account.

LastAccessedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.

LastChangedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The last date and time that this secret was modified in any way.

LastRotatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret has never rotated.

Name

Type: string

The user-provided friendly name of the secret.

OwningService

Type: string

RotationEnabled

Type: boolean

Specifies whether automatic rotation is enabled for this secret.

To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. To disable rotation, use CancelRotateSecret.

RotationLambdaARN

Type: string

The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret.

RotationRules

Type: RotationRulesType structure

A structure that contains the rotation configuration for this secret.

Tags

Type: Array of Tag structures

The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

VersionIdsToStages

Type: Associative array of custom strings keys (SecretVersionIdType) to stringss

A list of all of the currently assigned VersionStage staging labels and the VersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.

A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To retrieve the details of a secret

The following example shows how to get the details about a secret.

$result = $client->describeSecret([
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Description' => 'My test database secret',
    'KmsKeyId' => 'arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987KMSKEY1',
    'LastAccessedDate' => ,
    'LastChangedDate' => ,
    'LastRotatedDate' => ,
    'Name' => 'MyTestDatabaseSecret',
    'RotationEnabled' => 1,
    'RotationLambdaARN' => 'arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda',
    'RotationRules' => [
        'AutomaticallyAfterDays' => 30,
    ],
    'Tags' => [
        [
            'Key' => 'SecondTag',
            'Value' => 'AnotherValue',
        ],
        [
            'Key' => 'FirstTag',
            'Value' => 'SomeValue',
        ],
    ],
    'VersionIdsToStages' => [
        'EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE' => [
            'AWSPREVIOUS',
        ],
        'EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE' => [
            'AWSCURRENT',
        ],
    ],
]

GetRandomPassword

$result = $client->getRandomPassword([/* ... */]);
$promise = $client->getRandomPasswordAsync([/* ... */]);

Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

Minimum permissions

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

secretsmanager:GetRandomPassword

Parameter Syntax

$result = $client->getRandomPassword([
    'ExcludeCharacters' => '<string>',
    'ExcludeLowercase' => true || false,
    'ExcludeNumbers' => true || false,
    'ExcludePunctuation' => true || false,
    'ExcludeUppercase' => true || false,
    'IncludeSpace' => true || false,
    'PasswordLength' => <integer>,
    'RequireEachIncludedType' => true || false,
]);

Parameter Details

Members

ExcludeCharacters

Type: string

A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.

ExcludeLowercase

Type: boolean

Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.

ExcludeNumbers

Type: boolean

Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.

ExcludePunctuation

Type: boolean

Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.

The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

ExcludeUppercase

Type: boolean

Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.

IncludeSpace

Type: boolean

Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.

PasswordLength

Type: long (int|float)

The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

RequireEachIncludedType

Type: boolean

A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.

Result Syntax

[
    'RandomPassword' => '<string>',
]

Result Details

Members

RandomPassword

Type: string

A string with the generated password.

Errors

InvalidParameterException:
You provided an invalid value for a parameter.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To generate a random password

The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters.

$result = $client->getRandomPassword([
    'IncludeSpace' => 1,
    'PasswordLength' => 20,
    'RequireEachIncludedType' => 1,
]);

Result syntax:

[
    'RandomPassword' => 'N+Z43a,>vx7j O8^*<8i3',
]

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Retrieves the JSON text of the resource-based policy document that's attached to the specified secret. The JSON request string input and response output are shown formatted with white space and line breaks for better readability. Submit your input as a single line JSON string.

Minimum permissions

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

secretsmanager:GetResourcePolicy

Related operations

To attach a resource policy to a secret, use PutResourcePolicy.
To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy.
To list all of the currently available secrets, use ListSecrets.

Parameter Syntax

$result = $client->getResourcePolicy([
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SecretId

Required: Yes
Type: string

Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
    'ResourcePolicy' => '<string>',
]

Result Details

Members

ARN

Type: string

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

Name

Type: string

The friendly name of the secret that the resource-based policy was retrieved for.

ResourcePolicy

Type: string

A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for AWS Secrets Manager in the AWS Secrets Manager User Guide.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InternalServiceError:
An error occurred on the server side.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.

Examples

Example 1: To retrieve the resource-based policy attached to a secret

The following example shows how to retrieve the resource-based policy that is attached to a secret.

$result = $client->getResourcePolicy([
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
    'ResourcePolicy' => '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:root"},"Action":"secretsmanager:GetSecretValue","Resource":"*"}]}',
]

GetSecretValue

$result = $client->getSecretValue([/* ... */]);
$promise = $client->getSecretValueAsync([/* ... */]);

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

Minimum permissions

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

secretsmanager:GetSecretValue
kms:Decrypt - required only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

To create a new version of the secret with different encrypted information, use PutSecretValue.
To retrieve the non-encrypted details for the secret, use DescribeSecret.

Parameter Syntax

$result = $client->getSecretValue([
    'SecretId' => '<string>', // REQUIRED
    'VersionId' => '<string>',
    'VersionStage' => '<string>',
]);

Parameter Details

Members

SecretId

Required: Yes
Type: string

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

Type: 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 VersionId 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

Type: 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 VersionId. If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Result Syntax

[
    'ARN' => '<string>',
    'CreatedDate' => <DateTime>,
    'Name' => '<string>',
    'SecretBinary' => <string || resource || Psr\Http\Message\StreamInterface>,
    'SecretString' => '<string>',
    'VersionId' => '<string>',
    'VersionStages' => ['<string>', ...],
]

Result Details

Members

ARN

Type: string

The ARN of the secret.

CreatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that this version of the secret was created.

Name

Type: string

The friendly name of the secret.

SecretBinary

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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

Type: 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.

VersionId

Type: string

The unique identifier of this version of the secret.

VersionStages

Type: Array of strings

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

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InvalidParameterException:
You provided an invalid value for a parameter.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
DecryptionFailure:
Secrets Manager can't decrypt the protected secret text using the provided KMS key.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To retrieve the encrypted secret value of a secret

The following example shows how to retrieve the secret string value from the version of the secret that has the AWSPREVIOUS staging label attached. If you want to retrieve the AWSCURRENT version of the secret, then you can omit the VersionStage parameter because it defaults to AWSCURRENT.

$result = $client->getSecretValue([
    'SecretId' => 'MyTestDatabaseSecret',
    'VersionStage' => 'AWSPREVIOUS',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'CreatedDate' => ,
    'Name' => 'MyTestDatabaseSecret',
    'SecretString' => '{ "username":"david", "password":"BnQw&XDWgaEeT9XGTT29"}',
    'VersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1',
    'VersionStages' => [
        'AWSPREVIOUS',
    ],
]

ListSecretVersionIds

$result = $client->listSecretVersionIds([/* ... */]);
$promise = $client->listSecretVersionIdsAsync([/* ... */]);

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.

Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

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.

Parameter Syntax

$result = $client->listSecretVersionIds([
    'IncludeDeprecated' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IncludeDeprecated

Type: boolean

(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

Type: int

(Optional) Limits the number of results that 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

Type: string

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

SecretId

Required: Yes
Type: string

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.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
    'NextToken' => '<string>',
    'Versions' => [
        [
            'CreatedDate' => <DateTime>,
            'LastAccessedDate' => <DateTime>,
            'VersionId' => '<string>',
            'VersionStages' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

ARN

Type: string

The Amazon Resource Name (ARN) for the secret.

Name

Type: string

The friendly name of the secret.

NextToken

Type: string

If present in the response, this value indicates that there's more output available than what's 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).

Versions

Type: Array of SecretVersionsListEntry structures

The list of the currently available versions of the specified secret.

Errors

InvalidNextTokenException:
You provided an invalid NextToken value.
ResourceNotFoundException:
We can't find the resource that you asked for.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: 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.

$result = $client->listSecretVersionIds([
    'IncludeDeprecated' => 1,
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
    'Versions' => [
        [
            'CreatedDate' => ,
            'VersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE',
            'VersionStages' => [
                'AWSPREVIOUS',
            ],
        ],
        [
            'CreatedDate' => ,
            'VersionId' => 'EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE',
            'VersionStages' => [
                'AWSCURRENT',
            ],
        ],
        [
            'CreatedDate' => ,
            'VersionId' => 'EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;',
        ],
    ],
]

ListSecrets

$result = $client->listSecrets([/* ... */]);
$promise = $client->listSecretsAsync([/* ... */]);

Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation.

Minimum permissions

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

secretsmanager:ListSecrets

Related operations

To list the versions attached to a secret, use ListSecretVersionIds.

Parameter Syntax

$result = $client->listSecrets([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'SecretList' => [
        [
            'ARN' => '<string>',
            'DeletedDate' => <DateTime>,
            'Description' => '<string>',
            'KmsKeyId' => '<string>',
            'LastAccessedDate' => <DateTime>,
            'LastChangedDate' => <DateTime>,
            'LastRotatedDate' => <DateTime>,
            'Name' => '<string>',
            'OwningService' => '<string>',
            'RotationEnabled' => true || false,
            'RotationLambdaARN' => '<string>',
            'RotationRules' => [
                'AutomaticallyAfterDays' => <integer>,
            ],
            'SecretVersionsToStages' => [
                '<SecretVersionIdType>' => ['<string>', ...],
                // ...
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

SecretList

Type: Array of SecretListEntry structures

A list of the secrets in the account.

Errors

InvalidParameterException:
You provided an invalid value for a parameter.
InvalidNextTokenException:
You provided an invalid NextToken value.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To list the secrets in your account

The following example shows how to list all of the secrets in your account.

$result = $client->listSecrets([
]);

Result syntax:

[
    'SecretList' => [
        [
            'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
            'Description' => 'My test database secret',
            'LastChangedDate' => ,
            'Name' => 'MyTestDatabaseSecret',
            'SecretVersionsToStages' => [
                'EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE' => [
                    'AWSCURRENT',
                ],
            ],
        ],
        [
            'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6',
            'Description' => 'Another secret created for a different database',
            'LastChangedDate' => ,
            'Name' => 'MyTestDatabaseSecret1',
            'SecretVersionsToStages' => [
                'EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE' => [
                    'AWSCURRENT',
                ],
            ],
        ],
    ],
]

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for AWS Secrets Manager. For the complete description of the AWS policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide.

Minimum permissions

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

secretsmanager:PutResourcePolicy

Related operations

To retrieve the resource policy that's attached to a secret, use GetResourcePolicy.
To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy.
To list all of the currently available secrets, use ListSecrets.

Parameter Syntax

$result = $client->putResourcePolicy([
    'ResourcePolicy' => '<string>', // REQUIRED
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourcePolicy

Required: Yes
Type: string

A JSON-formatted string that's constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

SecretId

Required: Yes
Type: string

Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
]

Result Details

Members

ARN

Type: string

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

Name

Type: string

The friendly name of the secret that the resource-based policy was retrieved for.

Errors

MalformedPolicyDocumentException:
The policy document that you provided isn't valid.
ResourceNotFoundException:
We can't find the resource that you asked for.
InvalidParameterException:
You provided an invalid value for a parameter.
InternalServiceError:
An error occurred on the server side.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.

Examples

Example 1: To add a resource-based policy to a secret

The following example shows how to add a resource-based policy to a secret.

$result = $client->putResourcePolicy([
    'ResourcePolicy' => '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:root"},"Action":"secretsmanager:GetSecretValue","Resource":"*"}]}',
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
]

PutSecretValue

$result = $client->putSecretValue([/* ... */]);
$promise = $client->putSecretValueAsync([/* ... */]);

Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. You can also specify the staging labels that are initially attached to the new version.

The Secrets Manager console uses only the SecretString field. To add binary data to a secret with the SecretBinary field you must use the AWS CLI or one of the AWS SDKs.

If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.
If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the VersionStages parameter.
If this operation moves the staging label AWSCURRENT from another version to this version (because you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.

If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

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

secretsmanager:PutSecretValue
kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

To retrieve the encrypted value you store in the version of a secret, use GetSecretValue.
To create a secret, use CreateSecret.
To get the details for a secret, use DescribeSecret.
To list the versions attached to a secret, use ListSecretVersionIds.

Parameter Syntax

$result = $client->putSecretValue([
    'ClientRequestToken' => '<string>',
    'SecretBinary' => <string || resource || Psr\Http\Message\StreamInterface>,
    'SecretId' => '<string>', // REQUIRED
    'SecretString' => '<string>',
    'VersionStages' => ['<string>', ...],
]);

Parameter Details

Members

ClientRequestToken

Type: string

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that 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 new versions and include that 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 the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness 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 that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).
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 secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

SecretBinary

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

This parameter is not accessible if the secret using the Secrets Manager console.

SecretId

Required: Yes
Type: string

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

SecretString

Type: string

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

If you create this 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 the default Lambda rotation function knows how to parse.

For example:

[{"username":"bob"},{"password":"abc123xyz456"}]

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.

VersionStages

Type: Array of strings

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
    'VersionId' => '<string>',
    'VersionStages' => ['<string>', ...],
]

Result Details

Members

ARN

Type: string

The Amazon Resource Name (ARN) for the secret for which you just created a version.

Name

Type: string

The friendly name of the secret for which you just created or updated a version.

VersionId

Type: string

The unique identifier of the version of the secret you just created or updated.

VersionStages

Type: Array of strings

The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process.

Errors

InvalidParameterException:
You provided an invalid value for a parameter.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
LimitExceededException:
The request failed because it would exceed one of the Secrets Manager internal limits.
EncryptionFailure:
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.
ResourceExistsException:
A resource with the ID you requested already exists.
ResourceNotFoundException:
We can't find the resource that you asked for.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To store a secret value in a new version of a secret

The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command.

$result = $client->putSecretValue([
    'ClientRequestToken' => 'EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE',
    'SecretId' => 'MyTestDatabaseSecret',
    'SecretString' => '{"username":"david","password":"BnQw!XDWgaEeT9XGTT29"}',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
    'VersionId' => 'EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE',
    'VersionStages' => [
        'AWSCURRENT',
    ],
]

RestoreSecret

$result = $client->restoreSecret([/* ... */]);
$promise = $client->restoreSecretAsync([/* ... */]);

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This makes the secret accessible to query once again.

Minimum permissions

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

secretsmanager:RestoreSecret

Related operations

To delete a secret, use DeleteSecret.

Parameter Syntax

$result = $client->restoreSecret([
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SecretId

Required: Yes
Type: string

Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
]

Result Details

Members

ARN

Type: string

The ARN of the secret that was restored.

Name

Type: string

The friendly name of the secret that was restored.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InvalidParameterException:
You provided an invalid value for a parameter.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To restore a previously deleted secret

The following example shows how to restore a secret that you previously scheduled for deletion.

$result = $client->restoreSecret([
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
]

RotateSecret

$result = $client->rotateSecret([/* ... */]);
$promise = $client->rotateSecretAsync([/* ... */]);

Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.

This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in AWS Secrets Manager in the AWS Secrets Manager User Guide.

Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.

The rotation function must end with the versions of the secret in one of two states:

The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the secret, or
The AWSPENDING staging label is not attached to any version of the secret.

If instead the AWSPENDING staging label is present but is not attached to the same version as AWSCURRENT then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error.

Minimum permissions

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

secretsmanager:RotateSecret
lambda:InvokeFunction (on the function specified in the secret's metadata)

Related operations

To list the secrets in your account, use ListSecrets.
To get the details for a version of a secret, use DescribeSecret.
To create a new version of a secret, use CreateSecret.
To attach staging labels to or remove staging labels from a version of a secret, use UpdateSecretVersionStage.

Parameter Syntax

$result = $client->rotateSecret([
    'ClientRequestToken' => '<string>',
    'RotationLambdaARN' => '<string>',
    'RotationRules' => [
        'AutomaticallyAfterDays' => <integer>,
    ],
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientRequestToken

Type: string

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. 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 new versions and include that value in the request.

You only need to specify your own value if you are implementing your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

RotationLambdaARN

Type: string

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

RotationRules

Type: RotationRulesType structure

A structure that defines the rotation configuration for this secret.

SecretId

Required: Yes
Type: string

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
    'VersionId' => '<string>',
]

Result Details

Members

ARN

Type: string

The ARN of the secret.

Name

Type: string

The friendly name of the secret.

VersionId

Type: string

The ID of the new version of the secret created by the rotation started by this request.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InvalidParameterException:
You provided an invalid value for a parameter.
InternalServiceError:
An error occurred on the server side.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.

Examples

Example 1: To configure rotation for a secret

The following example configures rotation for a secret by providing the ARN of a Lambda rotation function (which must already exist) and the number of days between rotation. The first rotation happens immediately upon completion of this command. The rotation function runs asynchronously in the background.

$result = $client->rotateSecret([
    'RotationLambdaARN' => 'arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda',
    'RotationRules' => [
        'AutomaticallyAfterDays' => 30,
    ],
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
    'VersionId' => 'EXAMPLE2-90ab-cdef-fedc-ba987SECRET2',
]

Example 2: To request an immediate rotation for a secret

The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.

$result = $client->rotateSecret([
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

The following basic 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 it is reserved for AWS 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 your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

Minimum permissions

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

secretsmanager:TagResource

Related operations

To remove one or more tags from the collection attached to a secret, use UntagResource.
To view the list of tags attached to a secret, use DescribeSecret.

Parameter Syntax

$result = $client->tagResource([
    'SecretId' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

SecretId

Required: Yes
Type: string

The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Tags

Required: Yes
Type: Array of Tag structures

The tags to attach to the secret. Each element in the list consists of a Key and a Value.

This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For the AWS CLI, you can also use the syntax: --Tags Key="Key1",Value="Value1",Key="Key2",Value="Value2"[,…]

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
InvalidParameterException:
You provided an invalid value for a parameter.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To add tags to a secret

The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation.

$result = $client->tagResource([
    'SecretId' => 'MyExampleSecret',
    'Tags' => [
        [
            'Key' => 'FirstTag',
            'Value' => 'SomeValue',
        ],
        [
            'Key' => 'SecondTag',
            'Value' => 'AnotherValue',
        ],
    ],
]);

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified secret.

This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.

If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

Minimum permissions

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

secretsmanager:UntagResource

Related operations

To add one or more tags to the collection attached to a secret, use TagResource.
To view the list of tags attached to a secret, use DescribeSecret.

Parameter Syntax

$result = $client->untagResource([
    'SecretId' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

SecretId

Required: Yes
Type: string

The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

TagKeys

Required: Yes
Type: Array of strings

A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
InvalidParameterException:
You provided an invalid value for a parameter.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To remove tags from a secret

The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation.

$result = $client->untagResource([
    'SecretId' => 'MyTestDatabaseSecret',
    'TagKeys' => [
        'FirstTag',
        'SecondTag',
    ],
]);

UpdateSecret

$result = $client->updateSecret([/* ... */]);
$promise = $client->updateSecretAsync([/* ... */]);

Modifies many of the details of the specified secret. If you include a ClientRequestToken and either SecretString or SecretBinary then it also creates a new version attached to the secret.

To modify the rotation configuration of a secret, use RotateSecret instead.

The Secrets Manager console uses only the SecretString parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.

If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.
If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

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

secretsmanager:UpdateSecret
kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

Related operations

To create a new secret, use CreateSecret.
To add only a new version to an existing secret, use PutSecretValue.
To get the details for a secret, use DescribeSecret.
To list the versions contained in a secret, use ListSecretVersionIds.

Parameter Syntax

$result = $client->updateSecret([
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'KmsKeyId' => '<string>',
    'SecretBinary' => <string || resource || Psr\Http\Message\StreamInterface>,
    'SecretId' => '<string>', // REQUIRED
    'SecretString' => '<string>',
]);

Parameter Details

Members

ClientRequestToken

Type: string

(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.

You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.

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 that version's SecretString and SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString and SecretBinary values are different from the request then an error occurs because you cannot modify an existing secret value.

This value becomes the VersionId of the new version.

Description

Type: string

(Optional) Specifies an updated user-provided description of the secret.

KmsKeyId

Type: string

(Optional) Specifies an updated ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the protected text in new versions of this secret.

You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.

SecretBinary

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

This parameter is not accessible using the Secrets Manager console.

SecretId

Required: Yes
Type: string

Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

SecretString

Type: string

(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

[{"username":"bob"},{"password":"abc123xyz456"}]

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. You can also 'escape' the double quote character in the embedded JSON text by prefacing each with a backslash. For example, the following string is surrounded by double-quotes. All of the embedded double quotes are escaped:

"[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]"

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
    'VersionId' => '<string>',
]

Result Details

Members

ARN

Type: string

The ARN of the secret that was updated.

Name

Type: string

The friendly name of the secret that was updated.

VersionId

Type: string

If a new version of the secret was created by this operation, then VersionId contains the unique identifier of the new version.

Errors

InvalidParameterException:
You provided an invalid value for a parameter.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
LimitExceededException:
The request failed because it would exceed one of the Secrets Manager internal limits.
EncryptionFailure:
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.
ResourceExistsException:
A resource with the ID you requested already exists.
ResourceNotFoundException:
We can't find the resource that you asked for.
MalformedPolicyDocumentException:
The policy document that you provided isn't valid.
InternalServiceError:
An error occurred on the server side.
PreconditionNotMetException:
The request failed because you did not complete all the prerequisite steps.

Examples

Example 1: To update the description of a secret

The following example shows how to modify the description of a secret.

$result = $client->updateSecret([
    'ClientRequestToken' => 'EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE',
    'Description' => 'This is a new description for the secret.',
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
]

Example 2: To update the KMS key associated with a secret

This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret.

$result = $client->updateSecret([
    'KmsKeyId' => 'arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE',
    'SecretId' => 'MyTestDatabaseSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
]

Example 3: To create a new version of the encrypted secret value

The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation.

$result = $client->updateSecret([
    'SecretId' => 'MyTestDatabaseSecret',
    'SecretString' => '{JSON STRING WITH CREDENTIALS}',
]);

Result syntax:

[
    'ARN' => 'aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
    'VersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE',
]

UpdateSecretVersionStage

$result = $client->updateSecretVersionStage([/* ... */]);
$promise = $client->updateSecretVersionStageAsync([/* ... */]);

Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide.

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels--they don't replace it.

You can move the AWSCURRENT staging label to this version by including it in this call.

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.

Minimum permissions

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

secretsmanager:UpdateSecretVersionStage

Related operations

To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret and examine the SecretVersionsToStages response value.

Parameter Syntax

$result = $client->updateSecretVersionStage([
    'MoveToVersionId' => '<string>',
    'RemoveFromVersionId' => '<string>',
    'SecretId' => '<string>', // REQUIRED
    'VersionStage' => '<string>', // REQUIRED
]);

Parameter Details

Members

MoveToVersionId

Type: string

(Optional) The secret version ID that you want to add the staging label to. If you want to remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

RemoveFromVersionId

Type: string

Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

SecretId

Required: Yes
Type: string

Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

VersionStage

Required: Yes
Type: string

The staging label to add to this version.

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
]

Result Details

Members

ARN

Type: string

The ARN of the secret with the staging label that was modified.

Name

Type: string

The friendly name of the secret with the staging label that was modified.

Errors

ResourceNotFoundException:
We can't find the resource that you asked for.
InvalidParameterException:
You provided an invalid value for a parameter.
InvalidRequestException:
You provided a parameter value that is not valid for the current state of the resource.

Possible causes:
- You tried to perform the operation on a secret that's currently marked deleted.
- 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.
LimitExceededException:
The request failed because it would exceed one of the Secrets Manager internal limits.
InternalServiceError:
An error occurred on the server side.

Examples

Example 1: To add a staging label attached to a version of a secret

The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.

$result = $client->updateSecretVersionStage([
    'MoveToVersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1',
    'SecretId' => 'MyTestDatabaseSecret',
    'VersionStage' => 'STAGINGLABEL1',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
]

Example 2: To delete a staging label attached to a version of a secret

The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.

$result = $client->updateSecretVersionStage([
    'RemoveFromVersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1',
    'SecretId' => 'MyTestDatabaseSecret',
    'VersionStage' => 'STAGINGLABEL1',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
]

Example 3: To move a staging label from one version of a secret to another

The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.

$result = $client->updateSecretVersionStage([
    'MoveToVersionId' => 'EXAMPLE2-90ab-cdef-fedc-ba987SECRET2',
    'RemoveFromVersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1',
    'SecretId' => 'MyTestDatabaseSecret',
    'VersionStage' => 'AWSCURRENT',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
    'Name' => 'MyTestDatabaseSecret',
]

Type: string

InvalidRequestException

Description

You provided a parameter value that is not valid for the current state of the resource.

Possible causes:

You tried to perform the operation on a secret that's currently marked deleted.
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.

Members

Message

Type: string

LimitExceededException

Description

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

Members

Message

Type: string

MalformedPolicyDocumentException

Description

The policy document that you provided isn't valid.

Members

Message

Type: string

PreconditionNotMetException

Description

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

Members

Message

Type: string

ResourceExistsException

Description

A resource with the ID you requested already exists.

Members

Message

Type: string

ResourceNotFoundException

Description

We can't find the resource that you asked for.

Members

Message

Type: string

RotationRulesType

Description

A structure that defines the rotation configuration for the secret.

Members

AutomaticallyAfterDays

Type: long (int|float)

Specifies the number of days between automatic scheduled rotations of the secret.

SecretListEntry

Description

A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use the GetSecretValue operation.

Members

ARN

Type: string

The Amazon Resource Name (ARN) of the secret.

For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.

DeletedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time on which this secret was deleted. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

Description

Type: string

The user-provided description of the secret.

KmsKeyId

Type: string

The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK (the one named awssecretsmanager) for this account.

LastAccessedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.

LastChangedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The last date and time that this secret was modified in any way.

LastRotatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The last date and time that the rotation process for this secret was invoked.

Name

Type: string

The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.

OwningService

Type: string

RotationEnabled

Type: boolean

Indicated whether automatic, scheduled rotation is enabled for this secret.

RotationLambdaARN

Type: string

The ARN of an AWS Lambda function that's invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.

RotationRules

Type: RotationRulesType structure

A structure that defines the rotation configuration for the secret.

SecretVersionsToStages

Type: Associative array of custom strings keys (SecretVersionIdType) to stringss

A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.

A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

Tags

Type: Array of Tag structures

The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

SecretVersionsListEntry

Description

A structure that contains information about one version of a secret.

Members

CreatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time this version of the secret was created.

LastAccessedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

VersionId

Type: string

The unique version identifier of this version of the secret.

VersionStages

Type: Array of strings

An array of staging labels that are currently associated with this version of the secret.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Secrets Manager 2017-10-17

Operation Summary

Paginators

Operations

CancelRotateSecret

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To cancel scheduled rotation for a secret

CreateSecret

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a basic secret

DeleteResourcePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To delete the resource-based policy attached to a secret

DeleteSecret

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To delete a secret

DescribeSecret

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To retrieve the details of a secret

GetRandomPassword

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To generate a random password

GetResourcePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To retrieve the resource-based policy attached to a secret