secretsmanager: AWS Secrets Manager

Description Usage Arguments Service syntax Operations Examples

View source: R/secretsmanager_service.R

Description

AWS Secrets Manager API Reference

AWS Secrets Manager is a web service that enables 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 directly, 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 take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that 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 supports GET and POST requests for all actions. That is, the API 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 [email protected], 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 that the service returns as a response to HTTP query requests are single, long strings without line breaks or white space formatting. The JSON shown in the examples is formatted with both line breaks and white space to improve readability. When example input parameters would also result in long strings that extend beyond the screen, we 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 which requests were successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about AWS Secrets Manager and its 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 how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Usage

1
secretsmanager(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- secretsmanager(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

cancel_rotate_secret Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress
create_secret Creates a new secret
delete_resource_policy Deletes the resource-based permission policy that's attached to the secret
delete_secret Deletes an entire secret and all of its versions
describe_secret Retrieves the details of a secret
get_random_password Generates a random password of the specified complexity
get_resource_policy Retrieves the JSON text of the resource-based policy document that's attached to the specified secret
get_secret_value Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content
list_secrets Lists all of the secrets that are stored by Secrets Manager in the AWS account
list_secret_version_ids Lists all of the versions attached to the specified secret
put_resource_policy Attaches the contents of the specified resource-based permission policy to a secret
put_secret_value Stores a new encrypted secret value in the specified secret
restore_secret Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp
rotate_secret Configures and starts the asynchronous process of rotating this secret
tag_resource Attaches one or more tags, each consisting of a key name and a value, to the specified secret
untag_resource Removes one or more tags from the specified secret
update_secret Modifies many of the details of the specified secret
update_secret_version_stage Modifies the staging labels attached to a version of a secret

Examples

1
2
3
4
5
6
7
8
# The following example shows how to cancel rotation for a secret. The
# operation sets the RotationEnabled field to false and cancels all
# scheduled rotations. To resume scheduled rotations, you must re-enable
# rotation by calling the rotate-secret operation.
svc <- secretsmanager()
svc$cancel_rotate_secret(
  SecretId = "MyTestDatabaseSecret"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.