/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the secretsmanager-2017-10-17.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.SecretsManager.Model; namespace Amazon.SecretsManager { /// /// Interface for accessing SecretsManager /// /// Amazon Web Services Secrets Manager /// /// Amazon Web Services Secrets Manager provides a service to enable you to store, manage, /// and retrieve, secrets. /// /// /// /// This guide provides descriptions of the Secrets Manager API. For more information /// about using this service, see the Amazon /// Web Services Secrets Manager User Guide. /// /// /// /// API Version /// /// /// /// This version of the Secrets Manager API Reference documents the Secrets Manager API /// version 2017-10-17. /// /// /// /// For a list of endpoints, see Amazon /// Web Services Secrets Manager endpoints. /// /// /// /// Support and Feedback for Amazon Web Services Secrets Manager /// /// /// /// We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, /// or post your feedback and questions in the Amazon /// Web Services Secrets Manager Discussion Forum. For more information about the /// Amazon Web Services Discussion Forums, see Forums /// Help. /// /// /// /// Logging API Requests /// /// /// /// Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service /// that records Amazon Web Services API calls for your Amazon Web Services account and /// delivers log files to an Amazon S3 bucket. By using information that's collected by /// Amazon Web Services CloudTrail, you can determine the requests successfully made to /// Secrets Manager, who made the request, when it was made, and so on. For more about /// Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, /// see Logging /// Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail /// in the Amazon Web Services Secrets Manager User Guide. To learn more about /// CloudTrail, including enabling it and find your log files, see the Amazon /// Web Services CloudTrail User Guide. /// /// public partial interface IAmazonSecretsManager : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ISecretsManagerPaginatorFactory Paginators { get; } #endif #region CancelRotateSecret /// /// Turns off automatic rotation, and if a rotation is currently in progress, cancels /// the rotation. /// /// /// /// If you cancel a rotation in progress, it can leave the VersionStage labels /// in an unexpected state. You might need to remove the staging label AWSPENDING /// from the partially created version. You also need to determine whether to roll back /// to the previous version of the secret by moving the staging label AWSCURRENT /// to the version that has AWSPENDING. To determine which version has a /// specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage /// to change staging labels. For more information, see How /// rotation works. /// /// /// /// To turn on automatic rotation again, call RotateSecret. /// /// /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters because it might be logged. For /// more information, see Logging /// Secrets Manager events with CloudTrail. /// /// /// /// Required permissions: secretsmanager:CancelRotateSecret. For /// more information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. /// /// /// Container for the necessary parameters to execute the CancelRotateSecret service method. /// /// The response from the CancelRotateSecret service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for CancelRotateSecret Operation CancelRotateSecretResponse CancelRotateSecret(CancelRotateSecretRequest request); /// /// Initiates the asynchronous execution of the CancelRotateSecret operation. /// /// /// Container for the necessary parameters to execute the CancelRotateSecret operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelRotateSecret /// operation. /// REST API Reference for CancelRotateSecret Operation IAsyncResult BeginCancelRotateSecret(CancelRotateSecretRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CancelRotateSecret operation. /// /// /// The IAsyncResult returned by the call to BeginCancelRotateSecret. /// /// Returns a CancelRotateSecretResult from SecretsManager. /// REST API Reference for CancelRotateSecret Operation CancelRotateSecretResponse EndCancelRotateSecret(IAsyncResult asyncResult); #endregion #region CreateSecret /// /// Creates a new secret. A secret can be a password, a set of credentials such /// as a user name and password, an OAuth token, or other secret information that you /// store in an encrypted form in Secrets Manager. The secret also includes the connection /// information to access a database or other service, which Secrets Manager doesn't encrypt. /// A secret in Secrets Manager consists of both the protected secret data and the important /// information needed to manage the secret. /// /// /// /// For secrets that use managed rotation, you need to create the secret through /// the managing service. For more information, see Secrets /// Manager secrets managed by other Amazon Web Services services. /// /// /// /// For information about creating a secret in the console, see Create /// a secret. /// /// /// /// To create a secret, you can provide the secret value to be encrypted in either the /// SecretString parameter or the SecretBinary parameter, but /// not both. If you include SecretString or SecretBinary then /// Secrets Manager creates an initial secret version and automatically attaches the staging /// label AWSCURRENT to it. /// /// /// /// For database credentials you want to rotate, for Secrets Manager to be able to rotate /// the secret, you must make sure the JSON you store in the SecretString /// matches the JSON /// structure of a database secret. /// /// /// /// If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services /// managed key aws/secretsmanager. If this key doesn't already exist in /// your account, then Secrets Manager creates it for you automatically. All users and /// roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. /// Creating aws/secretsmanager can result in a one-time significant delay /// in returning the result. /// /// /// /// If the secret is in a different Amazon Web Services account from the credentials calling /// the API, then you can't use aws/secretsmanager to encrypt the secret, /// and you must create and use a customer managed KMS key. /// /// /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters except SecretBinary /// or SecretString because it might be logged. For more information, see /// Logging /// Secrets Manager events with CloudTrail. /// /// /// /// Required permissions: secretsmanager:CreateSecret. If you include /// tags in the secret, you also need secretsmanager:TagResource. For more /// information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. /// /// /// /// To encrypt the secret with a KMS key other than aws/secretsmanager, you /// need kms:GenerateDataKey and kms:Decrypt permission to the /// key. /// /// /// Container for the necessary parameters to execute the CreateSecret service method. /// /// The response from the CreateSecret service method, as returned by SecretsManager. /// /// Secrets Manager can't decrypt the protected secret text using the provided KMS key. /// /// /// 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. /// /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// The request failed because it would exceed one of the Secrets Manager quotas. /// /// /// The resource policy has syntax errors. /// /// /// The request failed because you did not complete all the prerequisite steps. /// /// /// A resource with the ID you requested already exists. /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for CreateSecret Operation CreateSecretResponse CreateSecret(CreateSecretRequest request); /// /// Initiates the asynchronous execution of the CreateSecret operation. /// /// /// Container for the necessary parameters to execute the CreateSecret operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSecret /// operation. /// REST API Reference for CreateSecret Operation IAsyncResult BeginCreateSecret(CreateSecretRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateSecret operation. /// /// /// The IAsyncResult returned by the call to BeginCreateSecret. /// /// Returns a CreateSecretResult from SecretsManager. /// REST API Reference for CreateSecret Operation CreateSecretResponse EndCreateSecret(IAsyncResult asyncResult); #endregion #region DeleteResourcePolicy /// /// 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. /// /// /// Container for the necessary parameters to execute the DeleteResourcePolicy service method. /// /// The response from the DeleteResourcePolicy service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for DeleteResourcePolicy Operation DeleteResourcePolicyResponse DeleteResourcePolicy(DeleteResourcePolicyRequest request); /// /// Initiates the asynchronous execution of the DeleteResourcePolicy operation. /// /// /// Container for the necessary parameters to execute the DeleteResourcePolicy operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteResourcePolicy /// operation. /// REST API Reference for DeleteResourcePolicy Operation IAsyncResult BeginDeleteResourcePolicy(DeleteResourcePolicyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteResourcePolicy operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteResourcePolicy. /// /// Returns a DeleteResourcePolicyResult from SecretsManager. /// REST API Reference for DeleteResourcePolicy Operation DeleteResourcePolicyResponse EndDeleteResourcePolicy(IAsyncResult asyncResult); #endregion #region DeleteSecret /// /// 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. /// /// /// Container for the necessary parameters to execute the DeleteSecret service method. /// /// The response from the DeleteSecret service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for DeleteSecret Operation DeleteSecretResponse DeleteSecret(DeleteSecretRequest request); /// /// Initiates the asynchronous execution of the DeleteSecret operation. /// /// /// Container for the necessary parameters to execute the DeleteSecret operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSecret /// operation. /// REST API Reference for DeleteSecret Operation IAsyncResult BeginDeleteSecret(DeleteSecretRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteSecret operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteSecret. /// /// Returns a DeleteSecretResult from SecretsManager. /// REST API Reference for DeleteSecret Operation DeleteSecretResponse EndDeleteSecret(IAsyncResult asyncResult); #endregion #region DescribeSecret /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeSecret service method. /// /// The response from the DescribeSecret service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for DescribeSecret Operation DescribeSecretResponse DescribeSecret(DescribeSecretRequest request); /// /// Initiates the asynchronous execution of the DescribeSecret operation. /// /// /// Container for the necessary parameters to execute the DescribeSecret operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSecret /// operation. /// REST API Reference for DescribeSecret Operation IAsyncResult BeginDescribeSecret(DescribeSecretRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeSecret operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeSecret. /// /// Returns a DescribeSecretResult from SecretsManager. /// REST API Reference for DescribeSecret Operation DescribeSecretResponse EndDescribeSecret(IAsyncResult asyncResult); #endregion #region 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. /// /// /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters because it might be logged. For /// more information, see Logging /// Secrets Manager events with CloudTrail. /// /// /// /// Required permissions: secretsmanager:GetRandomPassword. For /// more information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. /// /// /// Container for the necessary parameters to execute the GetRandomPassword service method. /// /// The response from the GetRandomPassword service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// REST API Reference for GetRandomPassword Operation GetRandomPasswordResponse GetRandomPassword(GetRandomPasswordRequest request); /// /// Initiates the asynchronous execution of the GetRandomPassword operation. /// /// /// Container for the necessary parameters to execute the GetRandomPassword operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRandomPassword /// operation. /// REST API Reference for GetRandomPassword Operation IAsyncResult BeginGetRandomPassword(GetRandomPasswordRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetRandomPassword operation. /// /// /// The IAsyncResult returned by the call to BeginGetRandomPassword. /// /// Returns a GetRandomPasswordResult from SecretsManager. /// REST API Reference for GetRandomPassword Operation GetRandomPasswordResponse EndGetRandomPassword(IAsyncResult asyncResult); #endregion #region GetResourcePolicy /// /// 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. /// /// /// Container for the necessary parameters to execute the GetResourcePolicy service method. /// /// The response from the GetResourcePolicy service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for GetResourcePolicy Operation GetResourcePolicyResponse GetResourcePolicy(GetResourcePolicyRequest request); /// /// Initiates the asynchronous execution of the GetResourcePolicy operation. /// /// /// Container for the necessary parameters to execute the GetResourcePolicy operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetResourcePolicy /// operation. /// REST API Reference for GetResourcePolicy Operation IAsyncResult BeginGetResourcePolicy(GetResourcePolicyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetResourcePolicy operation. /// /// /// The IAsyncResult returned by the call to BeginGetResourcePolicy. /// /// Returns a GetResourcePolicyResult from SecretsManager. /// REST API Reference for GetResourcePolicy Operation GetResourcePolicyResponse EndGetResourcePolicy(IAsyncResult asyncResult); #endregion #region GetSecretValue /// /// Retrieves the contents of the encrypted fields SecretString or SecretBinary /// from the specified version of a secret, whichever contains content. /// /// /// /// We recommend that you cache your secret values by using client-side caching. Caching /// secrets improves speed and reduces your costs. For more information, see Cache /// secrets for your applications. /// /// /// /// To retrieve the previous version of a secret, use VersionStage and specify /// AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage. /// /// /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters because it might be logged. For /// more information, see Logging /// Secrets Manager events with CloudTrail. /// /// /// /// Required permissions: secretsmanager:GetSecretValue. If the /// secret is encrypted using a customer-managed key instead of the Amazon Web Services /// managed key aws/secretsmanager, then you also need kms:Decrypt /// permissions for that key. For more information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. /// /// /// Container for the necessary parameters to execute the GetSecretValue service method. /// /// The response from the GetSecretValue service method, as returned by SecretsManager. /// /// Secrets Manager can't decrypt the protected secret text using the provided KMS key. /// /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for GetSecretValue Operation GetSecretValueResponse GetSecretValue(GetSecretValueRequest request); /// /// Initiates the asynchronous execution of the GetSecretValue operation. /// /// /// Container for the necessary parameters to execute the GetSecretValue operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSecretValue /// operation. /// REST API Reference for GetSecretValue Operation IAsyncResult BeginGetSecretValue(GetSecretValueRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetSecretValue operation. /// /// /// The IAsyncResult returned by the call to BeginGetSecretValue. /// /// Returns a GetSecretValueResult from SecretsManager. /// REST API Reference for GetSecretValue Operation GetSecretValueResponse EndGetSecretValue(IAsyncResult asyncResult); #endregion #region 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. /// /// /// /// ListSecrets is eventually consistent, however it might not reflect changes from the /// last five minutes. To get the latest information for a specific secret, use DescribeSecret. /// /// /// /// To list the versions of a secret, use ListSecretVersionIds. /// /// /// /// To get the secret value from SecretString or SecretBinary, /// call GetSecretValue. /// /// /// /// For information about finding secrets in the console, see Find /// secrets in Secrets Manager. /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the ListSecrets service method. /// /// The response from the ListSecrets service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The NextToken value is invalid. /// /// /// The parameter name or value is invalid. /// /// REST API Reference for ListSecrets Operation ListSecretsResponse ListSecrets(ListSecretsRequest request); /// /// Initiates the asynchronous execution of the ListSecrets operation. /// /// /// Container for the necessary parameters to execute the ListSecrets operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSecrets /// operation. /// REST API Reference for ListSecrets Operation IAsyncResult BeginListSecrets(ListSecretsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListSecrets operation. /// /// /// The IAsyncResult returned by the call to BeginListSecrets. /// /// Returns a ListSecretsResult from SecretsManager. /// REST API Reference for ListSecrets Operation ListSecretsResponse EndListSecrets(IAsyncResult asyncResult); #endregion #region ListSecretVersionIds /// /// 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. /// /// /// Container for the necessary parameters to execute the ListSecretVersionIds service method. /// /// The response from the ListSecretVersionIds service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The NextToken value is invalid. /// /// /// The parameter name or value is invalid. /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for ListSecretVersionIds Operation ListSecretVersionIdsResponse ListSecretVersionIds(ListSecretVersionIdsRequest request); /// /// Initiates the asynchronous execution of the ListSecretVersionIds operation. /// /// /// Container for the necessary parameters to execute the ListSecretVersionIds operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSecretVersionIds /// operation. /// REST API Reference for ListSecretVersionIds Operation IAsyncResult BeginListSecretVersionIds(ListSecretVersionIdsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListSecretVersionIds operation. /// /// /// The IAsyncResult returned by the call to BeginListSecretVersionIds. /// /// Returns a ListSecretVersionIdsResult from SecretsManager. /// REST API Reference for ListSecretVersionIds Operation ListSecretVersionIdsResponse EndListSecretVersionIds(IAsyncResult asyncResult); #endregion #region PutResourcePolicy /// /// 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. /// /// /// Container for the necessary parameters to execute the PutResourcePolicy service method. /// /// The response from the PutResourcePolicy service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// The resource policy has syntax errors. /// /// /// The BlockPublicPolicy parameter is set to true, and the resource policy /// did not prevent broad access to the secret. /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for PutResourcePolicy Operation PutResourcePolicyResponse PutResourcePolicy(PutResourcePolicyRequest request); /// /// Initiates the asynchronous execution of the PutResourcePolicy operation. /// /// /// Container for the necessary parameters to execute the PutResourcePolicy operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutResourcePolicy /// operation. /// REST API Reference for PutResourcePolicy Operation IAsyncResult BeginPutResourcePolicy(PutResourcePolicyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the PutResourcePolicy operation. /// /// /// The IAsyncResult returned by the call to BeginPutResourcePolicy. /// /// Returns a PutResourcePolicyResult from SecretsManager. /// REST API Reference for PutResourcePolicy Operation PutResourcePolicyResponse EndPutResourcePolicy(IAsyncResult asyncResult); #endregion #region PutSecretValue /// /// Creates a new version with a new encrypted secret value and attaches it to the secret. /// The version can contain a new SecretString value or a new SecretBinary /// value. /// /// /// /// We recommend you avoid calling PutSecretValue at a sustained rate of /// more than once every 10 minutes. When you update the secret value, Secrets Manager /// creates a new version of the secret. Secrets Manager removes outdated versions when /// there are more than 100, but it does not remove versions created less than 24 hours /// ago. If you call PutSecretValue more than once every 10 minutes, you /// create more versions than Secrets Manager removes, and you will reach the quota for /// secret versions. /// /// /// /// You can specify the staging labels to attach to the new version in VersionStages. /// If you don't include VersionStages, then Secrets Manager automatically /// moves the staging label AWSCURRENT to this version. If this operation /// creates the first version for the secret, then Secrets Manager automatically attaches /// the staging label AWSCURRENT to it. If this operation moves the staging /// label AWSCURRENT from another version to this version, then Secrets Manager /// also automatically moves the staging label AWSPREVIOUS to the version /// that AWSCURRENT was removed from. /// /// /// /// This operation is idempotent. If you call this operation with a ClientRequestToken /// that matches an existing version's VersionId, and you specify the same secret data, /// the operation succeeds but does nothing. However, if the secret data is different, /// then the operation fails because you can't modify an existing version; you can only /// create new ones. /// /// /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters except SecretBinary /// or SecretString because it might be logged. For more information, see /// Logging /// Secrets Manager events with CloudTrail. /// /// /// /// Required permissions: secretsmanager:PutSecretValue. For more /// information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. /// /// /// Container for the necessary parameters to execute the PutSecretValue service method. /// /// The response from the PutSecretValue service method, as returned by SecretsManager. /// /// Secrets Manager can't decrypt the protected secret text using the provided KMS key. /// /// /// 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. /// /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// The request failed because it would exceed one of the Secrets Manager quotas. /// /// /// A resource with the ID you requested already exists. /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for PutSecretValue Operation PutSecretValueResponse PutSecretValue(PutSecretValueRequest request); /// /// Initiates the asynchronous execution of the PutSecretValue operation. /// /// /// Container for the necessary parameters to execute the PutSecretValue operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutSecretValue /// operation. /// REST API Reference for PutSecretValue Operation IAsyncResult BeginPutSecretValue(PutSecretValueRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the PutSecretValue operation. /// /// /// The IAsyncResult returned by the call to BeginPutSecretValue. /// /// Returns a PutSecretValueResult from SecretsManager. /// REST API Reference for PutSecretValue Operation PutSecretValueResponse EndPutSecretValue(IAsyncResult asyncResult); #endregion #region RemoveRegionsFromReplication /// /// 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. /// /// /// Container for the necessary parameters to execute the RemoveRegionsFromReplication service method. /// /// The response from the RemoveRegionsFromReplication service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for RemoveRegionsFromReplication Operation RemoveRegionsFromReplicationResponse RemoveRegionsFromReplication(RemoveRegionsFromReplicationRequest request); /// /// Initiates the asynchronous execution of the RemoveRegionsFromReplication operation. /// /// /// Container for the necessary parameters to execute the RemoveRegionsFromReplication operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRemoveRegionsFromReplication /// operation. /// REST API Reference for RemoveRegionsFromReplication Operation IAsyncResult BeginRemoveRegionsFromReplication(RemoveRegionsFromReplicationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RemoveRegionsFromReplication operation. /// /// /// The IAsyncResult returned by the call to BeginRemoveRegionsFromReplication. /// /// Returns a RemoveRegionsFromReplicationResult from SecretsManager. /// REST API Reference for RemoveRegionsFromReplication Operation RemoveRegionsFromReplicationResponse EndRemoveRegionsFromReplication(IAsyncResult asyncResult); #endregion #region ReplicateSecretToRegions /// /// 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. /// For more information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. /// /// /// Container for the necessary parameters to execute the ReplicateSecretToRegions service method. /// /// The response from the ReplicateSecretToRegions service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for ReplicateSecretToRegions Operation ReplicateSecretToRegionsResponse ReplicateSecretToRegions(ReplicateSecretToRegionsRequest request); /// /// Initiates the asynchronous execution of the ReplicateSecretToRegions operation. /// /// /// Container for the necessary parameters to execute the ReplicateSecretToRegions operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReplicateSecretToRegions /// operation. /// REST API Reference for ReplicateSecretToRegions Operation IAsyncResult BeginReplicateSecretToRegions(ReplicateSecretToRegionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ReplicateSecretToRegions operation. /// /// /// The IAsyncResult returned by the call to BeginReplicateSecretToRegions. /// /// Returns a ReplicateSecretToRegionsResult from SecretsManager. /// REST API Reference for ReplicateSecretToRegions Operation ReplicateSecretToRegionsResponse EndReplicateSecretToRegions(IAsyncResult asyncResult); #endregion #region RestoreSecret /// /// 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. /// /// /// Container for the necessary parameters to execute the RestoreSecret service method. /// /// The response from the RestoreSecret service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for RestoreSecret Operation RestoreSecretResponse RestoreSecret(RestoreSecretRequest request); /// /// Initiates the asynchronous execution of the RestoreSecret operation. /// /// /// Container for the necessary parameters to execute the RestoreSecret operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreSecret /// operation. /// REST API Reference for RestoreSecret Operation IAsyncResult BeginRestoreSecret(RestoreSecretRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RestoreSecret operation. /// /// /// The IAsyncResult returned by the call to BeginRestoreSecret. /// /// Returns a RestoreSecretResult from SecretsManager. /// REST API Reference for RestoreSecret Operation RestoreSecretResponse EndRestoreSecret(IAsyncResult asyncResult); #endregion #region RotateSecret /// /// Configures and starts the asynchronous process of rotating the secret. For information /// about rotation, see Rotate /// secrets in the Secrets Manager User Guide. If you include the configuration /// parameters, the operation sets the values for the secret and then immediately starts /// a rotation. If you don't include the configuration parameters, the operation starts /// a rotation with the values already stored in the secret. /// /// /// /// When rotation is successful, the AWSPENDING staging label might be attached /// to the same version as the AWSCURRENT version, or it might not be attached /// to any version. If the AWSPENDING staging label is present but not attached /// to the same version as AWSCURRENT, then any later invocation of RotateSecret /// assumes that a previous rotation request is still in progress and returns an error. /// When rotation is unsuccessful, the AWSPENDING staging label might be /// attached to an empty secret version. For more information, see Troubleshoot /// rotation in the Secrets Manager User Guide. /// /// /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters because it might be logged. For /// more information, see Logging /// Secrets Manager events with CloudTrail. /// /// /// /// Required permissions: secretsmanager:RotateSecret. For more /// information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. You also need lambda:InvokeFunction /// permissions on the rotation function. For more information, see /// Permissions for rotation. /// /// /// Container for the necessary parameters to execute the RotateSecret service method. /// /// The response from the RotateSecret service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for RotateSecret Operation RotateSecretResponse RotateSecret(RotateSecretRequest request); /// /// Initiates the asynchronous execution of the RotateSecret operation. /// /// /// Container for the necessary parameters to execute the RotateSecret operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRotateSecret /// operation. /// REST API Reference for RotateSecret Operation IAsyncResult BeginRotateSecret(RotateSecretRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RotateSecret operation. /// /// /// The IAsyncResult returned by the call to BeginRotateSecret. /// /// Returns a RotateSecretResult from SecretsManager. /// REST API Reference for RotateSecret Operation RotateSecretResponse EndRotateSecret(IAsyncResult asyncResult); #endregion #region StopReplicationToReplica /// /// 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. /// /// /// Container for the necessary parameters to execute the StopReplicationToReplica service method. /// /// The response from the StopReplicationToReplica service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for StopReplicationToReplica Operation StopReplicationToReplicaResponse StopReplicationToReplica(StopReplicationToReplicaRequest request); /// /// Initiates the asynchronous execution of the StopReplicationToReplica operation. /// /// /// Container for the necessary parameters to execute the StopReplicationToReplica operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopReplicationToReplica /// operation. /// REST API Reference for StopReplicationToReplica Operation IAsyncResult BeginStopReplicationToReplica(StopReplicationToReplicaRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StopReplicationToReplica operation. /// /// /// The IAsyncResult returned by the call to BeginStopReplicationToReplica. /// /// Returns a StopReplicationToReplicaResult from SecretsManager. /// REST API Reference for StopReplicationToReplica Operation StopReplicationToReplicaResponse EndStopReplicationToReplica(IAsyncResult asyncResult); #endregion #region 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. /// /// /// /// The following restrictions apply to tags: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from SecretsManager. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// 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. /// /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from SecretsManager. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateSecret /// /// Modifies the details of a secret, including metadata and the secret value. To change /// the secret value, you can also use PutSecretValue. /// /// /// /// To change the rotation configuration of a secret, use RotateSecret instead. /// /// /// /// To change a secret so that it is managed by another service, you need to recreate /// the secret in that service. See Secrets /// Manager secrets managed by other Amazon Web Services services. /// /// /// /// We recommend you avoid calling UpdateSecret at a sustained rate of more /// than once every 10 minutes. When you call UpdateSecret to update the /// secret value, Secrets Manager creates a new version of the secret. Secrets Manager /// removes outdated versions when there are more than 100, but it does not remove versions /// created less than 24 hours ago. If you update the secret value more than once every /// 10 minutes, you create more versions than Secrets Manager removes, and you will reach /// the quota for secret versions. /// /// /// /// If you include SecretString or SecretBinary to create a /// new secret version, Secrets Manager automatically moves the staging label AWSCURRENT /// to the new version. Then it attaches the label AWSPREVIOUS to the version /// that AWSCURRENT was removed from. /// /// /// /// If you call this operation with a ClientRequestToken that matches an /// existing version's VersionId, the operation results in an error. You /// can't modify an existing version, you can only create a new version. To remove a version, /// remove all staging labels from it. See UpdateSecretVersionStage. /// /// /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters except SecretBinary /// or SecretString because it might be logged. For more information, see /// Logging /// Secrets Manager events with CloudTrail. /// /// /// /// Required permissions: secretsmanager:UpdateSecret. For more /// information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. If you use a customer managed key, you /// must also have kms:GenerateDataKey, kms:Encrypt, and kms:Decrypt /// permissions on the key. If you change the KMS key and you don't have kms:Encrypt /// permission to the new key, Secrets Manager does not re-ecrypt existing secret versions /// with the new key. For more information, see /// Secret encryption and decryption. /// /// /// Container for the necessary parameters to execute the UpdateSecret service method. /// /// The response from the UpdateSecret service method, as returned by SecretsManager. /// /// Secrets Manager can't decrypt the protected secret text using the provided KMS key. /// /// /// 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. /// /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// The request failed because it would exceed one of the Secrets Manager quotas. /// /// /// The resource policy has syntax errors. /// /// /// The request failed because you did not complete all the prerequisite steps. /// /// /// A resource with the ID you requested already exists. /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for UpdateSecret Operation UpdateSecretResponse UpdateSecret(UpdateSecretRequest request); /// /// Initiates the asynchronous execution of the UpdateSecret operation. /// /// /// Container for the necessary parameters to execute the UpdateSecret operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSecret /// operation. /// REST API Reference for UpdateSecret Operation IAsyncResult BeginUpdateSecret(UpdateSecretRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateSecret operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateSecret. /// /// Returns a UpdateSecretResult from SecretsManager. /// REST API Reference for UpdateSecret Operation UpdateSecretResponse EndUpdateSecret(IAsyncResult asyncResult); #endregion #region UpdateSecretVersionStage /// /// Modifies the staging labels attached to a version of a secret. Secrets Manager uses /// staging labels to track a version as it progresses through the secret rotation process. /// Each staging label can be attached to only one version at a time. To add a staging /// label to a version when it is already attached to another version, Secrets Manager /// first removes it from the other version first and then attaches it to this one. For /// more information about versions and staging labels, see Concepts: /// Version. /// /// /// /// The staging labels that you specify in the VersionStage parameter are /// added to the existing list of staging labels for the version. /// /// /// /// You can move the AWSCURRENT staging label to this version by including /// it in this call. /// /// /// /// Whenever you move AWSCURRENT, Secrets Manager automatically moves the /// label AWSPREVIOUS to the version that AWSCURRENT was removed /// from. /// /// /// /// If this action results in the last label being removed from a version, then the version /// is considered to be 'deprecated' and can be deleted by Secrets Manager. /// /// /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters because it might be logged. For /// more information, see Logging /// Secrets Manager events with CloudTrail. /// /// /// /// Required permissions: secretsmanager:UpdateSecretVersionStage. /// For more information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. /// /// /// Container for the necessary parameters to execute the UpdateSecretVersionStage service method. /// /// The response from the UpdateSecretVersionStage service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// The request failed because it would exceed one of the Secrets Manager quotas. /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for UpdateSecretVersionStage Operation UpdateSecretVersionStageResponse UpdateSecretVersionStage(UpdateSecretVersionStageRequest request); /// /// Initiates the asynchronous execution of the UpdateSecretVersionStage operation. /// /// /// Container for the necessary parameters to execute the UpdateSecretVersionStage operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSecretVersionStage /// operation. /// REST API Reference for UpdateSecretVersionStage Operation IAsyncResult BeginUpdateSecretVersionStage(UpdateSecretVersionStageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateSecretVersionStage operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateSecretVersionStage. /// /// Returns a UpdateSecretVersionStageResult from SecretsManager. /// REST API Reference for UpdateSecretVersionStage Operation UpdateSecretVersionStageResponse EndUpdateSecretVersionStage(IAsyncResult asyncResult); #endregion #region ValidateResourcePolicy /// /// 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: /// /// /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters because it might be logged. For /// more information, see Logging /// Secrets Manager events with CloudTrail. /// /// /// /// Required permissions: secretsmanager:ValidateResourcePolicy /// and secretsmanager:PutResourcePolicy. For more information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. /// /// /// Container for the necessary parameters to execute the ValidateResourcePolicy service method. /// /// The response from the ValidateResourcePolicy service method, as returned by SecretsManager. /// /// An error occurred on the server side. /// /// /// The parameter name or value is invalid. /// /// /// A parameter value is not valid for the current state of the resource. /// /// /// /// Possible causes: /// /// /// /// /// The resource policy has syntax errors. /// /// /// Secrets Manager can't find the resource that you asked for. /// /// REST API Reference for ValidateResourcePolicy Operation ValidateResourcePolicyResponse ValidateResourcePolicy(ValidateResourcePolicyRequest request); /// /// Initiates the asynchronous execution of the ValidateResourcePolicy operation. /// /// /// Container for the necessary parameters to execute the ValidateResourcePolicy operation on AmazonSecretsManagerClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndValidateResourcePolicy /// operation. /// REST API Reference for ValidateResourcePolicy Operation IAsyncResult BeginValidateResourcePolicy(ValidateResourcePolicyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ValidateResourcePolicy operation. /// /// /// The IAsyncResult returned by the call to BeginValidateResourcePolicy. /// /// Returns a ValidateResourcePolicyResult from SecretsManager. /// REST API Reference for ValidateResourcePolicy Operation ValidateResourcePolicyResponse EndValidateResourcePolicy(IAsyncResult asyncResult); #endregion } }