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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package storagegateway provides the client and types for making API
     4  // requests to AWS Storage Gateway.
     5  //
     6  // Storage Gateway is the service that connects an on-premises software appliance
     7  // with cloud-based storage to provide seamless and secure integration between
     8  // an organization's on-premises IT environment and the Amazon Web Services
     9  // storage infrastructure. The service enables you to securely upload data to
    10  // the Cloud for cost effective backup and rapid disaster recovery.
    11  //
    12  // Use the following links to get started using the Storage Gateway Service
    13  // API Reference:
    14  //
    15  //    * Storage Gateway required request headers (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders):
    16  //    Describes the required headers that you must send with every POST request
    17  //    to Storage Gateway.
    18  //
    19  //    * Signing requests (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests):
    20  //    Storage Gateway requires that you authenticate every request you send;
    21  //    this topic describes how sign such a request.
    22  //
    23  //    * Error responses (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses):
    24  //    Provides reference information about Storage Gateway errors.
    25  //
    26  //    * Operations in Storage Gateway (https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html):
    27  //    Contains detailed descriptions of all Storage Gateway operations, their
    28  //    request parameters, response elements, possible errors, and examples of
    29  //    requests and responses.
    30  //
    31  //    * Storage Gateway endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html):
    32  //    Provides a list of each Region and the endpoints available for use with
    33  //    Storage Gateway.
    34  //
    35  // Storage Gateway resource IDs are in uppercase. When you use these resource
    36  // IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must
    37  // change your resource ID to lowercase to use it with the EC2 API. For example,
    38  // in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When
    39  // you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670.
    40  // Otherwise, the EC2 API might not behave as expected.
    41  //
    42  // IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway
    43  // volumes are changing to a longer format. Starting in December 2016, all new
    44  // volumes and snapshots will be created with a 17-character string. Starting
    45  // in April 2016, you will be able to use these longer IDs so you can test your
    46  // systems with the new format. For more information, see Longer EC2 and EBS
    47  // resource IDs (http://aws.amazon.com/ec2/faqs/#longer-ids).
    48  //
    49  // For example, a volume Amazon Resource Name (ARN) with the longer volume ID
    50  // format looks like the following:
    51  //
    52  // arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
    53  //
    54  // A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.
    55  //
    56  // For more information, see Announcement: Heads-up – Longer Storage Gateway
    57  // volume and snapshot IDs coming in 2016 (http://forums.aws.amazon.com/ann.jspa?annID=3557).
    58  //
    59  // See https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30 for more information on this service.
    60  //
    61  // See storagegateway package documentation for more information.
    62  // https://docs.aws.amazon.com/sdk-for-go/api/service/storagegateway/
    63  //
    64  // Using the Client
    65  //
    66  // To contact AWS Storage Gateway with the SDK use the New function to create
    67  // a new service client. With that client you can make API requests to the service.
    68  // These clients are safe to use concurrently.
    69  //
    70  // See the SDK's documentation for more information on how to use the SDK.
    71  // https://docs.aws.amazon.com/sdk-for-go/api/
    72  //
    73  // See aws.Config documentation for more information on configuring SDK clients.
    74  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    75  //
    76  // See the AWS Storage Gateway client StorageGateway for more
    77  // information on creating client for this service.
    78  // https://docs.aws.amazon.com/sdk-for-go/api/service/storagegateway/#New
    79  package storagegateway