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 | 76 |
1 files changed, 56 insertions, 20 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 ef681ab..fcb720d 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 | |||
| @@ -7,22 +7,14 @@ | |||
| 7 | // request temporary, limited-privilege credentials for AWS Identity and Access | 7 | // request temporary, limited-privilege credentials for AWS Identity and Access |
| 8 | // Management (IAM) users or for users that you authenticate (federated users). | 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 | 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). | 10 | // about using this service, go to Temporary Security Credentials (https://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 | // | 11 | // |
| 20 | // For information about setting up signatures and authorization through the | 12 | // 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) | 13 | // API, go to Signing AWS API Requests (https://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, | 14 | // 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) | 15 | // go to Making Query Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) |
| 24 | // in Using IAM. For information about using security tokens with other AWS | 16 | // 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) | 17 | // products, go to AWS Services That Work with IAM (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) |
| 26 | // in the IAM User Guide. | 18 | // in the IAM User Guide. |
| 27 | // | 19 | // |
| 28 | // If you're new to AWS and need additional technical information about a specific | 20 | // If you're new to AWS and need additional technical information about a specific |
| @@ -31,14 +23,38 @@ | |||
| 31 | // | 23 | // |
| 32 | // Endpoints | 24 | // Endpoints |
| 33 | // | 25 | // |
| 34 | // The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com | 26 | // By default, AWS Security Token Service (STS) is available as a global service, |
| 35 | // that maps to the US East (N. Virginia) region. Additional regions are available | 27 | // and all AWS STS requests go to a single endpoint at https://sts.amazonaws.com. |
| 36 | // and are activated by default. For more information, see Activating and Deactivating | 28 | // Global requests map to the US East (N. Virginia) region. AWS recommends using |
| 37 | // AWS STS in an AWS Region (http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) | 29 | // Regional AWS STS endpoints instead of the global endpoint to reduce latency, |
| 30 | // build in redundancy, and increase session token validity. For more information, | ||
| 31 | // see Managing AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) | ||
| 32 | // in the IAM User Guide. | ||
| 33 | // | ||
| 34 | // Most AWS Regions are enabled for operations in all AWS services by default. | ||
| 35 | // Those Regions are automatically activated for use with AWS STS. Some Regions, | ||
| 36 | // such as Asia Pacific (Hong Kong), must be manually enabled. To learn more | ||
| 37 | // about enabling and disabling AWS Regions, see Managing AWS Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) | ||
| 38 | // in the AWS General Reference. When you enable these AWS Regions, they are | ||
| 39 | // automatically activated for use with AWS STS. You cannot activate the STS | ||
| 40 | // endpoint for a Region that is disabled. Tokens that are valid in all AWS | ||
| 41 | // Regions are longer than tokens that are valid in Regions that are enabled | ||
| 42 | // by default. Changing this setting might affect existing systems where you | ||
| 43 | // temporarily store tokens. For more information, see Managing Global Endpoint | ||
| 44 | // Session Tokens (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html#sts-regions-manage-tokens) | ||
| 38 | // in the IAM User Guide. | 45 | // in the IAM User Guide. |
| 39 | // | 46 | // |
| 40 | // For information about STS endpoints, see Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#sts_region) | 47 | // After you activate a Region for use with AWS STS, you can direct AWS STS |
| 41 | // in the AWS General Reference. | 48 | // API calls to that Region. AWS STS recommends that you provide both the Region |
| 49 | // and endpoint when you make calls to a Regional endpoint. You can provide | ||
| 50 | // the Region alone for manually enabled Regions, such as Asia Pacific (Hong | ||
| 51 | // Kong). In this case, the calls are directed to the STS Regional endpoint. | ||
| 52 | // However, if you provide the Region alone for Regions enabled by default, | ||
| 53 | // the calls are directed to the global endpoint of https://sts.amazonaws.com. | ||
| 54 | // | ||
| 55 | // To view the list of AWS STS endpoints and whether they are active by default, | ||
| 56 | // see Writing Code to Use AWS STS Regions (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html#id_credentials_temp_enable-regions_writing_code) | ||
| 57 | // in the IAM User Guide. | ||
| 42 | // | 58 | // |
| 43 | // Recording API requests | 59 | // Recording API requests |
| 44 | // | 60 | // |
| @@ -46,8 +62,28 @@ | |||
| 46 | // your AWS account and delivers log files to an Amazon S3 bucket. By using | 62 | // 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 | 63 | // 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 | 64 | // 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 | 65 | // on. |
| 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). | 66 | // |
| 67 | // If you activate AWS STS endpoints in Regions other than the default global | ||
| 68 | // endpoint, then you must also turn on CloudTrail logging in those Regions. | ||
| 69 | // This is necessary to record any AWS STS API calls that are made in those | ||
| 70 | // Regions. For more information, see Turning On CloudTrail in Additional Regions | ||
| 71 | // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/aggregating_logs_regions_turn_on_ct.html) | ||
| 72 | // in the AWS CloudTrail User Guide. | ||
| 73 | // | ||
| 74 | // AWS Security Token Service (STS) is a global service with a single endpoint | ||
| 75 | // at https://sts.amazonaws.com. Calls to this endpoint are logged as calls | ||
| 76 | // to a global service. However, because this endpoint is physically located | ||
| 77 | // in the US East (N. Virginia) Region, your logs list us-east-1 as the event | ||
| 78 | // Region. CloudTrail does not write these logs to the US East (Ohio) Region | ||
| 79 | // unless you choose to include global service logs in that Region. CloudTrail | ||
| 80 | // writes calls to all Regional endpoints to their respective Regions. For example, | ||
| 81 | // calls to sts.us-east-2.amazonaws.com are published to the US East (Ohio) | ||
| 82 | // Region and calls to sts.eu-central-1.amazonaws.com are published to the EU | ||
| 83 | // (Frankfurt) Region. | ||
| 84 | // | ||
| 85 | // To learn more about CloudTrail, including how to turn it on and find your | ||
| 86 | // log files, see the AWS CloudTrail User Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html). | ||
| 51 | // | 87 | // |
| 52 | // See https://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15 for more information on this service. | 88 | // See https://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15 for more information on this service. |
| 53 | // | 89 | // |