BatchGetSecretValue

$result = $client->batchGetSecretValue([/* ... */]);
$promise = $client->batchGetSecretValueAsync([/* ... */]);

Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.

To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response.

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

Required permissions: secretsmanager:BatchGetSecretValue, and you must have secretsmanager:GetSecretValue for each secret. If you use filters, you must also have secretsmanager:ListSecrets. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for the keys. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

DecryptionFailure:

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

InternalServiceError:

An error occurred on the server side.

InvalidNextTokenException:

The NextToken value is invalid.

Examples

Example 1: To retrieve the secret values for a group of secrets listed by name

The following example gets the values for three secrets.

$result = $client->batchGetSecretValue([
    'SecretIdList' => [
        'MySecret1',
        'MySecret2',
        'MySecret3',
    ],
]);

Result syntax:

[
    'Errors' => [
    ],
    'SecretValues' => [
        [
            'ARN' => '®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret1-a1b2c3',
            'CreatedDate' => ,
            'Name' => 'MySecret1',
            'SecretString' => '{"username":"diego_ramirez","password":"EXAMPLE-PASSWORD","engine":"mysql","host":"secretsmanagertutorial.cluster.us-west-2.rds.amazonaws.com","port":3306,"dbClusterIdentifier":"secretsmanagertutorial"}',
            'VersionId' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa',
            'VersionStages' => [
                'AWSCURRENT',
            ],
        ],
        [
            'ARN' => '®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret2-a1b2c3',
            'CreatedDate' => ,
            'Name' => 'MySecret2',
            'SecretString' => '{"username":"akua_mansa","password":"EXAMPLE-PASSWORD"',
            'VersionId' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb',
            'VersionStages' => [
                'AWSCURRENT',
            ],
        ],
        [
            'ARN' => '®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret3-a1b2c3',
            'CreatedDate' => ,
            'Name' => 'MySecret3',
            'SecretString' => '{"username":"jie_liu","password":"EXAMPLE-PASSWORD"',
            'VersionId' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc',
            'VersionStages' => [
                'AWSCURRENT',
            ],
        ],
    ],
]

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.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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 secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager:CreateSecret. If you include tags in the secret, you also need secretsmanager:TagResource. To add replica Regions, you must also have secretsmanager:ReplicateSecretToRegions. 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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager: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

Result Syntax

[
    'ARN' => '<string>',
    'CreatedDate' => <DateTime>,
    'DeletedDate' => <DateTime>,
    'Description' => '<string>',
    'KmsKeyId' => '<string>',
    'LastAccessedDate' => <DateTime>,
    'LastChangedDate' => <DateTime>,
    'LastRotatedDate' => <DateTime>,
    'Name' => '<string>',
    'NextRotationDate' => <DateTime>,
    '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

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',
    'NextRotationDate' => ,
    '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. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~

Secrets Manager generates a CloudTrail log entry when you call this action.

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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

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

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.

To list the versions of a secret, use ListSecretVersionIds.

To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.

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

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

Required permissions: secretsmanager: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|owning-service|all',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'IncludePlannedDeletion' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortOrder' => 'asc|desc',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SecretList' => [
        [
            'ARN' => '<string>',
            'CreatedDate' => <DateTime>,
            'DeletedDate' => <DateTime>,
            'Description' => '<string>',
            'KmsKeyId' => '<string>',
            'LastAccessedDate' => <DateTime>,
            'LastChangedDate' => <DateTime>,
            'LastRotatedDate' => <DateTime>,
            'Name' => '<string>',
            'NextRotationDate' => <DateTime>,
            '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

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

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>',
    'RotationToken' => '<string>',
    'SecretBinary' => <string || resource || Psr\Http\Message\StreamInterface>,
    'SecretId' => '<string>', // REQUIRED
    'SecretString' => '<string>',
    'VersionStages' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager:ReplicateSecretToRegions. If the primary secret is encrypted with a KMS key other than aws/secretsmanager, you also need kms:Decrypt permission to the key. To encrypt the replicated secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Encrypt to the key. 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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

InvalidParameterException:

The parameter name or value is invalid.

InternalServiceError:

An error occurred on the server side.

Examples

Example 1: Example

The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key aws/secretsmanager.

$result = $client->replicateSecretToRegions([
    'AddReplicaRegions' => [
        [
            'Region' => 'eu-west-3',
        ],
    ],
    'ForceOverwriteReplicaSecret' => 1,
    'SecretId' => 'MyTestSecret',
]);

Result syntax:

[
    'ARN' => 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c',
    'ReplicationStatus' => [
        [
            'KmsKeyId' => 'alias/aws/secretsmanager',
            'Region' => 'eu-west-3',
            'Status' => 'InProgress',
        ],
    ],
]

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.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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 information about rotation, see Rotate secrets in the Secrets Manager User Guide. 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.

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. When rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.

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

Required permissions: secretsmanager: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

Result Syntax

[]

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager: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

Result Syntax

[]

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.

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 moves the staging label AWSCURRENT to the new version. Then it attaches the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

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.

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

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, kms:Encrypt, and kms:Decrypt permissions on the key. If you change the KMS key and you don't have kms:Encrypt permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new 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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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.

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

Required permissions: secretsmanager: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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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.

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

Required permissions: secretsmanager:ValidateResourcePolicy and secretsmanager:PutResourcePolicy. 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

Result Syntax

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

Result Details

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.

• The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.

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' => [
    ],
]