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 = [] )
Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
CreateSecret ( array $params = [] )
Creates a new secret.
DeleteResourcePolicy ( array $params = [] )
Deletes the resource-based permission policy attached to the secret.
DeleteSecret ( array $params = [] )
Deletes a secret and all of its versions.
DescribeSecret ( array $params = [] )
Retrieves the details of a secret.
GetRandomPassword ( array $params = [] )
Generates a random password.
GetResourcePolicy ( array $params = [] )
Retrieves the JSON text of the resource-based policy document attached to the 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 the versions of a secret.
ListSecrets ( array $params = [] )
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion.
PutResourcePolicy ( array $params = [] )
Attaches a resource-based permission policy to a secret.
PutSecretValue ( array $params = [] )
Creates a new version with a new encrypted secret value and attaches it to the secret.
RemoveRegionsFromReplication ( array $params = [] )
For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
ReplicateSecretToRegions ( array $params = [] )
Replicates the secret to a new Regions.
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 the secret.
StopReplicationToReplica ( array $params = [] )
Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
TagResource ( array $params = [] )
Attaches tags to a secret.
UntagResource ( array $params = [] )
Removes specific tags from a secret.
UpdateSecret ( array $params = [] )
Modifies the details of a secret, including metadata and the secret value.
UpdateSecretVersionStage ( array $params = [] )
Modifies the staging labels attached to a version of a secret.
ValidateResourcePolicy ( array $params = [] )
Validates that a resource policy does not grant a wide range of principals access to your 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([/* ... */]);

Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.

If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To determine which version has a specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works.

To turn on automatic rotation again, call RotateSecret.

Required permissions: secretsmanager:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

SecretId

Required: Yes
Type: string

The ARN or name of the secret.

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

Result Syntax

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

Result Details

Members

ARN

Type: string

The ARN of the secret.

Name

Type: string

The name of the secret.

VersionId

Type: string

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

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidParameterException:
The parameter name or value is invalid.
InternalServiceError:
An error occurred on the server side.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.

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 can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

For information about creating a secret in the console, see Create a secret.

To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it.

For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the JSON you store in the SecretString matches the JSON structure of a database secret.

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key 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 Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.

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

Required permissions: secretsmanager:CreateSecret. If you include tags in the secret, you also need secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.

Parameter Syntax

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

Parameter Details

Members

AddReplicaRegions

Type: Array of ReplicaRegionType structures

A list of Regions and KMS keys to replicate secrets.

ClientRequestToken

Type: string

If you include SecretString or SecretBinary, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.

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

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

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

This value becomes the VersionId of the new version.

Description

Type: string

The description of the secret.

ForceOverwriteReplicaSecret

Type: boolean

Specifies whether to overwrite a secret with the same name in the destination Region.

KmsKeyId

Type: string

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.

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

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

Name

Required: Yes
Type: string

The name of the new secret.

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

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

SecretBinary

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

The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

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

This parameter is not available in the Secrets Manager console.

SecretString

Type: string

The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.

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

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

Tags

Type: Array of Tag structures

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

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

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

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

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

The following restrictions apply to tags:

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

Result Syntax

[
    'ARN' => '<string>',
    'Name' => '<string>',
    'ReplicationStatus' => [
        [
            'KmsKeyId' => '<string>',
            'LastAccessedDate' => <DateTime>,
            'Region' => '<string>',
            'Status' => 'InSync|Failed|InProgress',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'VersionId' => '<string>',
]

Result Details

Members

ARN

Type: string

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

Name

Type: string

The name of the new secret.

ReplicationStatus

Type: Array of ReplicationStatusType structures

A list of the replicas of this secret and their status:

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

VersionId

Type: string

The unique identifier associated with the version of the new secret.

Errors

InvalidParameterException:
The parameter name or value is invalid.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
LimitExceededException:
The request failed because it would exceed one of the Secrets Manager quotas.
EncryptionFailure:
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
ResourceExistsException:
A resource with the ID you requested already exists.
ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
MalformedPolicyDocumentException:
The resource policy has syntax errors.
InternalServiceError:
An error occurred on the server side.
PreconditionNotMetException:
The request failed because you did not complete all the prerequisite steps.
DecryptionFailure:
Secrets Manager can't decrypt the protected secret text using the provided KMS key.

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":"EXAMPLE-PASSWORD"}',
]);

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 attached to the secret. To attach a policy to a secret, use PutResourcePolicy.

Required permissions: secretsmanager:DeleteResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

SecretId

Required: Yes
Type: string

The ARN or name of the secret to delete the attached resource-based policy for.

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

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 name of the secret that the resource-based policy was deleted for.

Errors

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

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
InvalidParameterException:
The parameter name or value is invalid.

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 a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 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.

You can't delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately.

You can't directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background.

To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion.

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.

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

When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.

Required permissions: secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

ForceDeleteWithoutRecovery

Type: boolean

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

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

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

RecoveryWindowInDays

Type: long (int|float)

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

SecretId

Required: Yes
Type: string

The ARN or name of the secret to delete.

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

Result Syntax

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

Result Details

Members

ARN

Type: string

The ARN of the secret.

DeletionDate

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

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

Name

Type: string

The name of the secret.

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidParameterException:
The parameter name or value is invalid.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
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 secret value. Secrets Manager only returns fields that have a value in the response.

Required permissions: secretsmanager:DescribeSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

SecretId

Required: Yes
Type: string

The ARN or name of the secret.

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

Result Syntax

[
    'ARN' => '<string>',
    'CreatedDate' => <DateTime>,
    'DeletedDate' => <DateTime>,
    'Description' => '<string>',
    'KmsKeyId' => '<string>',
    'LastAccessedDate' => <DateTime>,
    'LastChangedDate' => <DateTime>,
    'LastRotatedDate' => <DateTime>,
    'Name' => '<string>',
    'OwningService' => '<string>',
    'PrimaryRegion' => '<string>',
    'ReplicationStatus' => [
        [
            'KmsKeyId' => '<string>',
            'LastAccessedDate' => <DateTime>,
            'Region' => '<string>',
            'Status' => 'InSync|Failed|InProgress',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'RotationEnabled' => true || false,
    'RotationLambdaARN' => '<string>',
    'RotationRules' => [
        'AutomaticallyAfterDays' => <integer>,
        'Duration' => '<string>',
        'ScheduleExpression' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VersionIdsToStages' => [
        '<SecretVersionIdType>' => ['<string>', ...],
        // ...
    ],
]

Result Details

Members

ARN

Type: string

The ARN of the secret.

CreatedDate

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

The date the secret was created.

DeletedDate

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

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

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

Description

Type: string

The description of the secret.

KmsKeyId

Type: string

The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

LastAccessedDate

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

The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.

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 Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.

Name

Type: string

The name of the secret.

OwningService

Type: string

The name of the service that created this secret.

PrimaryRegion

Type: string

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

ReplicationStatus

Type: Array of ReplicationStatusType structures

A list of the replicas of this secret and their status:

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

RotationEnabled

Type: boolean

Specifies whether automatic rotation is turned on for this secret.

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

RotationLambdaARN

Type: string

The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

RotationRules

Type: RotationRulesType structure

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

Tags

Type: Array of Tag structures

The list of tags attached to 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 the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.

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

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

During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.

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

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InternalServiceError:
An error occurred on the server side.
InvalidParameterException:
The parameter name or value is invalid.

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' => 14,
        'Duration' => '2h',
        'ScheduleExpression' => 'cron(0 16 1,15 * ? *)',
    ],
    '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. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

Required permissions: secretsmanager:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

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 of the characters that you don't want in the password.

ExcludeLowercase

Type: boolean

Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

ExcludeNumbers

Type: boolean

Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

ExcludePunctuation

Type: boolean

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

ExcludeUppercase

Type: boolean

Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

IncludeSpace

Type: boolean

Specifies whether to include the space character. If you include this switch, the password can contain space characters.

PasswordLength

Type: long (int|float)

The length of the password. If you don't include this parameter, the default length is 32 characters.

RequireEachIncludedType

Type: boolean

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

Result Syntax

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

Result Details

Members

RandomPassword

Type: string

A string with the password.

Errors

InvalidParameterException:
The parameter name or value is invalid.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
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' => 'EXAMPLE-PASSWORD',
]

GetResourcePolicy

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

Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.

Required permissions: secretsmanager:GetResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

SecretId

Required: Yes
Type: string

The ARN or name of the secret to retrieve the attached resource-based policy for.

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

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 name of the secret that the resource-based policy was retrieved for.

ResourcePolicy

Type: string

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

Errors

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

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
InvalidParameterException:
The parameter name or value is invalid.

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.

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

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

Parameter Syntax

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

Parameter Details

Members

SecretId

Required: Yes
Type: string

The ARN or name of the secret to retrieve.

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

VersionId

Type: string

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

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

VersionStage

Type: string

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

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

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. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.

Name

Type: string

The friendly name of the secret.

SecretBinary

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

The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.

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

SecretString

Type: string

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

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

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:
Secrets Manager can't find the resource that you asked for.
InvalidParameterException:
The parameter name or value is invalid.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
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 a secret string value.

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

Result syntax:

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

ListSecretVersionIds

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

Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.

To list the secrets in the account, use ListSecrets.

Required permissions: secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

IncludeDeprecated

Type: boolean

Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager.

MaxResults

Type: int

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecretVersionIds again with the value from NextToken.

NextToken

Type: string

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds again with this value.

SecretId

Required: Yes
Type: string

The ARN or name of the secret whose versions you want to list.

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

Result Syntax

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

Result Details

Members

ARN

Type: string

The ARN of the secret.

Name

Type: string

The name of the secret.

NextToken

Type: string

Secrets Manager includes this value if there's more output available than what is 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 long list. To get the next results, call ListSecretVersionIds again with this value.

Versions

Type: Array of SecretVersionsListEntry structures

A list of the versions of the secret.

Errors

InvalidNextTokenException:
The NextToken value is invalid.
ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InternalServiceError:
An error occurred on the server side.
InvalidParameterException:
The parameter name or value is invalid.

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 the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

ListSecrets is eventually consistent, however it might not reflect changes from the last five minutes. To get the latest information for a specific secret, use DescribeSecret.

To list the versions of a secret, use ListSecretVersionIds.

To get the secret value from SecretString or SecretBinary, call GetSecretValue.

For information about finding secrets in the console, see Find secrets in Secrets Manager.

Required permissions: secretsmanager:ListSecrets. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

$result = $client->listSecrets([
    'Filters' => [
        [
            'Key' => 'description|name|tag-key|tag-value|primary-region|all',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortOrder' => 'asc|desc',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

The filters to apply to the list of secrets.

MaxResults

Type: int

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.

NextToken

Type: string

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.

SortOrder

Type: string

Lists secrets in the requested order.

Result Syntax

[
    'NextToken' => '<string>',
    'SecretList' => [
        [
            'ARN' => '<string>',
            'CreatedDate' => <DateTime>,
            'DeletedDate' => <DateTime>,
            'Description' => '<string>',
            'KmsKeyId' => '<string>',
            'LastAccessedDate' => <DateTime>,
            'LastChangedDate' => <DateTime>,
            'LastRotatedDate' => <DateTime>,
            'Name' => '<string>',
            'OwningService' => '<string>',
            'PrimaryRegion' => '<string>',
            'RotationEnabled' => true || false,
            'RotationLambdaARN' => '<string>',
            'RotationRules' => [
                'AutomaticallyAfterDays' => <integer>,
                'Duration' => '<string>',
                'ScheduleExpression' => '<string>',
            ],
            '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:
The parameter name or value is invalid.
InvalidNextTokenException:
The NextToken value is invalid.
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 a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager

For information about attaching a policy in the console, see Attach a permissions policy to a secret.

Required permissions: secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

BlockPublicPolicy

Type: boolean

Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.

ResourcePolicy

Required: Yes
Type: string

A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.

SecretId

Required: Yes
Type: string

The ARN or name of the secret to attach the resource-based policy.

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

Result Syntax

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

Result Details

Members

ARN

Type: string

The ARN of the secret.

Name

Type: string

The name of the secret.

Errors

MalformedPolicyDocumentException:
The resource policy has syntax errors.
ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidParameterException:
The parameter name or value is invalid.
InternalServiceError:
An error occurred on the server side.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
PublicPolicyException:
The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.

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([/* ... */]);

Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value.

We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.

You can specify the staging labels to attach to the new version in VersionStages. If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it .

If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

This operation is idempotent. If you call this operation with a ClientRequestToken that matches an existing version's VersionId, 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 can't modify an existing version; you can only create new ones.

Required permissions: secretsmanager:PutSecretValue. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

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

A unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. 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 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 the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a 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)

The binary data 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 pass the contents of the file as a parameter.

You must include SecretBinary or SecretString, but not both.

You can't access this value from the Secrets Manager console.

SecretId

Required: Yes
Type: string

The ARN or name of the secret to add a new version to.

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

If the secret doesn't already exist, use CreateSecret instead.

SecretString

Type: string

The text to encrypt and store in the new version of the secret.

You must include SecretBinary or SecretString, but not both.

We recommend you create the secret string as JSON key/value pairs, as shown in the example.

VersionStages

Type: Array of strings

A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

Result Syntax

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

Result Details

Members

ARN

Type: string

The ARN of the secret.

Name

Type: string

The name of the secret.

VersionId

Type: string

The unique identifier of the version of the secret.

VersionStages

Type: Array of strings

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

Errors

InvalidParameterException:
The parameter name or value is invalid.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
LimitExceededException:
The request failed because it would exceed one of the Secrets Manager quotas.
EncryptionFailure:
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
ResourceExistsException:
A resource with the ID you requested already exists.
ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InternalServiceError:
An error occurred on the server side.
DecryptionFailure:
Secrets Manager can't decrypt the protected secret text using the provided KMS key.

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":"EXAMPLE-PASSWORD"}',
]);

Result syntax:

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

RemoveRegionsFromReplication

$result = $client->removeRegionsFromReplication([/* ... */]);
$promise = $client->removeRegionsFromReplicationAsync([/* ... */]);

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

Required permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

RemoveReplicaRegions

Required: Yes
Type: Array of strings

The Regions of the replicas to remove.

SecretId

Required: Yes
Type: string

The ARN or name of the secret.

Result Syntax

[
    'ARN' => '<string>',
    'ReplicationStatus' => [
        [
            'KmsKeyId' => '<string>',
            'LastAccessedDate' => <DateTime>,
            'Region' => '<string>',
            'Status' => 'InSync|Failed|InProgress',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ARN

Type: string

The ARN of the primary secret.

ReplicationStatus

Type: Array of ReplicationStatusType structures

The status of replicas for this secret after you remove Regions.

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
InvalidParameterException:
The parameter name or value is invalid.
InternalServiceError:
An error occurred on the server side.

ReplicateSecretToRegions

$result = $client->replicateSecretToRegions([/* ... */]);
$promise = $client->replicateSecretToRegionsAsync([/* ... */]);

Replicates the secret to a new Regions. See Multi-Region secrets.

Required permissions: secretsmanager:ReplicateSecretToRegions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

$result = $client->replicateSecretToRegions([
    'AddReplicaRegions' => [ // REQUIRED
        [
            'KmsKeyId' => '<string>',
            'Region' => '<string>',
        ],
        // ...
    ],
    'ForceOverwriteReplicaSecret' => true || false,
    'SecretId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AddReplicaRegions

Required: Yes
Type: Array of ReplicaRegionType structures

A list of Regions in which to replicate the secret.

ForceOverwriteReplicaSecret

Type: boolean

Specifies whether to overwrite a secret with the same name in the destination Region.

SecretId

Required: Yes
Type: string

The ARN or name of the secret to replicate.

Result Syntax

[
    'ARN' => '<string>',
    'ReplicationStatus' => [
        [
            'KmsKeyId' => '<string>',
            'LastAccessedDate' => <DateTime>,
            'Region' => '<string>',
            'Status' => 'InSync|Failed|InProgress',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ARN

Type: string

The ARN of the primary secret.

ReplicationStatus

Type: Array of ReplicationStatusType structures

The status of replication.

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
InvalidParameterException:
The parameter name or value is invalid.
InternalServiceError:
An error occurred on the server side.

RestoreSecret

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

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.

Required permissions: secretsmanager:RestoreSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

SecretId

Required: Yes
Type: string

The ARN or name of the secret to restore.

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

Result Syntax

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

Result Details

Members

ARN

Type: string

The ARN of the secret that was restored.

Name

Type: string

The name of the secret that was restored.

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidParameterException:
The parameter name or value is invalid.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
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 the secret. For more information about rotation, see Rotate secrets.

If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.

For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the secret value is in the JSON structure of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser secret.

To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule for the rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the database or service to match. After testing the new credentials, the function marks the new secret version with the staging label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more information, see How rotation works.

You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose a template that matches your Rotation strategy.

When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but 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.

Required permissions: secretsmanager:RotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. For more information, see Permissions for rotation.

Parameter Syntax

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

Parameter Details

Members

ClientRequestToken

Type: string

A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId of the new version.

If you use the Amazon Web Services CLI or one of the Amazon Web Services 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 this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

RotateImmediately

Type: boolean

Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.

If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.

RotationLambdaARN

Type: string

The ARN of the Lambda rotation 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

The ARN or name of the secret to rotate.

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

Result Syntax

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

Result Details

Members

ARN

Type: string

The ARN of the secret.

Name

Type: string

The name of the secret.

VersionId

Type: string

The ID of the new version of the secret.

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidParameterException:
The parameter name or value is invalid.
InternalServiceError:
An error occurred on the server side.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.

Examples

Example 1: To configure rotation for a secret

The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM.

$result = $client->rotateSecret([
    'RotationLambdaARN' => 'arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda',
    'RotationRules' => [
        'Duration' => '2h',
        'ScheduleExpression' => 'cron(0 16 1,15 * ? *)',
    ],
    '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:

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

StopReplicationToReplica

$result = $client->stopReplicationToReplica([/* ... */]);
$promise = $client->stopReplicationToReplicaAsync([/* ... */]);

Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.

You must call this operation from the Region in which you want to promote the replica to a primary secret.

Required permissions: secretsmanager:StopReplicationToReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

SecretId

Required: Yes
Type: string

The ARN of the primary secret.

Result Syntax

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

Result Details

Members

ARN

Type: string

The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
InvalidParameterException:
The parameter name or value is invalid.
InternalServiceError:
An error occurred on the server side.

TagResource

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

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.

The following restrictions apply to tags:

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

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.

Required permissions: secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

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 to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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

Tags

Required: Yes
Type: Array of Tag structures

The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
InvalidParameterException:
The parameter name or value is invalid.
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 specific tags from a 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.

Required permissions: secretsmanager:UntagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

SecretId

Required: Yes
Type: string

The ARN or name of the secret.

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

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.

This parameter requires a JSON text string argument.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
InvalidParameterException:
The parameter name or value is invalid.
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 the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

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

We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.

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 this operation with a ClientRequestToken that matches an existing version's VersionId, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.

Required permissions: secretsmanager:UpdateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also have kms:GenerateDataKey and kms:Decrypt permissions on the key. For more information, see Secret encryption and decryption.

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

If you include SecretString or SecretBinary, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.

This value becomes the VersionId of the new version.

Description

Type: string

The description of the secret.

KmsKeyId

Type: string

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about versions and staging labels, see Concepts: Version.

You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.

SecretBinary

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

The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

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

You can't access this parameter in the Secrets Manager console.

SecretId

Required: Yes
Type: string

The ARN or name of the secret.

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

SecretString

Type: string

The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.

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

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 name of the secret that was updated.

VersionId

Type: string

If Secrets Manager created a new version of the secret during this operation, then VersionId contains the unique identifier of the new version.

Errors

InvalidParameterException:
The parameter name or value is invalid.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
LimitExceededException:
The request failed because it would exceed one of the Secrets Manager quotas.
EncryptionFailure:
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
ResourceExistsException:
A resource with the ID you requested already exists.
ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
MalformedPolicyDocumentException:
The resource policy has syntax errors.
InternalServiceError:
An error occurred on the server side.
PreconditionNotMetException:
The request failed because you did not complete all the prerequisite steps.
DecryptionFailure:
Secrets Manager can't decrypt the protected secret text using the provided KMS key.

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. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version.

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.

Required permissions: secretsmanager:UpdateSecretVersionStage. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

MoveToVersionId

Type: string

The ID of the version to add the staging label to. 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

The 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

The ARN or the name of the secret with the version and staging labelsto modify.

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

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 that was updated.

Name

Type: string

The name of the secret that was updated.

Errors

ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidParameterException:
The parameter name or value is invalid.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
LimitExceededException:
The request failed because it would exceed one of the Secrets Manager quotas.
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',
]

ValidateResourcePolicy

$result = $client->validateResourcePolicy([/* ... */]);
$promise = $client->validateResourcePolicyAsync([/* ... */]);

Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets.

The API performs three checks when validating the policy:

Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.

Required permissions: secretsmanager:ValidateResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Members

ResourcePolicy

Required: Yes
Type: string

A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.

SecretId

Type: string

This field is reserved for internal use.

Result Syntax

[
    'PolicyValidationPassed' => true || false,
    'ValidationErrors' => [
        [
            'CheckName' => '<string>',
            'ErrorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

PolicyValidationPassed

Type: boolean

True if your policy passes validation, otherwise false.

ValidationErrors

Type: Array of ValidationErrorsEntry structures

Validation errors if your policy didn't pass validation.

Errors

MalformedPolicyDocumentException:
The resource policy has syntax errors.
ResourceNotFoundException:
Secrets Manager can't find the resource that you asked for.
InvalidParameterException:
The parameter name or value is invalid.
InternalServiceError:
An error occurred on the server side.
InvalidRequestException:
A parameter value is not valid for the current state of the resource.

Possible causes:
- The secret is scheduled for deletion.
- You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.

Examples

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

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

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

Result syntax:

[
    'PolicyValidationPassed' => 1,
    'ValidationErrors' => [
    ],
]

Shapes

DecryptionFailure

Description

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

Members

Message

Type: string

EncryptionFailure

Description

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

Members

Message

Type: string

Filter

Description

Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.

Members

Key

Type: string

The following are keys you can use:

description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.

Values

Type: Array of strings

The keyword to filter for.

You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

InternalServiceError

Description

An error occurred on the server side.

Members

Message

Type: string

InvalidNextTokenException

Description

The NextToken value is invalid.

Members

Message

Type: string

InvalidParameterException

Description

The parameter name or value is invalid.

Members

Message

Type: string

InvalidRequestException

Description

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

Possible causes:

The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.

Members

Message

Type: string

LimitExceededException

Description

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

Members

Message

Type: string

MalformedPolicyDocumentException

Description

The resource policy has syntax errors.

Members

Message

Type: string

PreconditionNotMetException

Description

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

Members

Message

Type: string

PublicPolicyException

Description

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

Members

Message

Type: string

ReplicaRegionType

Description

A custom type that specifies a Region and the KmsKeyId for a replica secret.

Members

KmsKeyId

Type: string

The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.

Region

Type: string

A Region code. For a list of Region codes, see Name and code of Regions.

ReplicationStatusType

Description

A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.

Members

KmsKeyId

Type: string

Can be an ARN, Key ID, or Alias.

LastAccessedDate

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

The date that you last accessed the secret in the Region.

Region

Type: string

The Region where replication occurs.

Status

Type: string

The status can be InProgress, Failed, or InSync.

StatusMessage

Type: string

Status message such as "Secret with this name already exists in this region".

ResourceExistsException

Description

A resource with the ID you requested already exists.

Members

Message

Type: string

ResourceNotFoundException

Description

Secrets Manager 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)

The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.

In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both.

Duration

Type: string

The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not go into the next UTC day. If you don't specify this value, the window automatically ends at the end of the UTC day. The window begins according to the ScheduleExpression. For more information, including examples, see Schedule expressions in Secrets Manager rotation.

ScheduleExpression

Type: string

A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone.

Secrets Manager rate() expressions represent the interval in days that you want to rotate your secret, for example rate(10 days). If you use a rate() expression, the rotation window opens at midnight, and Secrets Manager rotates your secret any time that day after midnight. You can set a Duration to shorten the rotation window.

You can use a cron() expression to create rotation schedules that are more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation. If you use a cron() expression, Secrets Manager rotates your secret any time during that day after the window opens. For example, cron(0 8 1 * ? *) represents a rotation window that occurs on the first day of every month beginning at 8:00 AM UTC. Secrets Manager rotates the secret any time that day after 8:00 AM. You can set a Duration to shorten the rotation window.

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

Members

ARN

Type: string

The Amazon Resource Name (ARN) of the secret.

CreatedDate

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

The date and time when a secret was created.

DeletedDate

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

The date and time the deletion of the secret occurred. 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 of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

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 hasn't ever rotated.

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

Returns the name of the service that created the secret.

PrimaryRegion

Type: string

The Region where Secrets Manager originated the secret.

RotationEnabled

Type: boolean

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

RotationLambdaARN

Type: string

The ARN of an Amazon Web Services Lambda function 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 attached to each one. 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 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.

KmsKeyIds

Type: Array of strings

The KMS keys used to encrypt the secret version.

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.

ValidationErrorsEntry

Description

Displays errors that occurred during validation of the resource policy.

Members

CheckName

Type: string

Checks the name of the policy.

ErrorMessage

Type: string

Displays error messages if validation encounters problems during validation of the resource policy.

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