github.com/aavshr/aws-sdk-go@v1.41.3/service/secretsmanager/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package secretsmanager provides the client and types for making API
     4  // requests to AWS Secrets Manager.
     5  //
     6  // Amazon Web Services Secrets Manager provides a service to enable you to store,
     7  // manage, and retrieve, secrets.
     8  //
     9  // This guide provides descriptions of the Secrets Manager API. For more information
    10  // about using this service, see the Amazon Web Services Secrets Manager User
    11  // Guide (https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html).
    12  //
    13  // API Version
    14  //
    15  // This version of the Secrets Manager API Reference documents the Secrets Manager
    16  // API version 2017-10-17.
    17  //
    18  // As an alternative to using the API, you can use one of the Amazon Web Services
    19  // SDKs, which consist of libraries and sample code for various programming
    20  // languages and platforms such as Java, Ruby, .NET, iOS, and Android. The SDKs
    21  // provide a convenient way to create programmatic access to Amazon Web Services
    22  // Secrets Manager. For example, the SDKs provide cryptographically signing
    23  // requests, managing errors, and retrying requests automatically. For more
    24  // information about the Amazon Web Services SDKs, including downloading and
    25  // installing them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/).
    26  //
    27  // We recommend you use the Amazon Web Services SDKs to make programmatic API
    28  // calls to Secrets Manager. However, you also can use the Secrets Manager HTTP
    29  // Query API to make direct calls to the Secrets Manager web service. To learn
    30  // more about the Secrets Manager HTTP Query API, see Making Query Requests
    31  // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/query-requests.html)
    32  // in the Amazon Web Services Secrets Manager User Guide.
    33  //
    34  // Secrets Manager API supports GET and POST requests for all actions, and doesn't
    35  // require you to use GET for some actions and POST for others. However, GET
    36  // requests are subject to the limitation size of a URL. Therefore, for operations
    37  // that require larger sizes, use a POST request.
    38  //
    39  // Support and Feedback for Amazon Web Services Secrets Manager
    40  //
    41  // We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com
    42  // (mailto:awssecretsmanager-feedback@amazon.com), or post your feedback and
    43  // questions in the Amazon Web Services Secrets Manager Discussion Forum (http://forums.aws.amazon.com/forum.jspa?forumID=296).
    44  // For more information about the Amazon Web Services Discussion Forums, see
    45  // Forums Help (http://forums.aws.amazon.com/help.jspa).
    46  //
    47  // How examples are presented
    48  //
    49  // The JSON that Amazon Web Services Secrets Manager expects as your request
    50  // parameters and the service returns as a response to HTTP query requests contain
    51  // single, long strings without line breaks or white space formatting. The JSON
    52  // shown in the examples displays the code formatted with both line breaks and
    53  // white space to improve readability. When example input parameters can also
    54  // cause long strings extending beyond the screen, you can insert line breaks
    55  // to enhance readability. You should always submit the input as a single JSON
    56  // text string.
    57  //
    58  // Logging API Requests
    59  //
    60  // Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail,
    61  // a service that records Amazon Web Services API calls for your Amazon Web
    62  // Services account and delivers log files to an Amazon S3 bucket. By using
    63  // information that's collected by Amazon Web Services CloudTrail, you can determine
    64  // the requests successfully made to Secrets Manager, who made the request,
    65  // when it was made, and so on. For more about Amazon Web Services Secrets Manager
    66  // and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services
    67  // Secrets Manager Events with Amazon Web Services CloudTrail (http://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail)
    68  // in the Amazon Web Services Secrets Manager User Guide. To learn more about
    69  // CloudTrail, including enabling it and find your log files, see the Amazon
    70  // Web Services CloudTrail User Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html).
    71  //
    72  // See https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17 for more information on this service.
    73  //
    74  // See secretsmanager package documentation for more information.
    75  // https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/
    76  //
    77  // Using the Client
    78  //
    79  // To contact AWS Secrets Manager with the SDK use the New function to create
    80  // a new service client. With that client you can make API requests to the service.
    81  // These clients are safe to use concurrently.
    82  //
    83  // See the SDK's documentation for more information on how to use the SDK.
    84  // https://docs.aws.amazon.com/sdk-for-go/api/
    85  //
    86  // See aws.Config documentation for more information on configuring SDK clients.
    87  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    88  //
    89  // See the AWS Secrets Manager client SecretsManager for more
    90  // information on creating client for this service.
    91  // https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/#New
    92  package secretsmanager