diff options
Diffstat (limited to 'vendor/github.com/aws/aws-sdk-go/service/sts/doc.go')
| -rw-r--r-- | vendor/github.com/aws/aws-sdk-go/service/sts/doc.go | 64 |
1 files changed, 6 insertions, 58 deletions
diff --git a/vendor/github.com/aws/aws-sdk-go/service/sts/doc.go b/vendor/github.com/aws/aws-sdk-go/service/sts/doc.go index d2af518..ef681ab 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/sts/doc.go +++ b/vendor/github.com/aws/aws-sdk-go/service/sts/doc.go | |||
| @@ -56,69 +56,17 @@ | |||
| 56 | // | 56 | // |
| 57 | // Using the Client | 57 | // Using the Client |
| 58 | // | 58 | // |
| 59 | // To use the client for AWS Security Token Service you will first need | 59 | // To contact AWS Security Token Service with the SDK use the New function to create |
| 60 | // to create a new instance of it. | 60 | // a new service client. With that client you can make API requests to the service. |
| 61 | // These clients are safe to use concurrently. | ||
| 61 | // | 62 | // |
| 62 | // When creating a client for an AWS service you'll first need to have a Session | 63 | // See the SDK's documentation for more information on how to use the SDK. |
| 63 | // already created. The Session provides configuration that can be shared | ||
| 64 | // between multiple service clients. Additional configuration can be applied to | ||
| 65 | // the Session and service's client when they are constructed. The aws package's | ||
| 66 | // Config type contains several fields such as Region for the AWS Region the | ||
| 67 | // client should make API requests too. The optional Config value can be provided | ||
| 68 | // as the variadic argument for Sessions and client creation. | ||
| 69 | // | ||
| 70 | // Once the service's client is created you can use it to make API requests the | ||
| 71 | // AWS service. These clients are safe to use concurrently. | ||
| 72 | // | ||
| 73 | // // Create a session to share configuration, and load external configuration. | ||
| 74 | // sess := session.Must(session.NewSession()) | ||
| 75 | // | ||
| 76 | // // Create the service's client with the session. | ||
| 77 | // svc := sts.New(sess) | ||
| 78 | // | ||
| 79 | // See the SDK's documentation for more information on how to use service clients. | ||
| 80 | // https://docs.aws.amazon.com/sdk-for-go/api/ | 64 | // https://docs.aws.amazon.com/sdk-for-go/api/ |
| 81 | // | 65 | // |
| 82 | // See aws package's Config type for more information on configuration options. | 66 | // See aws.Config documentation for more information on configuring SDK clients. |
| 83 | // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config | 67 | // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config |
| 84 | // | 68 | // |
| 85 | // See the AWS Security Token Service client STS for more | 69 | // See the AWS Security Token Service client STS for more |
| 86 | // information on creating the service's client. | 70 | // information on creating client for this service. |
| 87 | // https://docs.aws.amazon.com/sdk-for-go/api/service/sts/#New | 71 | // https://docs.aws.amazon.com/sdk-for-go/api/service/sts/#New |
| 88 | // | ||
| 89 | // Once the client is created you can make an API request to the service. | ||
| 90 | // Each API method takes a input parameter, and returns the service response | ||
| 91 | // and an error. | ||
| 92 | // | ||
| 93 | // The API method will document which error codes the service can be returned | ||
| 94 | // by the operation if the service models the API operation's errors. These | ||
| 95 | // errors will also be available as const strings prefixed with "ErrCode". | ||
| 96 | // | ||
| 97 | // result, err := svc.AssumeRole(params) | ||
| 98 | // if err != nil { | ||
| 99 | // // Cast err to awserr.Error to handle specific error codes. | ||
| 100 | // aerr, ok := err.(awserr.Error) | ||
| 101 | // if ok && aerr.Code() == <error code to check for> { | ||
| 102 | // // Specific error code handling | ||
| 103 | // } | ||
| 104 | // return err | ||
| 105 | // } | ||
| 106 | // | ||
| 107 | // fmt.Println("AssumeRole result:") | ||
| 108 | // fmt.Println(result) | ||
| 109 | // | ||
| 110 | // Using the Client with Context | ||
| 111 | // | ||
| 112 | // The service's client also provides methods to make API requests with a Context | ||
| 113 | // value. This allows you to control the timeout, and cancellation of pending | ||
| 114 | // requests. These methods also take request Option as variadic parameter to apply | ||
| 115 | // additional configuration to the API request. | ||
| 116 | // | ||
| 117 | // ctx := context.Background() | ||
| 118 | // | ||
| 119 | // result, err := svc.AssumeRoleWithContext(ctx, params) | ||
| 120 | // | ||
| 121 | // See the request package documentation for more information on using Context pattern | ||
| 122 | // with the SDK. | ||
| 123 | // https://docs.aws.amazon.com/sdk-for-go/api/aws/request/ | ||
| 124 | package sts | 72 | package sts |