diff options
author | Alex Pilon <apilon@hashicorp.com> | 2019-02-22 18:24:37 -0500 |
---|---|---|
committer | Alex Pilon <apilon@hashicorp.com> | 2019-02-22 18:24:37 -0500 |
commit | 15c0b25d011f37e7c20aeca9eaf461f78285b8d9 (patch) | |
tree | 255c250a5c9d4801c74092d33b7337d8c14438ff /vendor/github.com/aws/aws-sdk-go/service/s3/doc.go | |
parent | 07971ca38143c5faf951d152fba370ddcbe26ad5 (diff) | |
download | terraform-provider-statuscake-15c0b25d011f37e7c20aeca9eaf461f78285b8d9.tar.gz terraform-provider-statuscake-15c0b25d011f37e7c20aeca9eaf461f78285b8d9.tar.zst terraform-provider-statuscake-15c0b25d011f37e7c20aeca9eaf461f78285b8d9.zip |
deps: github.com/hashicorp/terraform@sdk-v0.11-with-go-modules
Updated via: go get github.com/hashicorp/terraform@sdk-v0.11-with-go-modules and go mod tidy
Diffstat (limited to 'vendor/github.com/aws/aws-sdk-go/service/s3/doc.go')
-rw-r--r-- | vendor/github.com/aws/aws-sdk-go/service/s3/doc.go | 64 |
1 files changed, 6 insertions, 58 deletions
diff --git a/vendor/github.com/aws/aws-sdk-go/service/s3/doc.go b/vendor/github.com/aws/aws-sdk-go/service/s3/doc.go index f045fd0..0def022 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/s3/doc.go +++ b/vendor/github.com/aws/aws-sdk-go/service/s3/doc.go | |||
@@ -10,69 +10,17 @@ | |||
10 | // | 10 | // |
11 | // Using the Client | 11 | // Using the Client |
12 | // | 12 | // |
13 | // To use the client for Amazon Simple Storage Service you will first need | 13 | // To contact Amazon Simple Storage Service with the SDK use the New function to create |
14 | // to create a new instance of it. | 14 | // a new service client. With that client you can make API requests to the service. |
15 | // These clients are safe to use concurrently. | ||
15 | // | 16 | // |
16 | // When creating a client for an AWS service you'll first need to have a Session | 17 | // See the SDK's documentation for more information on how to use the SDK. |
17 | // already created. The Session provides configuration that can be shared | ||
18 | // between multiple service clients. Additional configuration can be applied to | ||
19 | // the Session and service's client when they are constructed. The aws package's | ||
20 | // Config type contains several fields such as Region for the AWS Region the | ||
21 | // client should make API requests too. The optional Config value can be provided | ||
22 | // as the variadic argument for Sessions and client creation. | ||
23 | // | ||
24 | // Once the service's client is created you can use it to make API requests the | ||
25 | // AWS service. These clients are safe to use concurrently. | ||
26 | // | ||
27 | // // Create a session to share configuration, and load external configuration. | ||
28 | // sess := session.Must(session.NewSession()) | ||
29 | // | ||
30 | // // Create the service's client with the session. | ||
31 | // svc := s3.New(sess) | ||
32 | // | ||
33 | // See the SDK's documentation for more information on how to use service clients. | ||
34 | // https://docs.aws.amazon.com/sdk-for-go/api/ | 18 | // https://docs.aws.amazon.com/sdk-for-go/api/ |
35 | // | 19 | // |
36 | // See aws package's Config type for more information on configuration options. | 20 | // See aws.Config documentation for more information on configuring SDK clients. |
37 | // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config | 21 | // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config |
38 | // | 22 | // |
39 | // See the Amazon Simple Storage Service client S3 for more | 23 | // See the Amazon Simple Storage Service client S3 for more |
40 | // information on creating the service's client. | 24 | // information on creating client for this service. |
41 | // https://docs.aws.amazon.com/sdk-for-go/api/service/s3/#New | 25 | // https://docs.aws.amazon.com/sdk-for-go/api/service/s3/#New |
42 | // | ||
43 | // Once the client is created you can make an API request to the service. | ||
44 | // Each API method takes a input parameter, and returns the service response | ||
45 | // and an error. | ||
46 | // | ||
47 | // The API method will document which error codes the service can be returned | ||
48 | // by the operation if the service models the API operation's errors. These | ||
49 | // errors will also be available as const strings prefixed with "ErrCode". | ||
50 | // | ||
51 | // result, err := svc.AbortMultipartUpload(params) | ||
52 | // if err != nil { | ||
53 | // // Cast err to awserr.Error to handle specific error codes. | ||
54 | // aerr, ok := err.(awserr.Error) | ||
55 | // if ok && aerr.Code() == <error code to check for> { | ||
56 | // // Specific error code handling | ||
57 | // } | ||
58 | // return err | ||
59 | // } | ||
60 | // | ||
61 | // fmt.Println("AbortMultipartUpload result:") | ||
62 | // fmt.Println(result) | ||
63 | // | ||
64 | // Using the Client with Context | ||
65 | // | ||
66 | // The service's client also provides methods to make API requests with a Context | ||
67 | // value. This allows you to control the timeout, and cancellation of pending | ||
68 | // requests. These methods also take request Option as variadic parameter to apply | ||
69 | // additional configuration to the API request. | ||
70 | // | ||
71 | // ctx := context.Background() | ||
72 | // | ||
73 | // result, err := svc.AbortMultipartUploadWithContext(ctx, params) | ||
74 | // | ||
75 | // See the request package documentation for more information on using Context pattern | ||
76 | // with the SDK. | ||
77 | // https://docs.aws.amazon.com/sdk-for-go/api/aws/request/ | ||
78 | package s3 | 26 | package s3 |