Interface SecretsManagerAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchGetSecretValue
(Consumer<BatchGetSecretValueRequest.Builder> batchGetSecretValueRequest) Retrieves the contents of the encrypted fieldsSecretString
orSecretBinary
for up to 20 secrets.batchGetSecretValue
(BatchGetSecretValueRequest batchGetSecretValueRequest) Retrieves the contents of the encrypted fieldsSecretString
orSecretBinary
for up to 20 secrets.default BatchGetSecretValuePublisher
batchGetSecretValuePaginator
(Consumer<BatchGetSecretValueRequest.Builder> batchGetSecretValueRequest) This is a variant ofbatchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest)
operation.default BatchGetSecretValuePublisher
batchGetSecretValuePaginator
(BatchGetSecretValueRequest batchGetSecretValueRequest) This is a variant ofbatchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest)
operation.builder()
Create a builder that can be used to configure and create aSecretsManagerAsyncClient
.cancelRotateSecret
(Consumer<CancelRotateSecretRequest.Builder> cancelRotateSecretRequest) Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.cancelRotateSecret
(CancelRotateSecretRequest cancelRotateSecretRequest) Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.static SecretsManagerAsyncClient
create()
Create aSecretsManagerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateSecretResponse> createSecret
(Consumer<CreateSecretRequest.Builder> createSecretRequest) Creates a new secret.default CompletableFuture
<CreateSecretResponse> createSecret
(CreateSecretRequest createSecretRequest) Creates a new secret.deleteResourcePolicy
(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes the resource-based permission policy attached to the secret.deleteResourcePolicy
(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes the resource-based permission policy attached to the secret.default CompletableFuture
<DeleteSecretResponse> deleteSecret
(Consumer<DeleteSecretRequest.Builder> deleteSecretRequest) Deletes a secret and all of its versions.default CompletableFuture
<DeleteSecretResponse> deleteSecret
(DeleteSecretRequest deleteSecretRequest) Deletes a secret and all of its versions.default CompletableFuture
<DescribeSecretResponse> describeSecret
(Consumer<DescribeSecretRequest.Builder> describeSecretRequest) Retrieves the details of a secret.default CompletableFuture
<DescribeSecretResponse> describeSecret
(DescribeSecretRequest describeSecretRequest) Retrieves the details of a secret.Generates a random password.getRandomPassword
(Consumer<GetRandomPasswordRequest.Builder> getRandomPasswordRequest) Generates a random password.getRandomPassword
(GetRandomPasswordRequest getRandomPasswordRequest) Generates a random password.getResourcePolicy
(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Retrieves the JSON text of the resource-based policy document attached to the secret.getResourcePolicy
(GetResourcePolicyRequest getResourcePolicyRequest) Retrieves the JSON text of the resource-based policy document attached to the secret.default CompletableFuture
<GetSecretValueResponse> getSecretValue
(Consumer<GetSecretValueRequest.Builder> getSecretValueRequest) Retrieves the contents of the encrypted fieldsSecretString
orSecretBinary
from the specified version of a secret, whichever contains content.default CompletableFuture
<GetSecretValueResponse> getSecretValue
(GetSecretValueRequest getSecretValueRequest) Retrieves the contents of the encrypted fieldsSecretString
orSecretBinary
from the specified version of a secret, whichever contains content.default CompletableFuture
<ListSecretsResponse> Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion.default CompletableFuture
<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 CompletableFuture
<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 ListSecretsPublisher
This is a variant oflistSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest)
operation.default ListSecretsPublisher
listSecretsPaginator
(Consumer<ListSecretsRequest.Builder> listSecretsRequest) This is a variant oflistSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest)
operation.default ListSecretsPublisher
listSecretsPaginator
(ListSecretsRequest listSecretsRequest) This is a variant oflistSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest)
operation.listSecretVersionIds
(Consumer<ListSecretVersionIdsRequest.Builder> listSecretVersionIdsRequest) Lists the versions of a secret.listSecretVersionIds
(ListSecretVersionIdsRequest listSecretVersionIdsRequest) Lists the versions of a secret.default ListSecretVersionIdsPublisher
listSecretVersionIdsPaginator
(Consumer<ListSecretVersionIdsRequest.Builder> listSecretVersionIdsRequest) This is a variant oflistSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest)
operation.default ListSecretVersionIdsPublisher
listSecretVersionIdsPaginator
(ListSecretVersionIdsRequest listSecretVersionIdsRequest) This is a variant oflistSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest)
operation.putResourcePolicy
(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Attaches a resource-based permission policy to a secret.putResourcePolicy
(PutResourcePolicyRequest putResourcePolicyRequest) Attaches a resource-based permission policy to a secret.default CompletableFuture
<PutSecretValueResponse> putSecretValue
(Consumer<PutSecretValueRequest.Builder> putSecretValueRequest) Creates a new version with a new encrypted secret value and attaches it to the secret.default CompletableFuture
<PutSecretValueResponse> putSecretValue
(PutSecretValueRequest putSecretValueRequest) Creates a new version with a new encrypted secret value and attaches it to the secret.removeRegionsFromReplication
(Consumer<RemoveRegionsFromReplicationRequest.Builder> removeRegionsFromReplicationRequest) For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.removeRegionsFromReplication
(RemoveRegionsFromReplicationRequest removeRegionsFromReplicationRequest) For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.replicateSecretToRegions
(Consumer<ReplicateSecretToRegionsRequest.Builder> replicateSecretToRegionsRequest) Replicates the secret to a new Regions.replicateSecretToRegions
(ReplicateSecretToRegionsRequest replicateSecretToRegionsRequest) Replicates the secret to a new Regions.default CompletableFuture
<RestoreSecretResponse> restoreSecret
(Consumer<RestoreSecretRequest.Builder> restoreSecretRequest) Cancels the scheduled deletion of a secret by removing theDeletedDate
time stamp.default CompletableFuture
<RestoreSecretResponse> restoreSecret
(RestoreSecretRequest restoreSecretRequest) Cancels the scheduled deletion of a secret by removing theDeletedDate
time stamp.default CompletableFuture
<RotateSecretResponse> rotateSecret
(Consumer<RotateSecretRequest.Builder> rotateSecretRequest) Configures and starts the asynchronous process of rotating the secret.default CompletableFuture
<RotateSecretResponse> rotateSecret
(RotateSecretRequest rotateSecretRequest) Configures and starts the asynchronous process of rotating the secret.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstopReplicationToReplica
(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.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 CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attaches tags to a secret.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Attaches tags to a secret.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes specific tags from a secret.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes specific tags from a secret.default CompletableFuture
<UpdateSecretResponse> updateSecret
(Consumer<UpdateSecretRequest.Builder> updateSecretRequest) Modifies the details of a secret, including metadata and the secret value.default CompletableFuture
<UpdateSecretResponse> updateSecret
(UpdateSecretRequest updateSecretRequest) Modifies the details of a secret, including metadata and the secret value.updateSecretVersionStage
(Consumer<UpdateSecretVersionStageRequest.Builder> updateSecretVersionStageRequest) Modifies the staging labels attached to a version of a secret.updateSecretVersionStage
(UpdateSecretVersionStageRequest updateSecretVersionStageRequest) Modifies the staging labels attached to a version of a secret.validateResourcePolicy
(Consumer<ValidateResourcePolicyRequest.Builder> validateResourcePolicyRequest) Validates that a resource policy does not grant a wide range of principals access to your secret.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 Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchGetSecretValue
default CompletableFuture<BatchGetSecretValueResponse> batchGetSecretValue(BatchGetSecretValueRequest batchGetSecretValueRequest) Retrieves the contents of the encrypted fields
SecretString
orSecretBinary
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 inErrors
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 havesecretsmanager:GetSecretValue
for each secret. If you use filters, you must also havesecretsmanager:ListSecrets
. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed keyaws/secretsmanager
, then you also needkms: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:
- A Java Future containing the result of the BatchGetSecretValue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchGetSecretValue
default CompletableFuture<BatchGetSecretValueResponse> batchGetSecretValue(Consumer<BatchGetSecretValueRequest.Builder> batchGetSecretValueRequest) Retrieves the contents of the encrypted fields
SecretString
orSecretBinary
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 inErrors
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 havesecretsmanager:GetSecretValue
for each secret. If you use filters, you must also havesecretsmanager:ListSecrets
. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed keyaws/secretsmanager
, then you also needkms: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 viaBatchGetSecretValueRequest.builder()
- Parameters:
batchGetSecretValueRequest
- AConsumer
that will call methods onBatchGetSecretValueRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetSecretValue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchGetSecretValuePaginator
default BatchGetSecretValuePublisher batchGetSecretValuePaginator(BatchGetSecretValueRequest batchGetSecretValueRequest) This is a variant of
batchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValuePublisher publisher = client.batchGetSecretValuePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValuePublisher publisher = client.batchGetSecretValuePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchGetSecretValuePaginator
default BatchGetSecretValuePublisher batchGetSecretValuePaginator(Consumer<BatchGetSecretValueRequest.Builder> batchGetSecretValueRequest) This is a variant of
batchGetSecretValue(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValuePublisher publisher = client.batchGetSecretValuePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.secretsmanager.paginators.BatchGetSecretValuePublisher publisher = client.batchGetSecretValuePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueResponse response) { //... }; });
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 viaBatchGetSecretValueRequest.builder()
- Parameters:
batchGetSecretValueRequest
- AConsumer
that will call methods onBatchGetSecretValueRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
cancelRotateSecret
default CompletableFuture<CancelRotateSecretResponse> cancelRotateSecret(CancelRotateSecretRequest cancelRotateSecretRequest) 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 labelAWSPENDING
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 labelAWSCURRENT
to the version that hasAWSPENDING
. 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:
- A Java Future containing the result of the CancelRotateSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
cancelRotateSecret
default CompletableFuture<CancelRotateSecretResponse> cancelRotateSecret(Consumer<CancelRotateSecretRequest.Builder> cancelRotateSecretRequest) 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 labelAWSPENDING
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 labelAWSCURRENT
to the version that hasAWSPENDING
. 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 viaCancelRotateSecretRequest.builder()
- Parameters:
cancelRotateSecretRequest
- AConsumer
that will call methods onCancelRotateSecretRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelRotateSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSecret
default CompletableFuture<CreateSecretResponse> createSecret(CreateSecretRequest createSecretRequest) 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 theSecretBinary
parameter, but not both. If you includeSecretString
orSecretBinary
then Secrets Manager creates an initial secret version and automatically attaches the staging labelAWSCURRENT
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 useaws/secretsmanager
. Creatingaws/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
orSecretString
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 needsecretsmanager: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 needkms:GenerateDataKey
andkms:Decrypt
permission to the key.- Parameters:
createSecretRequest
-- Returns:
- A Java Future containing the result of the CreateSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSecret
default CompletableFuture<CreateSecretResponse> createSecret(Consumer<CreateSecretRequest.Builder> createSecretRequest) 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 theSecretBinary
parameter, but not both. If you includeSecretString
orSecretBinary
then Secrets Manager creates an initial secret version and automatically attaches the staging labelAWSCURRENT
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 useaws/secretsmanager
. Creatingaws/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
orSecretString
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 needsecretsmanager: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 needkms:GenerateDataKey
andkms:Decrypt
permission to the key.
This is a convenience which creates an instance of the
CreateSecretRequest.Builder
avoiding the need to create one manually viaCreateSecretRequest.builder()
- Parameters:
createSecretRequest
- AConsumer
that will call methods onCreateSecretRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) 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:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) 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 viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSecret
default CompletableFuture<DeleteSecretResponse> deleteSecret(DeleteSecretRequest deleteSecretRequest) 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:
- A Java Future containing the result of the DeleteSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSecret
default CompletableFuture<DeleteSecretResponse> deleteSecret(Consumer<DeleteSecretRequest.Builder> deleteSecretRequest) 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 viaDeleteSecretRequest.builder()
- Parameters:
deleteSecretRequest
- AConsumer
that will call methods onDeleteSecretRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeSecret
default CompletableFuture<DescribeSecretResponse> describeSecret(DescribeSecretRequest describeSecretRequest) 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:
- A Java Future containing the result of the DescribeSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeSecret
default CompletableFuture<DescribeSecretResponse> describeSecret(Consumer<DescribeSecretRequest.Builder> describeSecretRequest) 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 viaDescribeSecretRequest.builder()
- Parameters:
describeSecretRequest
- AConsumer
that will call methods onDescribeSecretRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRandomPassword
default CompletableFuture<GetRandomPasswordResponse> getRandomPassword(GetRandomPasswordRequest getRandomPasswordRequest) 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:
!\"#invalid input: '$'%&'()*+,-./:;<=>?@[\\]^_`{|}~
Secrets Manager generates a CloudTrail log entry when you call this action.
Required permissions:
secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.- Parameters:
getRandomPasswordRequest
-- Returns:
- A Java Future containing the result of the GetRandomPassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRandomPassword
default CompletableFuture<GetRandomPasswordResponse> getRandomPassword(Consumer<GetRandomPasswordRequest.Builder> getRandomPasswordRequest) 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:
!\"#invalid input: '$'%&'()*+,-./:;<=>?@[\\]^_`{|}~
Secrets Manager generates a CloudTrail log entry when you call this action.
Required permissions:
secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
This is a convenience which creates an instance of the
GetRandomPasswordRequest.Builder
avoiding the need to create one manually viaGetRandomPasswordRequest.builder()
- Parameters:
getRandomPasswordRequest
- AConsumer
that will call methods onGetRandomPasswordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRandomPassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRandomPassword
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:
!\"#invalid input: '$'%&'()*+,-./:;<=>?@[\\]^_`{|}~
Secrets Manager generates a CloudTrail log entry when you call this action.
Required permissions:
secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.- Returns:
- A Java Future containing the result of the GetRandomPassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) 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:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) 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 viaGetResourcePolicyRequest.builder()
- Parameters:
getResourcePolicyRequest
- AConsumer
that will call methods onGetResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSecretValue
default CompletableFuture<GetSecretValueResponse> getSecretValue(GetSecretValueRequest getSecretValueRequest) Retrieves the contents of the encrypted fields
SecretString
orSecretBinary
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 keyaws/secretsmanager
, then you also needkms: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:
- A Java Future containing the result of the GetSecretValue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSecretValue
default CompletableFuture<GetSecretValueResponse> getSecretValue(Consumer<GetSecretValueRequest.Builder> getSecretValueRequest) Retrieves the contents of the encrypted fields
SecretString
orSecretBinary
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 keyaws/secretsmanager
, then you also needkms: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 viaGetSecretValueRequest.builder()
- Parameters:
getSecretValueRequest
- AConsumer
that will call methods onGetSecretValueRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSecretValue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSecretVersionIds
default CompletableFuture<ListSecretVersionIdsResponse> listSecretVersionIds(ListSecretVersionIdsRequest listSecretVersionIdsRequest) 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:
- A Java Future containing the result of the ListSecretVersionIds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidNextTokenException The
- See Also:
-
listSecretVersionIds
default CompletableFuture<ListSecretVersionIdsResponse> listSecretVersionIds(Consumer<ListSecretVersionIdsRequest.Builder> listSecretVersionIdsRequest) 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 viaListSecretVersionIdsRequest.builder()
- Parameters:
listSecretVersionIdsRequest
- AConsumer
that will call methods onListSecretVersionIdsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSecretVersionIds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidNextTokenException The
- See Also:
-
listSecretVersionIdsPaginator
default ListSecretVersionIdsPublisher listSecretVersionIdsPaginator(ListSecretVersionIdsRequest listSecretVersionIdsRequest) This is a variant of
listSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsPublisher publisher = client.listSecretVersionIdsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsPublisher publisher = client.listSecretVersionIdsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidNextTokenException The
- See Also:
-
listSecretVersionIdsPaginator
default ListSecretVersionIdsPublisher listSecretVersionIdsPaginator(Consumer<ListSecretVersionIdsRequest.Builder> listSecretVersionIdsRequest) This is a variant of
listSecretVersionIds(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsPublisher publisher = client.listSecretVersionIdsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.secretsmanager.paginators.ListSecretVersionIdsPublisher publisher = client.listSecretVersionIdsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.secretsmanager.model.ListSecretVersionIdsResponse response) { //... }; });
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 viaListSecretVersionIdsRequest.builder()
- Parameters:
listSecretVersionIdsRequest
- AConsumer
that will call methods onListSecretVersionIdsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidNextTokenException The
- See Also:
-
listSecrets
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.
To list the versions of a secret, use ListSecretVersionIds.
To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions:
secretsmanager:ListSecrets
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.- Parameters:
listSecretsRequest
-- Returns:
- A Java Future containing the result of the ListSecrets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSecrets
default CompletableFuture<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. To see secrets marked for deletion, use the Secrets Manager console.
All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.
To list the versions of a secret, use ListSecretVersionIds.
To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions:
secretsmanager:ListSecrets
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
This is a convenience which creates an instance of the
ListSecretsRequest.Builder
avoiding the need to create one manually viaListSecretsRequest.builder()
- Parameters:
listSecretsRequest
- AConsumer
that will call methods onListSecretsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSecrets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSecrets
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.
To list the versions of a secret, use ListSecretVersionIds.
To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions:
secretsmanager:ListSecrets
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.- Returns:
- A Java Future containing the result of the ListSecrets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSecretsPaginator
This is a variant of
listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.secretsmanager.paginators.ListSecretsPublisher publisher = client.listSecretsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsPublisher publisher = client.listSecretsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.secretsmanager.model.ListSecretsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.secretsmanager.model.ListSecretsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSecretsPaginator
This is a variant of
listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.secretsmanager.paginators.ListSecretsPublisher publisher = client.listSecretsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsPublisher publisher = client.listSecretsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.secretsmanager.model.ListSecretsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.secretsmanager.model.ListSecretsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSecretsPaginator
default ListSecretsPublisher listSecretsPaginator(Consumer<ListSecretsRequest.Builder> listSecretsRequest) This is a variant of
listSecrets(software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.secretsmanager.paginators.ListSecretsPublisher publisher = client.listSecretsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.secretsmanager.paginators.ListSecretsPublisher publisher = client.listSecretsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.secretsmanager.model.ListSecretsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.secretsmanager.model.ListSecretsResponse response) { //... }; });
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 viaListSecretsRequest.builder()
- Parameters:
listSecretsRequest
- AConsumer
that will call methods onListSecretsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) 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:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) 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 viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putSecretValue
default CompletableFuture<PutSecretValueResponse> putSecretValue(PutSecretValueRequest putSecretValueRequest) 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 newSecretBinary
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 callPutSecretValue
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 includeVersionStages
, then Secrets Manager automatically moves the staging labelAWSCURRENT
to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging labelAWSCURRENT
to it. If this operation moves the staging labelAWSCURRENT
from another version to this version, then Secrets Manager also automatically moves the staging labelAWSPREVIOUS
to the version thatAWSCURRENT
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
orSecretString
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:
- A Java Future containing the result of the PutSecretValue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putSecretValue
default CompletableFuture<PutSecretValueResponse> putSecretValue(Consumer<PutSecretValueRequest.Builder> putSecretValueRequest) 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 newSecretBinary
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 callPutSecretValue
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 includeVersionStages
, then Secrets Manager automatically moves the staging labelAWSCURRENT
to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging labelAWSCURRENT
to it. If this operation moves the staging labelAWSCURRENT
from another version to this version, then Secrets Manager also automatically moves the staging labelAWSPREVIOUS
to the version thatAWSCURRENT
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
orSecretString
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 viaPutSecretValueRequest.builder()
- Parameters:
putSecretValueRequest
- AConsumer
that will call methods onPutSecretValueRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutSecretValue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeRegionsFromReplication
default CompletableFuture<RemoveRegionsFromReplicationResponse> removeRegionsFromReplication(RemoveRegionsFromReplicationRequest removeRegionsFromReplicationRequest) 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:
- A Java Future containing the result of the RemoveRegionsFromReplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeRegionsFromReplication
default CompletableFuture<RemoveRegionsFromReplicationResponse> removeRegionsFromReplication(Consumer<RemoveRegionsFromReplicationRequest.Builder> removeRegionsFromReplicationRequest) 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 viaRemoveRegionsFromReplicationRequest.builder()
- Parameters:
removeRegionsFromReplicationRequest
- AConsumer
that will call methods onRemoveRegionsFromReplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveRegionsFromReplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
replicateSecretToRegions
default CompletableFuture<ReplicateSecretToRegionsResponse> replicateSecretToRegions(ReplicateSecretToRegionsRequest replicateSecretToRegionsRequest) 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 thanaws/secretsmanager
, you also needkms:Decrypt
permission to the key. To encrypt the replicated secret with a KMS key other thanaws/secretsmanager
, you needkms:GenerateDataKey
andkms: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:
- A Java Future containing the result of the ReplicateSecretToRegions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
replicateSecretToRegions
default CompletableFuture<ReplicateSecretToRegionsResponse> replicateSecretToRegions(Consumer<ReplicateSecretToRegionsRequest.Builder> replicateSecretToRegionsRequest) 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 thanaws/secretsmanager
, you also needkms:Decrypt
permission to the key. To encrypt the replicated secret with a KMS key other thanaws/secretsmanager
, you needkms:GenerateDataKey
andkms: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 viaReplicateSecretToRegionsRequest.builder()
- Parameters:
replicateSecretToRegionsRequest
- AConsumer
that will call methods onReplicateSecretToRegionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ReplicateSecretToRegions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
restoreSecret
default CompletableFuture<RestoreSecretResponse> restoreSecret(RestoreSecretRequest restoreSecretRequest) 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:
- A Java Future containing the result of the RestoreSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
restoreSecret
default CompletableFuture<RestoreSecretResponse> restoreSecret(Consumer<RestoreSecretRequest.Builder> restoreSecretRequest) 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 viaRestoreSecretRequest.builder()
- Parameters:
restoreSecretRequest
- AConsumer
that will call methods onRestoreSecretRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
rotateSecret
default CompletableFuture<RotateSecretResponse> rotateSecret(RotateSecretRequest rotateSecretRequest) 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 theAWSCURRENT
version, or it might not be attached to any version. If theAWSPENDING
staging label is present but not attached to the same version asAWSCURRENT
, then any later invocation ofRotateSecret
assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, theAWSPENDING
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 needlambda:InvokeFunction
permissions on the rotation function. For more information, see Permissions for rotation.- Parameters:
rotateSecretRequest
-- Returns:
- A Java Future containing the result of the RotateSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
rotateSecret
default CompletableFuture<RotateSecretResponse> rotateSecret(Consumer<RotateSecretRequest.Builder> rotateSecretRequest) 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 theAWSCURRENT
version, or it might not be attached to any version. If theAWSPENDING
staging label is present but not attached to the same version asAWSCURRENT
, then any later invocation ofRotateSecret
assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, theAWSPENDING
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 needlambda: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 viaRotateSecretRequest.builder()
- Parameters:
rotateSecretRequest
- AConsumer
that will call methods onRotateSecretRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RotateSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
stopReplicationToReplica
default CompletableFuture<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.
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:
- A Java Future containing the result of the StopReplicationToReplica operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
stopReplicationToReplica
default CompletableFuture<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.
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 viaStopReplicationToReplicaRequest.builder()
- Parameters:
stopReplicationToReplicaRequest
- AConsumer
that will call methods onStopReplicationToReplicaRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopReplicationToReplica operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagResource
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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) 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:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSecret
default CompletableFuture<UpdateSecretResponse> updateSecret(UpdateSecretRequest updateSecretRequest) 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 callUpdateSecret
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
orSecretBinary
to create a new secret version, Secrets Manager automatically moves the staging labelAWSCURRENT
to the new version. Then it attaches the labelAWSPREVIOUS
to the version thatAWSCURRENT
was removed from.If you call this operation with a
ClientRequestToken
that matches an existing version'sVersionId
, 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
orSecretString
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 havekms:GenerateDataKey
,kms:Encrypt
, andkms:Decrypt
permissions on the key. If you change the KMS key and you don't havekms: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:
- A Java Future containing the result of the UpdateSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSecret
default CompletableFuture<UpdateSecretResponse> updateSecret(Consumer<UpdateSecretRequest.Builder> updateSecretRequest) 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 callUpdateSecret
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
orSecretBinary
to create a new secret version, Secrets Manager automatically moves the staging labelAWSCURRENT
to the new version. Then it attaches the labelAWSPREVIOUS
to the version thatAWSCURRENT
was removed from.If you call this operation with a
ClientRequestToken
that matches an existing version'sVersionId
, 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
orSecretString
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 havekms:GenerateDataKey
,kms:Encrypt
, andkms:Decrypt
permissions on the key. If you change the KMS key and you don't havekms: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 viaUpdateSecretRequest.builder()
- Parameters:
updateSecretRequest
- AConsumer
that will call methods onUpdateSecretRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSecret operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSecretVersionStage
default CompletableFuture<UpdateSecretVersionStageResponse> updateSecretVersionStage(UpdateSecretVersionStageRequest updateSecretVersionStageRequest) 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 labelAWSPREVIOUS
to the version thatAWSCURRENT
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:
- A Java Future containing the result of the UpdateSecretVersionStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSecretVersionStage
default CompletableFuture<UpdateSecretVersionStageResponse> updateSecretVersionStage(Consumer<UpdateSecretVersionStageRequest.Builder> updateSecretVersionStageRequest) 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 labelAWSPREVIOUS
to the version thatAWSCURRENT
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 viaUpdateSecretVersionStageRequest.builder()
- Parameters:
updateSecretVersionStageRequest
- AConsumer
that will call methods onUpdateSecretVersionStageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSecretVersionStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
validateResourcePolicy
default CompletableFuture<ValidateResourcePolicyResponse> validateResourcePolicy(ValidateResourcePolicyRequest validateResourcePolicyRequest) 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
andsecretsmanager:PutResourcePolicy
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.- Parameters:
validateResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the ValidateResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
validateResourcePolicy
default CompletableFuture<ValidateResourcePolicyResponse> validateResourcePolicy(Consumer<ValidateResourcePolicyRequest.Builder> validateResourcePolicyRequest) 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
andsecretsmanager: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 viaValidateResourcePolicyRequest.builder()
- Parameters:
validateResourcePolicyRequest
- AConsumer
that will call methods onValidateResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ValidateResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSecretsManagerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSecretsManagerAsyncClient
.
-