peridot/vendor/github.com/aws/aws-sdk-go/service/secretsmanager/doc.go

64 lines
3.3 KiB
Go
Raw Normal View History

2022-07-07 20:11:50 +00:00
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
// Package secretsmanager provides the client and types for making API
// requests to AWS Secrets Manager.
//
2022-11-04 02:21:49 +00:00
// Amazon Web Services Secrets Manager provides a service to enable you to store,
// manage, and retrieve, secrets.
2022-07-07 20:11:50 +00:00
//
// This guide provides descriptions of the Secrets Manager API. For more information
2022-11-04 02:21:49 +00:00
// about using this service, see the Amazon Web Services Secrets Manager User
// Guide (https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html).
2022-07-07 20:11:50 +00:00
//
2022-11-04 02:21:49 +00:00
// # API Version
2022-07-07 20:11:50 +00:00
//
// 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
// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints).
//
2022-11-04 02:21:49 +00:00
// # Support and Feedback for Amazon Web Services Secrets Manager
2022-07-07 20:11:50 +00:00
//
// We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com
// (mailto:awssecretsmanager-feedback@amazon.com), or post your feedback and
2022-11-04 02:21:49 +00:00
// questions in the Amazon Web Services Secrets Manager Discussion Forum (http://forums.aws.amazon.com/forum.jspa?forumID=296).
// For more information about the Amazon Web Services Discussion Forums, see
// Forums Help (http://forums.aws.amazon.com/help.jspa).
2022-07-07 20:11:50 +00:00
//
2022-11-04 02:21:49 +00:00
// # Logging API Requests
2022-07-07 20:11:50 +00:00
//
2022-11-04 02:21:49 +00:00
// 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
2022-07-07 20:11:50 +00:00
// the requests successfully made to Secrets Manager, who made the request,
2022-11-04 02:21:49 +00:00
// 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 (https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_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 (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html).
2022-07-07 20:11:50 +00:00
//
// See https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17 for more information on this service.
//
// See secretsmanager package documentation for more information.
// https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/
//
2022-11-04 02:21:49 +00:00
// # Using the Client
2022-07-07 20:11:50 +00:00
//
// To contact AWS Secrets Manager with the SDK use the New function to create
// a new service client. With that client you can make API requests to the service.
// These clients are safe to use concurrently.
//
// See the SDK's documentation for more information on how to use the SDK.
// https://docs.aws.amazon.com/sdk-for-go/api/
//
// See aws.Config documentation for more information on configuring SDK clients.
// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
//
// See the AWS Secrets Manager client SecretsManager for more
// information on creating client for this service.
// https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/#New
package secretsmanager