Crate rusoto_secretsmanager
source · [−]Expand description
AWS 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 AWS Secrets Manager User Guide.
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS Secrets Manager. For example, the SDKs provide cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including downloading and installing them, see Tools for Amazon Web Services.
We recommend you use the AWS SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the AWS Secrets Manager User Guide.
Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Support and Feedback for AWS Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the AWS Secrets Manager Discussion Forum. For more information about the AWS Discussion Forums, see Forums Help.
How examples are presented
The JSON that AWS Secrets Manager expects as your request parameters and the service returns as a response to HTTP query requests contain single, long strings without line breaks or white space formatting. The JSON shown in the examples displays the code formatted with both line breaks and white space to improve readability. When example input parameters can also cause long strings extending beyond the screen, you can insert line breaks to enhance readability. You should always submit the input as a single JSON text string.
Logging API Requests
AWS Secrets Manager supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information that's collected by AWS 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 AWS Secrets Manager and support for AWS CloudTrail, see Logging AWS Secrets Manager Events with AWS CloudTrail in the AWS Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the AWS CloudTrail User Guide.
If you’re using the service, you’re probably looking for SecretsManagerClient and SecretsManager.
Structs
Allows you to add filters when you use the search function in Secrets Manager.
(Optional) Custom type consisting of a Region (required) and the KmsKeyId which can be an ARN, Key ID, or Alias.
A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.
A structure that defines the rotation configuration for the secret.
A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use the GetSecretValue operation.
A structure that contains information about one version of a secret.
A client for the AWS Secrets Manager API.
A structure that contains information about a tag.
Displays errors that occurred during validation of the resource policy.
Enums
Errors returned by CancelRotateSecret
Errors returned by CreateSecret
Errors returned by DeleteResourcePolicy
Errors returned by DeleteSecret
Errors returned by DescribeSecret
Errors returned by GetRandomPassword
Errors returned by GetResourcePolicy
Errors returned by GetSecretValue
Errors returned by ListSecretVersionIds
Errors returned by ListSecrets
Errors returned by PutResourcePolicy
Errors returned by PutSecretValue
Errors returned by RemoveRegionsFromReplication
Errors returned by ReplicateSecretToRegions
Errors returned by RestoreSecret
Errors returned by RotateSecret
Errors returned by StopReplicationToReplica
Errors returned by TagResource
Errors returned by UntagResource
Errors returned by UpdateSecret
Errors returned by UpdateSecretVersionStage
Errors returned by ValidateResourcePolicy
Traits
Trait representing the capabilities of the AWS Secrets Manager API. AWS Secrets Manager clients implement this trait.