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 | 124 |
1 files changed, 124 insertions, 0 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 new file mode 100644 index 0000000..d2af518 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/service/sts/doc.go | |||
@@ -0,0 +1,124 @@ | |||
1 | // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. | ||
2 | |||
3 | // Package sts provides the client and types for making API | ||
4 | // requests to AWS Security Token Service. | ||
5 | // | ||
6 | // The AWS Security Token Service (STS) is a web service that enables you to | ||
7 | // request temporary, limited-privilege credentials for AWS Identity and Access | ||
8 | // Management (IAM) users or for users that you authenticate (federated users). | ||
9 | // This guide provides descriptions of the STS API. For more detailed information | ||
10 | // about using this service, go to Temporary Security Credentials (http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html). | ||
11 | // | ||
12 | // As an alternative to using the API, you can use one of the AWS SDKs, which | ||
13 | // consist of libraries and sample code for various programming languages and | ||
14 | // platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient | ||
15 | // way to create programmatic access to STS. For example, the SDKs take care | ||
16 | // of cryptographically signing requests, managing errors, and retrying requests | ||
17 | // automatically. For information about the AWS SDKs, including how to download | ||
18 | // and install them, see the Tools for Amazon Web Services page (http://aws.amazon.com/tools/). | ||
19 | // | ||
20 | // For information about setting up signatures and authorization through the | ||
21 | // API, go to Signing AWS API Requests (http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) | ||
22 | // in the AWS General Reference. For general information about the Query API, | ||
23 | // go to Making Query Requests (http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) | ||
24 | // in Using IAM. For information about using security tokens with other AWS | ||
25 | // products, go to AWS Services That Work with IAM (http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) | ||
26 | // in the IAM User Guide. | ||
27 | // | ||
28 | // If you're new to AWS and need additional technical information about a specific | ||
29 | // AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/ | ||
30 | // (http://aws.amazon.com/documentation/). | ||
31 | // | ||
32 | // Endpoints | ||
33 | // | ||
34 | // The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com | ||
35 | // that maps to the US East (N. Virginia) region. Additional regions are available | ||
36 | // and are activated by default. For more information, see Activating and Deactivating | ||
37 | // AWS STS in an AWS Region (http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) | ||
38 | // in the IAM User Guide. | ||
39 | // | ||
40 | // For information about STS endpoints, see Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#sts_region) | ||
41 | // in the AWS General Reference. | ||
42 | // | ||
43 | // Recording API requests | ||
44 | // | ||
45 | // STS supports AWS CloudTrail, which is a service that records AWS calls for | ||
46 | // your AWS account and delivers log files to an Amazon S3 bucket. By using | ||
47 | // information collected by CloudTrail, you can determine what requests were | ||
48 | // successfully made to STS, who made the request, when it was made, and so | ||
49 | // on. To learn more about CloudTrail, including how to turn it on and find | ||
50 | // your log files, see the AWS CloudTrail User Guide (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html). | ||
51 | // | ||
52 | // See https://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15 for more information on this service. | ||
53 | // | ||
54 | // See sts package documentation for more information. | ||
55 | // https://docs.aws.amazon.com/sdk-for-go/api/service/sts/ | ||
56 | // | ||
57 | // Using the Client | ||
58 | // | ||
59 | // To use the client for AWS Security Token Service you will first need | ||
60 | // to create a new instance of it. | ||
61 | // | ||
62 | // When creating a client for an AWS service you'll first need to have a Session | ||
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/ | ||
81 | // | ||
82 | // See aws package's Config type for more information on configuration options. | ||
83 | // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config | ||
84 | // | ||
85 | // See the AWS Security Token Service client STS for more | ||
86 | // information on creating the service's client. | ||
87 | // 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 | ||