Package software.amazon.awssdk.services.secretsmanager

Interface SecretsManagerClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface SecretsManagerClient
extends AwsClient

Service client for accessing AWS Secrets Manager. This can be created using the static builder() method. Amazon Web Services Secrets Manager

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.

API Version

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

For a list of endpoints, see Amazon Web Services Secrets Manager endpoints.

Support and Feedback for Amazon Web Services Secrets Manager

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.

Logging API Requests

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchGetSecretValueResponse	batchGetSecretValue(Consumer<BatchGetSecretValueRequest.Builder> batchGetSecretValueRequest)	Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets.
default BatchGetSecretValueResponse	batchGetSecretValue(BatchGetSecretValueRequest batchGetSecretValueRequest)	Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets.
default BatchGetSecretValueIterable	batchGetSecretValuePaginator(Consumer<BatchGetSecretValueRequest.Builder> batchGetSecretValueRequest)	This is a variant of batchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest) operation.
default BatchGetSecretValueIterable	batchGetSecretValuePaginator(BatchGetSecretValueRequest batchGetSecretValueRequest)	This is a variant of batchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest) operation.
static SecretsManagerClientBuilder	builder()	Create a builder that can be used to configure and create a SecretsManagerClient.
default CancelRotateSecretResponse	cancelRotateSecret(Consumer<CancelRotateSecretRequest.Builder> cancelRotateSecretRequest)	Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
default CancelRotateSecretResponse	cancelRotateSecret(CancelRotateSecretRequest cancelRotateSecretRequest)	Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
static SecretsManagerClient	create()	Create a SecretsManagerClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateSecretResponse	createSecret(Consumer<CreateSecretRequest.Builder> createSecretRequest)	Creates a new secret.
default CreateSecretResponse	createSecret(CreateSecretRequest createSecretRequest)	Creates a new secret.
default DeleteResourcePolicyResponse	deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)	Deletes the resource-based permission policy attached to the secret.
default DeleteResourcePolicyResponse	deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)	Deletes the resource-based permission policy attached to the secret.
default DeleteSecretResponse	deleteSecret(Consumer<DeleteSecretRequest.Builder> deleteSecretRequest)	Deletes a secret and all of its versions.
default DeleteSecretResponse	deleteSecret(DeleteSecretRequest deleteSecretRequest)	Deletes a secret and all of its versions.
default DescribeSecretResponse	describeSecret(Consumer<DescribeSecretRequest.Builder> describeSecretRequest)	Retrieves the details of a secret.
default DescribeSecretResponse	describeSecret(DescribeSecretRequest describeSecretRequest)	Retrieves the details of a secret.
default GetRandomPasswordResponse	getRandomPassword()	Generates a random password.
default GetRandomPasswordResponse	getRandomPassword(Consumer<GetRandomPasswordRequest.Builder> getRandomPasswordRequest)	Generates a random password.
default GetRandomPasswordResponse	getRandomPassword(GetRandomPasswordRequest getRandomPasswordRequest)	Generates a random password.
default GetResourcePolicyResponse	getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)	Retrieves the JSON text of the resource-based policy document attached to the secret.
default GetResourcePolicyResponse	getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)	Retrieves the JSON text of the resource-based policy document attached to the secret.
default GetSecretValueResponse	getSecretValue(Consumer<GetSecretValueRequest.Builder> getSecretValueRequest)	Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.
default GetSecretValueResponse	getSecretValue(GetSecretValueRequest getSecretValueRequest)	Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.
default ListSecretsResponse	listSecrets()	Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion.
default ListSecretsResponse	listSecrets(Consumer<ListSecretsRequest.Builder> listSecretsRequest)	Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion.
default ListSecretsResponse	listSecrets(ListSecretsRequest listSecretsRequest)	Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion.
default ListSecretsIterable	listSecretsPaginator()	This is a variant of listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest) operation.
default ListSecretsIterable	listSecretsPaginator(Consumer<ListSecretsRequest.Builder> listSecretsRequest)	This is a variant of listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest) operation.
default ListSecretsIterable	listSecretsPaginator(ListSecretsRequest listSecretsRequest)	This is a variant of listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest) operation.
default ListSecretVersionIdsResponse	listSecretVersionIds(Consumer<ListSecretVersionIdsRequest.Builder> listSecretVersionIdsRequest)	Lists the versions of a secret.
default ListSecretVersionIdsResponse	listSecretVersionIds(ListSecretVersionIdsRequest listSecretVersionIdsRequest)	Lists the versions of a secret.
default ListSecretVersionIdsIterable	listSecretVersionIdsPaginator(Consumer<ListSecretVersionIdsRequest.Builder> listSecretVersionIdsRequest)	This is a variant of listSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest) operation.
default ListSecretVersionIdsIterable	listSecretVersionIdsPaginator(ListSecretVersionIdsRequest listSecretVersionIdsRequest)	This is a variant of listSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest) operation.
default PutResourcePolicyResponse	putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)	Attaches a resource-based permission policy to a secret.
default PutResourcePolicyResponse	putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)	Attaches a resource-based permission policy to a secret.
default PutSecretValueResponse	putSecretValue(Consumer<PutSecretValueRequest.Builder> putSecretValueRequest)	Creates a new version with a new encrypted secret value and attaches it to the secret.
default PutSecretValueResponse	putSecretValue(PutSecretValueRequest putSecretValueRequest)	Creates a new version with a new encrypted secret value and attaches it to the secret.
default RemoveRegionsFromReplicationResponse	removeRegionsFromReplication(Consumer<RemoveRegionsFromReplicationRequest.Builder> removeRegionsFromReplicationRequest)	For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
default RemoveRegionsFromReplicationResponse	removeRegionsFromReplication(RemoveRegionsFromReplicationRequest removeRegionsFromReplicationRequest)	For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
default ReplicateSecretToRegionsResponse	replicateSecretToRegions(Consumer<ReplicateSecretToRegionsRequest.Builder> replicateSecretToRegionsRequest)	Replicates the secret to a new Regions.
default ReplicateSecretToRegionsResponse	replicateSecretToRegions(ReplicateSecretToRegionsRequest replicateSecretToRegionsRequest)	Replicates the secret to a new Regions.
default RestoreSecretResponse	restoreSecret(Consumer<RestoreSecretRequest.Builder> restoreSecretRequest)	Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp.
default RestoreSecretResponse	restoreSecret(RestoreSecretRequest restoreSecretRequest)	Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp.
default RotateSecretResponse	rotateSecret(Consumer<RotateSecretRequest.Builder> rotateSecretRequest)	Configures and starts the asynchronous process of rotating the secret.
default RotateSecretResponse	rotateSecret(RotateSecretRequest rotateSecretRequest)	Configures and starts the asynchronous process of rotating the secret.
default SecretsManagerServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default StopReplicationToReplicaResponse	stopReplicationToReplica(Consumer<StopReplicationToReplicaRequest.Builder> stopReplicationToReplicaRequest)	Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
default StopReplicationToReplicaResponse	stopReplicationToReplica(StopReplicationToReplicaRequest stopReplicationToReplicaRequest)	Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Attaches tags to a secret.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Attaches tags to a secret.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes specific tags from a secret.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes specific tags from a secret.
default UpdateSecretResponse	updateSecret(Consumer<UpdateSecretRequest.Builder> updateSecretRequest)	Modifies the details of a secret, including metadata and the secret value.
default UpdateSecretResponse	updateSecret(UpdateSecretRequest updateSecretRequest)	Modifies the details of a secret, including metadata and the secret value.
default UpdateSecretVersionStageResponse	updateSecretVersionStage(Consumer<UpdateSecretVersionStageRequest.Builder> updateSecretVersionStageRequest)	Modifies the staging labels attached to a version of a secret.
default UpdateSecretVersionStageResponse	updateSecretVersionStage(UpdateSecretVersionStageRequest updateSecretVersionStageRequest)	Modifies the staging labels attached to a version of a secret.
default ValidateResourcePolicyResponse	validateResourcePolicy(Consumer<ValidateResourcePolicyRequest.Builder> validateResourcePolicyRequest)	Validates that a resource policy does not grant a wide range of principals access to your secret.
default ValidateResourcePolicyResponse	validateResourcePolicy(ValidateResourcePolicyRequest validateResourcePolicyRequest)	Validates that a resource policy does not grant a wide range of principals access to your secret.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

batchGetSecretValue

default BatchGetSecretValueResponse batchGetSecretValue(BatchGetSecretValueRequest batchGetSecretValueRequest)
                                                 throws ResourceNotFoundException,
                                                        InvalidParameterException,
                                                        InvalidRequestException,
                                                        DecryptionFailureException,
                                                        InternalServiceErrorException,
                                                        InvalidNextTokenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        SecretsManagerException

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.

Parameters:

batchGetSecretValueRequest -

Returns:

Result of the BatchGetSecretValue operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

InvalidNextTokenException - The NextToken value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

batchGetSecretValue

default BatchGetSecretValueResponse batchGetSecretValue(Consumer<BatchGetSecretValueRequest.Builder> batchGetSecretValueRequest)
                                                 throws ResourceNotFoundException,
                                                        InvalidParameterException,
                                                        InvalidRequestException,
                                                        DecryptionFailureException,
                                                        InternalServiceErrorException,
                                                        InvalidNextTokenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        SecretsManagerException

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.

This is a convenience which creates an instance of the BatchGetSecretValueRequest.Builder avoiding the need to create one manually via BatchGetSecretValueRequest.builder()

Parameters:

batchGetSecretValueRequest - A Consumer that will call methods on BatchGetSecretValueRequest.Builder to create a request.

Returns:

Result of the BatchGetSecretValue operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

InvalidNextTokenException - The NextToken value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

batchGetSecretValuePaginator

default BatchGetSecretValueIterable batchGetSecretValuePaginator(BatchGetSecretValueRequest batchGetSecretValueRequest)
                                                          throws ResourceNotFoundException,
                                                                 InvalidParameterException,
                                                                 InvalidRequestException,
                                                                 DecryptionFailureException,
                                                                 InternalServiceErrorException,
                                                                 InvalidNextTokenException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 SecretsManagerException

This is a variant of batchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValueIterable responses = client.batchGetSecretValuePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValueIterable responses = client
             .batchGetSecretValuePaginator(request);
     for (software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValueIterable responses = client.batchGetSecretValuePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the batchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest) operation.

Parameters:

batchGetSecretValueRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

InvalidNextTokenException - The NextToken value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

batchGetSecretValuePaginator

default BatchGetSecretValueIterable batchGetSecretValuePaginator(Consumer<BatchGetSecretValueRequest.Builder> batchGetSecretValueRequest)
                                                          throws ResourceNotFoundException,
                                                                 InvalidParameterException,
                                                                 InvalidRequestException,
                                                                 DecryptionFailureException,
                                                                 InternalServiceErrorException,
                                                                 InvalidNextTokenException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 SecretsManagerException

This is a variant of batchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValueIterable responses = client.batchGetSecretValuePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValueIterable responses = client
             .batchGetSecretValuePaginator(request);
     for (software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValueIterable responses = client.batchGetSecretValuePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the batchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest) operation.

This is a convenience which creates an instance of the BatchGetSecretValueRequest.Builder avoiding the need to create one manually via BatchGetSecretValueRequest.builder()

Parameters:

batchGetSecretValueRequest - A Consumer that will call methods on BatchGetSecretValueRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

InvalidNextTokenException - The NextToken value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

cancelRotateSecret

default CancelRotateSecretResponse cancelRotateSecret(CancelRotateSecretRequest cancelRotateSecretRequest)
                                               throws ResourceNotFoundException,
                                                      InvalidParameterException,
                                                      InternalServiceErrorException,
                                                      InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      SecretsManagerException

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.

Parameters:

cancelRotateSecretRequest -

Returns:

Result of the CancelRotateSecret operation returned by the service.

Throws:

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

InvalidParameterException - The parameter name or value is invalid.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

cancelRotateSecret

default CancelRotateSecretResponse cancelRotateSecret(Consumer<CancelRotateSecretRequest.Builder> cancelRotateSecretRequest)
                                               throws ResourceNotFoundException,
                                                      InvalidParameterException,
                                                      InternalServiceErrorException,
                                                      InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      SecretsManagerException

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.

This is a convenience which creates an instance of the CancelRotateSecretRequest.Builder avoiding the need to create one manually via CancelRotateSecretRequest.builder()

Parameters:

cancelRotateSecretRequest - A Consumer that will call methods on CancelRotateSecretRequest.Builder to create a request.

Returns:

Result of the CancelRotateSecret operation returned by the service.

Throws:

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

InvalidParameterException - The parameter name or value is invalid.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createSecret

default CreateSecretResponse createSecret(CreateSecretRequest createSecretRequest)
                                   throws InvalidParameterException,
                                          InvalidRequestException,
                                          LimitExceededException,
                                          EncryptionFailureException,
                                          ResourceExistsException,
                                          ResourceNotFoundException,
                                          MalformedPolicyDocumentException,
                                          InternalServiceErrorException,
                                          PreconditionNotMetException,
                                          DecryptionFailureException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecretsManagerException

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

Parameters:

createSecretRequest -

Returns:

Result of the CreateSecret operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

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

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createSecret

default CreateSecretResponse createSecret(Consumer<CreateSecretRequest.Builder> createSecretRequest)
                                   throws InvalidParameterException,
                                          InvalidRequestException,
                                          LimitExceededException,
                                          EncryptionFailureException,
                                          ResourceExistsException,
                                          ResourceNotFoundException,
                                          MalformedPolicyDocumentException,
                                          InternalServiceErrorException,
                                          PreconditionNotMetException,
                                          DecryptionFailureException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecretsManagerException

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

This is a convenience which creates an instance of the CreateSecretRequest.Builder avoiding the need to create one manually via CreateSecretRequest.builder()

Parameters:

createSecretRequest - A Consumer that will call methods on CreateSecretRequest.Builder to create a request.

Returns:

Result of the CreateSecret operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

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

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
                                                   throws ResourceNotFoundException,
                                                          InternalServiceErrorException,
                                                          InvalidRequestException,
                                                          InvalidParameterException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          SecretsManagerException

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.

Parameters:

deleteResourcePolicyRequest -

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

Throws:

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

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
                                                   throws ResourceNotFoundException,
                                                          InternalServiceErrorException,
                                                          InvalidRequestException,
                                                          InvalidParameterException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          SecretsManagerException

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.

This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the need to create one manually via DeleteResourcePolicyRequest.builder()

Parameters:

deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

Throws:

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

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteSecret

default DeleteSecretResponse deleteSecret(DeleteSecretRequest deleteSecretRequest)
                                   throws ResourceNotFoundException,
                                          InvalidParameterException,
                                          InvalidRequestException,
                                          InternalServiceErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecretsManagerException

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.

Parameters:

deleteSecretRequest -

Returns:

Result of the DeleteSecret operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteSecret

default DeleteSecretResponse deleteSecret(Consumer<DeleteSecretRequest.Builder> deleteSecretRequest)
                                   throws ResourceNotFoundException,
                                          InvalidParameterException,
                                          InvalidRequestException,
                                          InternalServiceErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecretsManagerException

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.

This is a convenience which creates an instance of the DeleteSecretRequest.Builder avoiding the need to create one manually via DeleteSecretRequest.builder()

Parameters:

deleteSecretRequest - A Consumer that will call methods on DeleteSecretRequest.Builder to create a request.

Returns:

Result of the DeleteSecret operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeSecret

default DescribeSecretResponse describeSecret(DescribeSecretRequest describeSecretRequest)
                                       throws ResourceNotFoundException,
                                              InternalServiceErrorException,
                                              InvalidParameterException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SecretsManagerException

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.

Parameters:

describeSecretRequest -

Returns:

Result of the DescribeSecret operation returned by the service.

Throws:

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

InternalServiceErrorException - An error occurred on the server side.

InvalidParameterException - The parameter name or value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeSecret

default DescribeSecretResponse describeSecret(Consumer<DescribeSecretRequest.Builder> describeSecretRequest)
                                       throws ResourceNotFoundException,
                                              InternalServiceErrorException,
                                              InvalidParameterException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SecretsManagerException

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.

This is a convenience which creates an instance of the DescribeSecretRequest.Builder avoiding the need to create one manually via DescribeSecretRequest.builder()

Parameters:

describeSecretRequest - A Consumer that will call methods on DescribeSecretRequest.Builder to create a request.

Returns:

Result of the DescribeSecret operation returned by the service.

Throws:

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

InternalServiceErrorException - An error occurred on the server side.

InvalidParameterException - The parameter name or value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getRandomPassword

default GetRandomPasswordResponse getRandomPassword(GetRandomPasswordRequest getRandomPasswordRequest)
                                             throws InvalidParameterException,
                                                    InvalidRequestException,
                                                    InternalServiceErrorException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecretsManagerException

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. 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:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameters:

getRandomPasswordRequest -

Returns:

Result of the GetRandomPassword operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getRandomPassword

default GetRandomPasswordResponse getRandomPassword(Consumer<GetRandomPasswordRequest.Builder> getRandomPasswordRequest)
                                             throws InvalidParameterException,
                                                    InvalidRequestException,
                                                    InternalServiceErrorException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecretsManagerException

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. 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:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

This is a convenience which creates an instance of the GetRandomPasswordRequest.Builder avoiding the need to create one manually via GetRandomPasswordRequest.builder()

Parameters:

getRandomPasswordRequest - A Consumer that will call methods on GetRandomPasswordRequest.Builder to create a request.

Returns:

Result of the GetRandomPassword operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getRandomPassword

default GetRandomPasswordResponse getRandomPassword()
                                             throws InvalidParameterException,
                                                    InvalidRequestException,
                                                    InternalServiceErrorException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecretsManagerException

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. 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:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Returns:

Result of the GetRandomPassword operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

getRandomPassword(GetRandomPasswordRequest), AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
                                             throws ResourceNotFoundException,
                                                    InternalServiceErrorException,
                                                    InvalidRequestException,
                                                    InvalidParameterException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecretsManagerException

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.

Parameters:

getResourcePolicyRequest -

Returns:

Result of the GetResourcePolicy operation returned by the service.

Throws:

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

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
                                             throws ResourceNotFoundException,
                                                    InternalServiceErrorException,
                                                    InvalidRequestException,
                                                    InvalidParameterException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecretsManagerException

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.

This is a convenience which creates an instance of the GetResourcePolicyRequest.Builder avoiding the need to create one manually via GetResourcePolicyRequest.builder()

Parameters:

getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request.

Returns:

Result of the GetResourcePolicy operation returned by the service.

Throws:

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

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getSecretValue

default GetSecretValueResponse getSecretValue(GetSecretValueRequest getSecretValueRequest)
                                       throws ResourceNotFoundException,
                                              InvalidParameterException,
                                              InvalidRequestException,
                                              DecryptionFailureException,
                                              InternalServiceErrorException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SecretsManagerException

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.

Parameters:

getSecretValueRequest -

Returns:

Result of the GetSecretValue operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getSecretValue

default GetSecretValueResponse getSecretValue(Consumer<GetSecretValueRequest.Builder> getSecretValueRequest)
                                       throws ResourceNotFoundException,
                                              InvalidParameterException,
                                              InvalidRequestException,
                                              DecryptionFailureException,
                                              InternalServiceErrorException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SecretsManagerException

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.

This is a convenience which creates an instance of the GetSecretValueRequest.Builder avoiding the need to create one manually via GetSecretValueRequest.builder()

Parameters:

getSecretValueRequest - A Consumer that will call methods on GetSecretValueRequest.Builder to create a request.

Returns:

Result of the GetSecretValue operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecretVersionIds

default ListSecretVersionIdsResponse listSecretVersionIds(ListSecretVersionIdsRequest listSecretVersionIdsRequest)
                                                   throws InvalidNextTokenException,
                                                          ResourceNotFoundException,
                                                          InternalServiceErrorException,
                                                          InvalidParameterException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          SecretsManagerException

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.

Parameters:

listSecretVersionIdsRequest -

Returns:

Result of the ListSecretVersionIds operation returned by the service.

Throws:

InvalidNextTokenException - The NextToken value is invalid.

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

InternalServiceErrorException - An error occurred on the server side.

InvalidParameterException - The parameter name or value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecretVersionIds

default ListSecretVersionIdsResponse listSecretVersionIds(Consumer<ListSecretVersionIdsRequest.Builder> listSecretVersionIdsRequest)
                                                   throws InvalidNextTokenException,
                                                          ResourceNotFoundException,
                                                          InternalServiceErrorException,
                                                          InvalidParameterException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          SecretsManagerException

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.

This is a convenience which creates an instance of the ListSecretVersionIdsRequest.Builder avoiding the need to create one manually via ListSecretVersionIdsRequest.builder()

Parameters:

listSecretVersionIdsRequest - A Consumer that will call methods on ListSecretVersionIdsRequest.Builder to create a request.

Returns:

Result of the ListSecretVersionIds operation returned by the service.

Throws:

InvalidNextTokenException - The NextToken value is invalid.

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

InternalServiceErrorException - An error occurred on the server side.

InvalidParameterException - The parameter name or value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecretVersionIdsPaginator

default ListSecretVersionIdsIterable listSecretVersionIdsPaginator(ListSecretVersionIdsRequest listSecretVersionIdsRequest)
                                                            throws InvalidNextTokenException,
                                                                   ResourceNotFoundException,
                                                                   InternalServiceErrorException,
                                                                   InvalidParameterException,
                                                                   AwsServiceException,
                                                                   SdkClientException,
                                                                   SecretsManagerException

This is a variant of listSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsIterable responses = client.listSecretVersionIdsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsIterable responses = client
             .listSecretVersionIdsPaginator(request);
     for (software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsIterable responses = client.listSecretVersionIdsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest) operation.

Parameters:

listSecretVersionIdsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidNextTokenException - The NextToken value is invalid.

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

InternalServiceErrorException - An error occurred on the server side.

InvalidParameterException - The parameter name or value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecretVersionIdsPaginator

default ListSecretVersionIdsIterable listSecretVersionIdsPaginator(Consumer<ListSecretVersionIdsRequest.Builder> listSecretVersionIdsRequest)
                                                            throws InvalidNextTokenException,
                                                                   ResourceNotFoundException,
                                                                   InternalServiceErrorException,
                                                                   InvalidParameterException,
                                                                   AwsServiceException,
                                                                   SdkClientException,
                                                                   SecretsManagerException

This is a variant of listSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsIterable responses = client.listSecretVersionIdsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsIterable responses = client
             .listSecretVersionIdsPaginator(request);
     for (software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsIterable responses = client.listSecretVersionIdsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest) operation.

This is a convenience which creates an instance of the ListSecretVersionIdsRequest.Builder avoiding the need to create one manually via ListSecretVersionIdsRequest.builder()

Parameters:

listSecretVersionIdsRequest - A Consumer that will call methods on ListSecretVersionIdsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

InvalidNextTokenException - The NextToken value is invalid.

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

InternalServiceErrorException - An error occurred on the server side.

InvalidParameterException - The parameter name or value is invalid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecrets

default ListSecretsResponse listSecrets(ListSecretsRequest listSecretsRequest)
                                 throws InvalidParameterException,
                                        InvalidRequestException,
                                        InvalidNextTokenException,
                                        InternalServiceErrorException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SecretsManagerException

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

Parameters:

listSecretsRequest -

Returns:

Result of the ListSecrets operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecrets

default ListSecretsResponse listSecrets(Consumer<ListSecretsRequest.Builder> listSecretsRequest)
                                 throws InvalidParameterException,
                                        InvalidRequestException,
                                        InvalidNextTokenException,
                                        InternalServiceErrorException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SecretsManagerException

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

This is a convenience which creates an instance of the ListSecretsRequest.Builder avoiding the need to create one manually via ListSecretsRequest.builder()

Parameters:

listSecretsRequest - A Consumer that will call methods on ListSecretsRequest.Builder to create a request.

Returns:

Result of the ListSecrets operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecrets

default ListSecretsResponse listSecrets()
                                 throws InvalidParameterException,
                                        InvalidRequestException,
                                        InvalidNextTokenException,
                                        InternalServiceErrorException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SecretsManagerException

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

Returns:

Result of the ListSecrets operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

listSecrets(ListSecretsRequest), AWS API Documentation

listSecretsPaginator

default ListSecretsIterable listSecretsPaginator()
                                          throws InvalidParameterException,
                                                 InvalidRequestException,
                                                 InvalidNextTokenException,
                                                 InternalServiceErrorException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 SecretsManagerException

This is a variant of listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsIterable responses = client.listSecretsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsIterable responses = client
             .listSecretsPaginator(request);
     for (software.amazon.awssdk.services.secretsmanager.model.ListSecretsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsIterable responses = client.listSecretsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

listSecretsPaginator(ListSecretsRequest), AWS API Documentation

listSecretsPaginator

default ListSecretsIterable listSecretsPaginator(ListSecretsRequest listSecretsRequest)
                                          throws InvalidParameterException,
                                                 InvalidRequestException,
                                                 InvalidNextTokenException,
                                                 InternalServiceErrorException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 SecretsManagerException

This is a variant of listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsIterable responses = client.listSecretsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsIterable responses = client
             .listSecretsPaginator(request);
     for (software.amazon.awssdk.services.secretsmanager.model.ListSecretsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsIterable responses = client.listSecretsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest) operation.

Parameters:

listSecretsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSecretsPaginator

default ListSecretsIterable listSecretsPaginator(Consumer<ListSecretsRequest.Builder> listSecretsRequest)
                                          throws InvalidParameterException,
                                                 InvalidRequestException,
                                                 InvalidNextTokenException,
                                                 InternalServiceErrorException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 SecretsManagerException

This is a variant of listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsIterable responses = client.listSecretsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsIterable responses = client
             .listSecretsPaginator(request);
     for (software.amazon.awssdk.services.secretsmanager.model.ListSecretsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsIterable responses = client.listSecretsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest) operation.

This is a convenience which creates an instance of the ListSecretsRequest.Builder avoiding the need to create one manually via ListSecretsRequest.builder()

Parameters:

listSecretsRequest - A Consumer that will call methods on ListSecretsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
                                             throws MalformedPolicyDocumentException,
                                                    ResourceNotFoundException,
                                                    InvalidParameterException,
                                                    InternalServiceErrorException,
                                                    InvalidRequestException,
                                                    PublicPolicyException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecretsManagerException

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.

Parameters:

putResourcePolicyRequest -

Returns:

Result of the PutResourcePolicy operation returned by the service.

Throws:

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.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
                                             throws MalformedPolicyDocumentException,
                                                    ResourceNotFoundException,
                                                    InvalidParameterException,
                                                    InternalServiceErrorException,
                                                    InvalidRequestException,
                                                    PublicPolicyException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecretsManagerException

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.

This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need to create one manually via PutResourcePolicyRequest.builder()

Parameters:

putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.

Returns:

Result of the PutResourcePolicy operation returned by the service.

Throws:

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.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putSecretValue

default PutSecretValueResponse putSecretValue(PutSecretValueRequest putSecretValueRequest)
                                       throws InvalidParameterException,
                                              InvalidRequestException,
                                              LimitExceededException,
                                              EncryptionFailureException,
                                              ResourceExistsException,
                                              ResourceNotFoundException,
                                              InternalServiceErrorException,
                                              DecryptionFailureException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SecretsManagerException

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 or SecretString 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.

Parameters:

putSecretValueRequest -

Returns:

Result of the PutSecretValue operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putSecretValue

default PutSecretValueResponse putSecretValue(Consumer<PutSecretValueRequest.Builder> putSecretValueRequest)
                                       throws InvalidParameterException,
                                              InvalidRequestException,
                                              LimitExceededException,
                                              EncryptionFailureException,
                                              ResourceExistsException,
                                              ResourceNotFoundException,
                                              InternalServiceErrorException,
                                              DecryptionFailureException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SecretsManagerException

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 or SecretString 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.

This is a convenience which creates an instance of the PutSecretValueRequest.Builder avoiding the need to create one manually via PutSecretValueRequest.builder()

Parameters:

putSecretValueRequest - A Consumer that will call methods on PutSecretValueRequest.Builder to create a request.

Returns:

Result of the PutSecretValue operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

removeRegionsFromReplication

default RemoveRegionsFromReplicationResponse removeRegionsFromReplication(RemoveRegionsFromReplicationRequest removeRegionsFromReplicationRequest)
                                                                   throws ResourceNotFoundException,
                                                                          InvalidRequestException,
                                                                          InvalidParameterException,
                                                                          InternalServiceErrorException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          SecretsManagerException

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.

Parameters:

removeRegionsFromReplicationRequest -

Returns:

Result of the RemoveRegionsFromReplication operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

removeRegionsFromReplication

default RemoveRegionsFromReplicationResponse removeRegionsFromReplication(Consumer<RemoveRegionsFromReplicationRequest.Builder> removeRegionsFromReplicationRequest)
                                                                   throws ResourceNotFoundException,
                                                                          InvalidRequestException,
                                                                          InvalidParameterException,
                                                                          InternalServiceErrorException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          SecretsManagerException

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.

This is a convenience which creates an instance of the RemoveRegionsFromReplicationRequest.Builder avoiding the need to create one manually via RemoveRegionsFromReplicationRequest.builder()

Parameters:

removeRegionsFromReplicationRequest - A Consumer that will call methods on RemoveRegionsFromReplicationRequest.Builder to create a request.

Returns:

Result of the RemoveRegionsFromReplication operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

replicateSecretToRegions

default ReplicateSecretToRegionsResponse replicateSecretToRegions(ReplicateSecretToRegionsRequest replicateSecretToRegionsRequest)
                                                           throws ResourceNotFoundException,
                                                                  InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  InternalServiceErrorException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  SecretsManagerException

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.

Parameters:

replicateSecretToRegionsRequest -

Returns:

Result of the ReplicateSecretToRegions operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

replicateSecretToRegions

default ReplicateSecretToRegionsResponse replicateSecretToRegions(Consumer<ReplicateSecretToRegionsRequest.Builder> replicateSecretToRegionsRequest)
                                                           throws ResourceNotFoundException,
                                                                  InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  InternalServiceErrorException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  SecretsManagerException

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.

This is a convenience which creates an instance of the ReplicateSecretToRegionsRequest.Builder avoiding the need to create one manually via ReplicateSecretToRegionsRequest.builder()

Parameters:

replicateSecretToRegionsRequest - A Consumer that will call methods on ReplicateSecretToRegionsRequest.Builder to create a request.

Returns:

Result of the ReplicateSecretToRegions operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

restoreSecret

default RestoreSecretResponse restoreSecret(RestoreSecretRequest restoreSecretRequest)
                                     throws ResourceNotFoundException,
                                            InvalidParameterException,
                                            InvalidRequestException,
                                            InternalServiceErrorException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecretsManagerException

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.

Parameters:

restoreSecretRequest -

Returns:

Result of the RestoreSecret operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

restoreSecret

default RestoreSecretResponse restoreSecret(Consumer<RestoreSecretRequest.Builder> restoreSecretRequest)
                                     throws ResourceNotFoundException,
                                            InvalidParameterException,
                                            InvalidRequestException,
                                            InternalServiceErrorException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecretsManagerException

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.

This is a convenience which creates an instance of the RestoreSecretRequest.Builder avoiding the need to create one manually via RestoreSecretRequest.builder()

Parameters:

restoreSecretRequest - A Consumer that will call methods on RestoreSecretRequest.Builder to create a request.

Returns:

Result of the RestoreSecret operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

rotateSecret

default RotateSecretResponse rotateSecret(RotateSecretRequest rotateSecretRequest)
                                   throws ResourceNotFoundException,
                                          InvalidParameterException,
                                          InternalServiceErrorException,
                                          InvalidRequestException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecretsManagerException

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.

Parameters:

rotateSecretRequest -

Returns:

Result of the RotateSecret operation returned by the service.

Throws:

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

InvalidParameterException - The parameter name or value is invalid.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

rotateSecret

default RotateSecretResponse rotateSecret(Consumer<RotateSecretRequest.Builder> rotateSecretRequest)
                                   throws ResourceNotFoundException,
                                          InvalidParameterException,
                                          InternalServiceErrorException,
                                          InvalidRequestException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecretsManagerException

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.

This is a convenience which creates an instance of the RotateSecretRequest.Builder avoiding the need to create one manually via RotateSecretRequest.builder()

Parameters:

rotateSecretRequest - A Consumer that will call methods on RotateSecretRequest.Builder to create a request.

Returns:

Result of the RotateSecret operation returned by the service.

Throws:

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

InvalidParameterException - The parameter name or value is invalid.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopReplicationToReplica

default StopReplicationToReplicaResponse stopReplicationToReplica(StopReplicationToReplicaRequest stopReplicationToReplicaRequest)
                                                           throws ResourceNotFoundException,
                                                                  InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  InternalServiceErrorException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  SecretsManagerException

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.

Parameters:

stopReplicationToReplicaRequest -

Returns:

Result of the StopReplicationToReplica operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopReplicationToReplica

default StopReplicationToReplicaResponse stopReplicationToReplica(Consumer<StopReplicationToReplicaRequest.Builder> stopReplicationToReplicaRequest)
                                                           throws ResourceNotFoundException,
                                                                  InvalidRequestException,
                                                                  InvalidParameterException,
                                                                  InternalServiceErrorException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  SecretsManagerException

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.

This is a convenience which creates an instance of the StopReplicationToReplicaRequest.Builder avoiding the need to create one manually via StopReplicationToReplicaRequest.builder()

Parameters:

stopReplicationToReplicaRequest - A Consumer that will call methods on StopReplicationToReplicaRequest.Builder to create a request.

Returns:

Result of the StopReplicationToReplica operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        InvalidRequestException,
                                        InvalidParameterException,
                                        InternalServiceErrorException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SecretsManagerException

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.

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.

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        InvalidRequestException,
                                        InvalidParameterException,
                                        InternalServiceErrorException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SecretsManagerException

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.

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.

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.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            InvalidRequestException,
                                            InvalidParameterException,
                                            InternalServiceErrorException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecretsManagerException

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.

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.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            InvalidRequestException,
                                            InvalidParameterException,
                                            InternalServiceErrorException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecretsManagerException

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.

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.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateSecret

default UpdateSecretResponse updateSecret(UpdateSecretRequest updateSecretRequest)
                                   throws InvalidParameterException,
                                          InvalidRequestException,
                                          LimitExceededException,
                                          EncryptionFailureException,
                                          ResourceExistsException,
                                          ResourceNotFoundException,
                                          MalformedPolicyDocumentException,
                                          InternalServiceErrorException,
                                          PreconditionNotMetException,
                                          DecryptionFailureException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecretsManagerException

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.

Parameters:

updateSecretRequest -

Returns:

Result of the UpdateSecret operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

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

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateSecret

default UpdateSecretResponse updateSecret(Consumer<UpdateSecretRequest.Builder> updateSecretRequest)
                                   throws InvalidParameterException,
                                          InvalidRequestException,
                                          LimitExceededException,
                                          EncryptionFailureException,
                                          ResourceExistsException,
                                          ResourceNotFoundException,
                                          MalformedPolicyDocumentException,
                                          InternalServiceErrorException,
                                          PreconditionNotMetException,
                                          DecryptionFailureException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecretsManagerException

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.

This is a convenience which creates an instance of the UpdateSecretRequest.Builder avoiding the need to create one manually via UpdateSecretRequest.builder()

Parameters:

updateSecretRequest - A Consumer that will call methods on UpdateSecretRequest.Builder to create a request.

Returns:

Result of the UpdateSecret operation returned by the service.

Throws:

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.

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

InternalServiceErrorException - An error occurred on the server side.

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

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateSecretVersionStage

default UpdateSecretVersionStageResponse updateSecretVersionStage(UpdateSecretVersionStageRequest updateSecretVersionStageRequest)
                                                           throws ResourceNotFoundException,
                                                                  InvalidParameterException,
                                                                  InvalidRequestException,
                                                                  LimitExceededException,
                                                                  InternalServiceErrorException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  SecretsManagerException

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.

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.

Parameters:

updateSecretVersionStageRequest -

Returns:

Result of the UpdateSecretVersionStage operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateSecretVersionStage

default UpdateSecretVersionStageResponse updateSecretVersionStage(Consumer<UpdateSecretVersionStageRequest.Builder> updateSecretVersionStageRequest)
                                                           throws ResourceNotFoundException,
                                                                  InvalidParameterException,
                                                                  InvalidRequestException,
                                                                  LimitExceededException,
                                                                  InternalServiceErrorException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  SecretsManagerException

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.

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.

This is a convenience which creates an instance of the UpdateSecretVersionStageRequest.Builder avoiding the need to create one manually via UpdateSecretVersionStageRequest.builder()

Parameters:

updateSecretVersionStageRequest - A Consumer that will call methods on UpdateSecretVersionStageRequest.Builder to create a request.

Returns:

Result of the UpdateSecretVersionStage operation returned by the service.

Throws:

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.

InternalServiceErrorException - An error occurred on the server side.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

validateResourcePolicy

default ValidateResourcePolicyResponse validateResourcePolicy(ValidateResourcePolicyRequest validateResourcePolicyRequest)
                                                       throws MalformedPolicyDocumentException,
                                                              ResourceNotFoundException,
                                                              InvalidParameterException,
                                                              InternalServiceErrorException,
                                                              InvalidRequestException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              SecretsManagerException

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.

Parameters:

validateResourcePolicyRequest -

Returns:

Result of the ValidateResourcePolicy operation returned by the service.

Throws:

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.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

validateResourcePolicy

default ValidateResourcePolicyResponse validateResourcePolicy(Consumer<ValidateResourcePolicyRequest.Builder> validateResourcePolicyRequest)
                                                       throws MalformedPolicyDocumentException,
                                                              ResourceNotFoundException,
                                                              InvalidParameterException,
                                                              InternalServiceErrorException,
                                                              InvalidRequestException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              SecretsManagerException

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.

This is a convenience which creates an instance of the ValidateResourcePolicyRequest.Builder avoiding the need to create one manually via ValidateResourcePolicyRequest.builder()

Parameters:

validateResourcePolicyRequest - A Consumer that will call methods on ValidateResourcePolicyRequest.Builder to create a request.

Returns:

Result of the ValidateResourcePolicy operation returned by the service.

Throws:

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.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SecretsManagerException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static SecretsManagerClient create()

Create a SecretsManagerClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SecretsManagerClientBuilder builder()

Create a builder that can be used to configure and create a SecretsManagerClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SecretsManagerServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient