aws-sdk-core 3.170.1 → 3.240.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +855 -0
- data/VERSION +1 -1
- data/lib/aws-defaults/default_configuration.rb +4 -4
- data/lib/aws-defaults.rb +4 -1
- data/lib/aws-sdk-core/arn.rb +1 -3
- data/lib/aws-sdk-core/assume_role_credentials.rb +21 -13
- data/lib/aws-sdk-core/assume_role_web_identity_credentials.rb +16 -9
- data/lib/aws-sdk-core/binary/decode_handler.rb +3 -9
- data/lib/aws-sdk-core/binary/encode_handler.rb +1 -1
- data/lib/aws-sdk-core/binary/event_builder.rb +34 -37
- data/lib/aws-sdk-core/binary/event_stream_decoder.rb +1 -0
- data/lib/aws-sdk-core/binary/event_stream_encoder.rb +4 -3
- data/lib/aws-sdk-core/cbor/decoder.rb +308 -0
- data/lib/aws-sdk-core/cbor/encoder.rb +243 -0
- data/lib/aws-sdk-core/cbor.rb +53 -0
- data/lib/aws-sdk-core/client_side_monitoring.rb +9 -0
- data/lib/aws-sdk-core/client_stubs.rb +39 -55
- data/lib/aws-sdk-core/credential_provider.rb +8 -1
- data/lib/aws-sdk-core/credential_provider_chain.rb +103 -26
- data/lib/aws-sdk-core/credentials.rb +19 -6
- data/lib/aws-sdk-core/ec2_metadata.rb +1 -1
- data/lib/aws-sdk-core/ecs_credentials.rb +186 -60
- data/lib/aws-sdk-core/endpoints/endpoint.rb +3 -1
- data/lib/aws-sdk-core/endpoints/matchers.rb +21 -19
- data/lib/aws-sdk-core/endpoints.rb +106 -22
- data/lib/aws-sdk-core/error_handler.rb +46 -0
- data/lib/aws-sdk-core/errors.rb +17 -5
- data/lib/aws-sdk-core/event_emitter.rb +1 -17
- data/lib/aws-sdk-core/ini_parser.rb +7 -0
- data/lib/aws-sdk-core/instance_profile_credentials.rb +168 -155
- data/lib/aws-sdk-core/json/builder.rb +8 -1
- data/lib/aws-sdk-core/json/error_handler.rb +41 -15
- data/lib/aws-sdk-core/json/handler.rb +13 -6
- data/lib/aws-sdk-core/json/json_engine.rb +3 -1
- data/lib/aws-sdk-core/json/oj_engine.rb +7 -1
- data/lib/aws-sdk-core/json/parser.rb +33 -3
- data/lib/aws-sdk-core/json.rb +43 -14
- data/lib/aws-sdk-core/log/formatter.rb +6 -0
- data/lib/aws-sdk-core/log/param_filter.rb +2 -2
- data/lib/aws-sdk-core/log/param_formatter.rb +7 -3
- data/lib/aws-sdk-core/log.rb +10 -0
- data/lib/aws-sdk-core/login_credentials.rb +229 -0
- data/lib/aws-sdk-core/lru_cache.rb +75 -0
- data/lib/aws-sdk-core/pageable_response.rb +3 -1
- data/lib/aws-sdk-core/param_validator.rb +9 -4
- data/lib/aws-sdk-core/plugins/bearer_authorization.rb +2 -0
- data/lib/aws-sdk-core/plugins/checksum_algorithm.rb +348 -169
- data/lib/aws-sdk-core/plugins/client_metrics_plugin.rb +1 -1
- data/lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb +14 -2
- data/lib/aws-sdk-core/plugins/credentials_configuration.rb +78 -56
- data/lib/aws-sdk-core/plugins/endpoint_pattern.rb +40 -32
- data/lib/aws-sdk-core/plugins/global_configuration.rb +8 -9
- data/lib/aws-sdk-core/plugins/http_checksum.rb +3 -8
- data/lib/aws-sdk-core/plugins/invocation_id.rb +1 -11
- data/lib/aws-sdk-core/plugins/logging.rb +2 -0
- data/lib/aws-sdk-core/plugins/protocols/api_gateway.rb +3 -1
- data/lib/aws-sdk-core/plugins/protocols/ec2.rb +2 -24
- data/lib/aws-sdk-core/plugins/protocols/json_rpc.rb +6 -8
- data/lib/aws-sdk-core/plugins/protocols/query.rb +4 -2
- data/lib/aws-sdk-core/plugins/protocols/rest_json.rb +3 -15
- data/lib/aws-sdk-core/plugins/protocols/rest_xml.rb +3 -0
- data/lib/aws-sdk-core/plugins/protocols/rpc_v2.rb +17 -0
- data/lib/aws-sdk-core/plugins/regional_endpoint.rb +162 -37
- data/lib/aws-sdk-core/plugins/request_compression.rb +226 -0
- data/lib/aws-sdk-core/plugins/retry_errors.rb +12 -3
- data/lib/aws-sdk-core/plugins/sign.rb +55 -33
- data/lib/aws-sdk-core/plugins/signature_v2.rb +2 -1
- data/lib/aws-sdk-core/plugins/signature_v4.rb +2 -1
- data/lib/aws-sdk-core/plugins/stub_responses.rb +59 -9
- data/lib/aws-sdk-core/plugins/telemetry.rb +75 -0
- data/lib/aws-sdk-core/plugins/transfer_encoding.rb +16 -9
- data/lib/aws-sdk-core/plugins/user_agent.rb +194 -14
- data/lib/aws-sdk-core/plugins.rb +39 -0
- data/lib/aws-sdk-core/process_credentials.rb +48 -29
- data/lib/aws-sdk-core/query/ec2_handler.rb +27 -0
- data/lib/aws-sdk-core/query/ec2_param_builder.rb +5 -7
- data/lib/aws-sdk-core/query/handler.rb +4 -4
- data/lib/aws-sdk-core/query/param_builder.rb +2 -2
- data/lib/aws-sdk-core/query.rb +2 -1
- data/lib/aws-sdk-core/refreshing_credentials.rb +20 -23
- data/lib/aws-sdk-core/resources.rb +8 -0
- data/lib/aws-sdk-core/rest/content_type_handler.rb +60 -0
- data/lib/aws-sdk-core/rest/handler.rb +3 -4
- data/lib/aws-sdk-core/rest/request/body.rb +32 -5
- data/lib/aws-sdk-core/rest/request/endpoint.rb +24 -4
- data/lib/aws-sdk-core/rest/request/headers.rb +15 -7
- data/lib/aws-sdk-core/rest/request/querystring_builder.rb +62 -36
- data/lib/aws-sdk-core/rest/response/body.rb +15 -1
- data/lib/aws-sdk-core/rest/response/header_list_parser.rb +79 -0
- data/lib/aws-sdk-core/rest/response/headers.rb +8 -3
- data/lib/aws-sdk-core/rest.rb +1 -0
- data/lib/aws-sdk-core/rpc_v2/builder.rb +62 -0
- data/lib/aws-sdk-core/rpc_v2/cbor_engine.rb +18 -0
- data/lib/aws-sdk-core/rpc_v2/content_type_handler.rb +47 -0
- data/lib/aws-sdk-core/rpc_v2/error_handler.rb +95 -0
- data/lib/aws-sdk-core/rpc_v2/handler.rb +79 -0
- data/lib/aws-sdk-core/rpc_v2/parser.rb +98 -0
- data/lib/aws-sdk-core/rpc_v2.rb +69 -0
- data/lib/aws-sdk-core/shared_config.rb +155 -39
- data/lib/aws-sdk-core/shared_credentials.rb +1 -7
- data/lib/aws-sdk-core/sso_credentials.rb +6 -3
- data/lib/aws-sdk-core/static_token_provider.rb +1 -2
- data/lib/aws-sdk-core/stubbing/protocols/ec2.rb +12 -11
- data/lib/aws-sdk-core/stubbing/protocols/json.rb +11 -10
- data/lib/aws-sdk-core/stubbing/protocols/query.rb +7 -6
- data/lib/aws-sdk-core/stubbing/protocols/rest.rb +2 -1
- data/lib/aws-sdk-core/stubbing/protocols/rest_json.rb +9 -8
- data/lib/aws-sdk-core/stubbing/protocols/rest_xml.rb +6 -5
- data/lib/aws-sdk-core/stubbing/protocols/rpc_v2.rb +39 -0
- data/lib/aws-sdk-core/stubbing/stub_data.rb +11 -0
- data/lib/aws-sdk-core/stubbing.rb +22 -0
- data/lib/aws-sdk-core/telemetry/base.rb +177 -0
- data/lib/aws-sdk-core/telemetry/no_op.rb +70 -0
- data/lib/aws-sdk-core/telemetry/otel.rb +235 -0
- data/lib/aws-sdk-core/telemetry/span_kind.rb +22 -0
- data/lib/aws-sdk-core/telemetry/span_status.rb +59 -0
- data/lib/aws-sdk-core/telemetry.rb +78 -0
- data/lib/aws-sdk-core/token.rb +3 -3
- data/lib/aws-sdk-core/token_provider.rb +4 -0
- data/lib/aws-sdk-core/token_provider_chain.rb +2 -6
- data/lib/aws-sdk-core/util.rb +41 -1
- data/lib/aws-sdk-core/waiters/poller.rb +12 -5
- data/lib/aws-sdk-core/xml/builder.rb +17 -9
- data/lib/aws-sdk-core/xml/error_handler.rb +35 -43
- data/lib/aws-sdk-core/xml/parser/frame.rb +4 -20
- data/lib/aws-sdk-core/xml/parser/stack.rb +2 -0
- data/lib/aws-sdk-core/xml/parser.rb +2 -6
- data/lib/aws-sdk-core.rb +86 -107
- data/lib/aws-sdk-signin/client.rb +604 -0
- data/lib/aws-sdk-signin/client_api.rb +119 -0
- data/lib/aws-sdk-signin/customizations.rb +1 -0
- data/lib/aws-sdk-signin/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-signin/endpoint_provider.rb +59 -0
- data/lib/aws-sdk-signin/endpoints.rb +20 -0
- data/lib/aws-sdk-signin/errors.rb +122 -0
- data/lib/aws-sdk-signin/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-signin/resource.rb +26 -0
- data/lib/aws-sdk-signin/types.rb +299 -0
- data/lib/aws-sdk-signin.rb +63 -0
- data/lib/aws-sdk-sso/client.rb +205 -92
- data/lib/aws-sdk-sso/client_api.rb +7 -0
- data/lib/aws-sdk-sso/endpoint_parameters.rb +13 -10
- data/lib/aws-sdk-sso/endpoint_provider.rb +30 -28
- data/lib/aws-sdk-sso/endpoints.rb +3 -54
- data/lib/aws-sdk-sso/plugins/endpoints.rb +23 -22
- data/lib/aws-sdk-sso/types.rb +1 -0
- data/lib/aws-sdk-sso.rb +15 -11
- data/lib/aws-sdk-ssooidc/client.rb +625 -125
- data/lib/aws-sdk-ssooidc/client_api.rb +94 -1
- data/lib/aws-sdk-ssooidc/endpoint_parameters.rb +13 -10
- data/lib/aws-sdk-ssooidc/endpoint_provider.rb +30 -28
- data/lib/aws-sdk-ssooidc/endpoints.rb +3 -40
- data/lib/aws-sdk-ssooidc/errors.rb +62 -0
- data/lib/aws-sdk-ssooidc/plugins/endpoints.rb +23 -20
- data/lib/aws-sdk-ssooidc/types.rb +419 -53
- data/lib/aws-sdk-ssooidc.rb +15 -11
- data/lib/aws-sdk-sts/client.rb +656 -249
- data/lib/aws-sdk-sts/client_api.rb +120 -9
- data/lib/aws-sdk-sts/customizations.rb +5 -2
- data/lib/aws-sdk-sts/endpoint_parameters.rb +15 -14
- data/lib/aws-sdk-sts/endpoint_provider.rb +82 -84
- data/lib/aws-sdk-sts/endpoints.rb +3 -118
- data/lib/aws-sdk-sts/errors.rb +79 -0
- data/lib/aws-sdk-sts/plugins/endpoints.rb +23 -30
- data/lib/aws-sdk-sts/presigner.rb +3 -7
- data/lib/aws-sdk-sts/types.rb +390 -40
- data/lib/aws-sdk-sts.rb +15 -11
- data/lib/seahorse/client/async_base.rb +4 -5
- data/lib/seahorse/client/async_response.rb +19 -0
- data/lib/seahorse/client/base.rb +18 -21
- data/lib/seahorse/client/configuration.rb +0 -4
- data/lib/seahorse/client/h2/connection.rb +18 -28
- data/lib/seahorse/client/h2/handler.rb +19 -3
- data/lib/seahorse/client/handler.rb +1 -1
- data/lib/seahorse/client/http/response.rb +1 -1
- data/lib/seahorse/client/net_http/connection_pool.rb +15 -12
- data/lib/seahorse/client/net_http/handler.rb +21 -9
- data/lib/seahorse/client/net_http/patches.rb +1 -4
- data/lib/seahorse/client/networking_error.rb +1 -1
- data/lib/seahorse/client/plugin.rb +9 -0
- data/lib/seahorse/client/plugins/endpoint.rb +0 -1
- data/lib/seahorse/client/plugins/h2.rb +4 -4
- data/lib/seahorse/client/plugins/net_http.rb +57 -16
- data/lib/seahorse/client/plugins/request_callback.rb +31 -0
- data/lib/seahorse/client/request_context.rb +9 -2
- data/lib/seahorse/client/response.rb +8 -0
- data/lib/seahorse/model/operation.rb +3 -0
- data/lib/seahorse/model/shapes.rb +2 -2
- data/lib/seahorse/util.rb +2 -1
- data/sig/aws-sdk-core/async_client_stubs.rbs +21 -0
- data/sig/aws-sdk-core/client_stubs.rbs +10 -0
- data/sig/aws-sdk-core/errors.rbs +22 -0
- data/sig/aws-sdk-core/resources/collection.rbs +21 -0
- data/sig/aws-sdk-core/structure.rbs +4 -0
- data/sig/aws-sdk-core/telemetry/base.rbs +46 -0
- data/sig/aws-sdk-core/telemetry/otel.rbs +22 -0
- data/sig/aws-sdk-core/telemetry/span_kind.rbs +15 -0
- data/sig/aws-sdk-core/telemetry/span_status.rbs +24 -0
- data/sig/aws-sdk-core/waiters/errors.rbs +20 -0
- data/sig/aws-sdk-core.rbs +7 -0
- data/sig/seahorse/client/async_base.rbs +18 -0
- data/sig/seahorse/client/base.rbs +25 -0
- data/sig/seahorse/client/handler_builder.rbs +16 -0
- data/sig/seahorse/client/response.rbs +61 -0
- metadata +118 -23
- /data/lib/aws-sdk-core/xml/parser/{engines/libxml.rb → libxml_engine.rb} +0 -0
- /data/lib/aws-sdk-core/xml/parser/{engines/nokogiri.rb → nokogiri_engine.rb} +0 -0
- /data/lib/aws-sdk-core/xml/parser/{engines/oga.rb → oga_engine.rb} +0 -0
- /data/lib/aws-sdk-core/xml/parser/{engines/ox.rb → ox_engine.rb} +0 -0
- /data/lib/aws-sdk-core/xml/parser/{engines/rexml.rb → rexml_engine.rb} +0 -0
data/lib/aws-sdk-sts/client.rb
CHANGED
|
@@ -7,34 +7,35 @@
|
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
10
|
-
require 'seahorse/client/plugins/content_length
|
|
11
|
-
require 'aws-sdk-core/plugins/credentials_configuration
|
|
12
|
-
require 'aws-sdk-core/plugins/logging
|
|
13
|
-
require 'aws-sdk-core/plugins/param_converter
|
|
14
|
-
require 'aws-sdk-core/plugins/param_validator
|
|
15
|
-
require 'aws-sdk-core/plugins/user_agent
|
|
16
|
-
require 'aws-sdk-core/plugins/helpful_socket_errors
|
|
17
|
-
require 'aws-sdk-core/plugins/retry_errors
|
|
18
|
-
require 'aws-sdk-core/plugins/global_configuration
|
|
19
|
-
require 'aws-sdk-core/plugins/regional_endpoint
|
|
20
|
-
require 'aws-sdk-core/plugins/endpoint_discovery
|
|
21
|
-
require 'aws-sdk-core/plugins/endpoint_pattern
|
|
22
|
-
require 'aws-sdk-core/plugins/response_paging
|
|
23
|
-
require 'aws-sdk-core/plugins/stub_responses
|
|
24
|
-
require 'aws-sdk-core/plugins/idempotency_token
|
|
25
|
-
require 'aws-sdk-core/plugins/
|
|
26
|
-
require 'aws-sdk-core/plugins/
|
|
27
|
-
require 'aws-sdk-core/plugins/
|
|
28
|
-
require 'aws-sdk-core/plugins/
|
|
29
|
-
require 'aws-sdk-core/plugins/
|
|
30
|
-
require 'aws-sdk-core/plugins/
|
|
31
|
-
require 'aws-sdk-core/plugins/
|
|
32
|
-
require 'aws-sdk-core/plugins/
|
|
33
|
-
require 'aws-sdk-core/plugins/
|
|
34
|
-
require 'aws-sdk-core/plugins/
|
|
35
|
-
require 'aws-sdk-
|
|
36
|
-
|
|
37
|
-
|
|
10
|
+
require 'seahorse/client/plugins/content_length'
|
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
|
37
|
+
require 'aws-sdk-core/plugins/protocols/query'
|
|
38
|
+
require 'aws-sdk-sts/plugins/sts_regional_endpoints'
|
|
38
39
|
|
|
39
40
|
module Aws::STS
|
|
40
41
|
# An API client for STS. To construct a client, you need to configure a `:region` and `:credentials`.
|
|
@@ -72,14 +73,17 @@ module Aws::STS
|
|
|
72
73
|
add_plugin(Aws::Plugins::ResponsePaging)
|
|
73
74
|
add_plugin(Aws::Plugins::StubResponses)
|
|
74
75
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
76
|
+
add_plugin(Aws::Plugins::InvocationId)
|
|
75
77
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
76
78
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
|
77
79
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
78
80
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
79
81
|
add_plugin(Aws::Plugins::HttpChecksum)
|
|
80
82
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
|
83
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
|
81
84
|
add_plugin(Aws::Plugins::DefaultsMode)
|
|
82
85
|
add_plugin(Aws::Plugins::RecursionDetection)
|
|
86
|
+
add_plugin(Aws::Plugins::Telemetry)
|
|
83
87
|
add_plugin(Aws::Plugins::Sign)
|
|
84
88
|
add_plugin(Aws::Plugins::Protocols::Query)
|
|
85
89
|
add_plugin(Aws::STS::Plugins::STSRegionalEndpoints)
|
|
@@ -87,9 +91,14 @@ module Aws::STS
|
|
|
87
91
|
|
|
88
92
|
# @overload initialize(options)
|
|
89
93
|
# @param [Hash] options
|
|
94
|
+
#
|
|
95
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
|
96
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
|
97
|
+
# class name or an instance of a plugin class.
|
|
98
|
+
#
|
|
90
99
|
# @option options [required, Aws::CredentialProvider] :credentials
|
|
91
|
-
# Your AWS credentials. This can be
|
|
92
|
-
# following classes:
|
|
100
|
+
# Your AWS credentials used for authentication. This can be any class that includes and implements
|
|
101
|
+
# `Aws::CredentialProvider`, or instance of any one of the following classes:
|
|
93
102
|
#
|
|
94
103
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
95
104
|
# credentials.
|
|
@@ -117,20 +126,24 @@ module Aws::STS
|
|
|
117
126
|
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
|
118
127
|
# from the Cognito Identity service.
|
|
119
128
|
#
|
|
120
|
-
# When `:credentials` are not configured directly, the following
|
|
121
|
-
# locations will be searched for credentials:
|
|
129
|
+
# When `:credentials` are not configured directly, the following locations will be searched for credentials:
|
|
122
130
|
#
|
|
123
131
|
# * `Aws.config[:credentials]`
|
|
124
|
-
#
|
|
125
|
-
# *
|
|
132
|
+
#
|
|
133
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
|
134
|
+
# `:account_id` options.
|
|
135
|
+
#
|
|
136
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
|
137
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
|
138
|
+
#
|
|
126
139
|
# * `~/.aws/credentials`
|
|
140
|
+
#
|
|
127
141
|
# * `~/.aws/config`
|
|
128
|
-
#
|
|
129
|
-
#
|
|
130
|
-
# `Aws::
|
|
131
|
-
# enable retries and extended timeouts. Instance profile credential
|
|
132
|
-
#
|
|
133
|
-
# to true.
|
|
142
|
+
#
|
|
143
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
|
144
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
|
145
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
|
146
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
|
134
147
|
#
|
|
135
148
|
# @option options [required, String] :region
|
|
136
149
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -146,6 +159,8 @@ module Aws::STS
|
|
|
146
159
|
#
|
|
147
160
|
# @option options [String] :access_key_id
|
|
148
161
|
#
|
|
162
|
+
# @option options [String] :account_id
|
|
163
|
+
#
|
|
149
164
|
# @option options [Boolean] :active_endpoint_cache (false)
|
|
150
165
|
# When set to `true`, a thread polling for endpoints will be running in
|
|
151
166
|
# the background every 60 secs (default). Defaults to `false`.
|
|
@@ -156,6 +171,11 @@ module Aws::STS
|
|
|
156
171
|
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
|
157
172
|
# not retry instead of sleeping.
|
|
158
173
|
#
|
|
174
|
+
# @option options [Array<String>] :auth_scheme_preference
|
|
175
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
|
176
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
|
177
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
|
178
|
+
#
|
|
159
179
|
# @option options [Boolean] :client_side_monitoring (false)
|
|
160
180
|
# When `true`, client-side metrics will be collected for all API requests from
|
|
161
181
|
# this client.
|
|
@@ -189,13 +209,22 @@ module Aws::STS
|
|
|
189
209
|
# accepted modes and the configuration defaults that are included.
|
|
190
210
|
#
|
|
191
211
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
192
|
-
#
|
|
193
|
-
#
|
|
212
|
+
# When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
|
|
213
|
+
#
|
|
214
|
+
# @option options [Boolean] :disable_request_compression (false)
|
|
215
|
+
# When set to 'true' the request body will not be compressed
|
|
216
|
+
# for supported operations.
|
|
217
|
+
#
|
|
218
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
|
219
|
+
# Normally you should not configure the `:endpoint` option
|
|
220
|
+
# directly. This is normally constructed from the `:region`
|
|
221
|
+
# option. Configuring `:endpoint` is normally reserved for
|
|
222
|
+
# connecting to test or custom endpoints. The endpoint should
|
|
223
|
+
# be a URI formatted like:
|
|
194
224
|
#
|
|
195
|
-
#
|
|
196
|
-
#
|
|
197
|
-
#
|
|
198
|
-
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
|
225
|
+
# 'http://example.com'
|
|
226
|
+
# 'https://example.com'
|
|
227
|
+
# 'http://example.com:123'
|
|
199
228
|
#
|
|
200
229
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
|
201
230
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
|
@@ -212,6 +241,10 @@ module Aws::STS
|
|
|
212
241
|
# @option options [Boolean] :endpoint_discovery (false)
|
|
213
242
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
214
243
|
#
|
|
244
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
|
245
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
|
246
|
+
# variables and the shared configuration file.
|
|
247
|
+
#
|
|
215
248
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
216
249
|
# The log formatter.
|
|
217
250
|
#
|
|
@@ -229,8 +262,36 @@ module Aws::STS
|
|
|
229
262
|
# 4 times. Used in `standard` and `adaptive` retry modes.
|
|
230
263
|
#
|
|
231
264
|
# @option options [String] :profile ("default")
|
|
232
|
-
# Used when loading credentials from the shared credentials file
|
|
233
|
-
#
|
|
265
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
|
266
|
+
# When not specified, 'default' is used.
|
|
267
|
+
#
|
|
268
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
|
269
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
|
270
|
+
#
|
|
271
|
+
# * `when_supported` - (default) When set, a checksum will be
|
|
272
|
+
# calculated for all request payloads of operations modeled with the
|
|
273
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
|
274
|
+
# `requestAlgorithmMember` is modeled.
|
|
275
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
|
276
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
|
277
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
|
278
|
+
# is modeled and supplied.
|
|
279
|
+
#
|
|
280
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
|
281
|
+
# The minimum size in bytes that triggers compression for request
|
|
282
|
+
# bodies. The value must be non-negative integer value between 0
|
|
283
|
+
# and 10485780 bytes inclusive.
|
|
284
|
+
#
|
|
285
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
|
286
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
|
287
|
+
#
|
|
288
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
|
289
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
|
290
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
|
291
|
+
# are supported.
|
|
292
|
+
# * `when_required` - When set, checksum validation is not performed on
|
|
293
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
|
294
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
|
234
295
|
#
|
|
235
296
|
# @option options [Proc] :retry_backoff
|
|
236
297
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
|
@@ -276,11 +337,25 @@ module Aws::STS
|
|
|
276
337
|
# throttling. This is a provisional mode that may change behavior
|
|
277
338
|
# in the future.
|
|
278
339
|
#
|
|
340
|
+
# @option options [String] :sdk_ua_app_id
|
|
341
|
+
# A unique and opaque application ID that is appended to the
|
|
342
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
|
343
|
+
# maximum length of 50. This variable is sourced from environment
|
|
344
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
|
279
345
|
#
|
|
280
346
|
# @option options [String] :secret_access_key
|
|
281
347
|
#
|
|
282
348
|
# @option options [String] :session_token
|
|
283
349
|
#
|
|
350
|
+
# @option options [Array] :sigv4a_signing_region_set
|
|
351
|
+
# A list of regions that should be signed with SigV4a signing. When
|
|
352
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
|
353
|
+
# in the following locations:
|
|
354
|
+
#
|
|
355
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
|
356
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
|
357
|
+
# * `~/.aws/config`
|
|
358
|
+
#
|
|
284
359
|
# @option options [String] :sts_regional_endpoints ("regional")
|
|
285
360
|
# Passing in 'regional' to enable regional endpoint for STS for all supported
|
|
286
361
|
# regions (except 'aws-global'). Using 'legacy' mode will force all legacy
|
|
@@ -295,9 +370,19 @@ module Aws::STS
|
|
|
295
370
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
296
371
|
# requests are made, and retries are disabled.
|
|
297
372
|
#
|
|
373
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
|
374
|
+
# Allows you to provide a telemetry provider, which is used to
|
|
375
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
|
376
|
+
# will not record or emit any telemetry data. The SDK supports the
|
|
377
|
+
# following telemetry providers:
|
|
378
|
+
#
|
|
379
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
|
380
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
|
381
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
|
382
|
+
#
|
|
298
383
|
# @option options [Aws::TokenProvider] :token_provider
|
|
299
|
-
#
|
|
300
|
-
# following classes:
|
|
384
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
|
385
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
|
301
386
|
#
|
|
302
387
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
|
303
388
|
# tokens.
|
|
@@ -322,52 +407,75 @@ module Aws::STS
|
|
|
322
407
|
# sending the request.
|
|
323
408
|
#
|
|
324
409
|
# @option options [Aws::STS::EndpointProvider] :endpoint_provider
|
|
325
|
-
# The endpoint provider used to resolve endpoints. Any object that responds to
|
|
326
|
-
#
|
|
327
|
-
#
|
|
328
|
-
#
|
|
329
|
-
#
|
|
330
|
-
#
|
|
331
|
-
#
|
|
332
|
-
# `
|
|
333
|
-
#
|
|
334
|
-
#
|
|
335
|
-
#
|
|
336
|
-
#
|
|
337
|
-
#
|
|
338
|
-
#
|
|
339
|
-
#
|
|
340
|
-
#
|
|
341
|
-
#
|
|
342
|
-
#
|
|
343
|
-
#
|
|
344
|
-
#
|
|
345
|
-
#
|
|
346
|
-
#
|
|
347
|
-
#
|
|
348
|
-
#
|
|
410
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
|
411
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
|
412
|
+
# `Aws::STS::EndpointParameters`.
|
|
413
|
+
#
|
|
414
|
+
# @option options [Float] :http_continue_timeout (1)
|
|
415
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
|
416
|
+
# request body. This option has no effect unless the request has "Expect"
|
|
417
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
|
418
|
+
# behaviour. This value can safely be set per request on the session.
|
|
419
|
+
#
|
|
420
|
+
# @option options [Float] :http_idle_timeout (5)
|
|
421
|
+
# The number of seconds a connection is allowed to sit idle before it
|
|
422
|
+
# is considered stale. Stale connections are closed and removed from the
|
|
423
|
+
# pool before making a request.
|
|
424
|
+
#
|
|
425
|
+
# @option options [Float] :http_open_timeout (15)
|
|
426
|
+
# The default number of seconds to wait for response data.
|
|
427
|
+
# This value can safely be set per-request on the session.
|
|
428
|
+
#
|
|
429
|
+
# @option options [URI::HTTP,String] :http_proxy
|
|
430
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
|
431
|
+
#
|
|
432
|
+
# @option options [Float] :http_read_timeout (60)
|
|
433
|
+
# The default number of seconds to wait for response data.
|
|
434
|
+
# This value can safely be set per-request on the session.
|
|
435
|
+
#
|
|
436
|
+
# @option options [Boolean] :http_wire_trace (false)
|
|
437
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
|
438
|
+
#
|
|
439
|
+
# @option options [Proc] :on_chunk_received
|
|
440
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
441
|
+
# of the response body is received. It provides three arguments: the chunk,
|
|
442
|
+
# the number of bytes received, and the total number of
|
|
443
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
|
444
|
+
#
|
|
445
|
+
# @option options [Proc] :on_chunk_sent
|
|
446
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
447
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
|
448
|
+
# the number of bytes read from the body, and the total number of
|
|
449
|
+
# bytes in the body.
|
|
450
|
+
#
|
|
451
|
+
# @option options [Boolean] :raise_response_errors (true)
|
|
452
|
+
# When `true`, response errors are raised.
|
|
453
|
+
#
|
|
454
|
+
# @option options [String] :ssl_ca_bundle
|
|
455
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
|
456
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
|
457
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
|
458
|
+
#
|
|
459
|
+
# @option options [String] :ssl_ca_directory
|
|
460
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
|
461
|
+
# authority files for verifying peer certificates. If you do
|
|
462
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
|
463
|
+
# default will be used if available.
|
|
349
464
|
#
|
|
350
|
-
# @option options [
|
|
351
|
-
#
|
|
465
|
+
# @option options [String] :ssl_ca_store
|
|
466
|
+
# Sets the X509::Store to verify peer certificate.
|
|
352
467
|
#
|
|
353
|
-
# @option options [
|
|
354
|
-
#
|
|
468
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
|
469
|
+
# Sets a client certificate when creating http connections.
|
|
355
470
|
#
|
|
356
|
-
# @option options [
|
|
357
|
-
#
|
|
358
|
-
# connection.
|
|
471
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
|
472
|
+
# Sets a client key when creating http connections.
|
|
359
473
|
#
|
|
360
|
-
# @option options [
|
|
361
|
-
#
|
|
362
|
-
# verifying peer certificates. If you do not pass
|
|
363
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
|
364
|
-
# will be used if available.
|
|
474
|
+
# @option options [Float] :ssl_timeout
|
|
475
|
+
# Sets the SSL timeout in seconds
|
|
365
476
|
#
|
|
366
|
-
# @option options [
|
|
367
|
-
#
|
|
368
|
-
# authority files for verifying peer certificates. If you do
|
|
369
|
-
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
|
370
|
-
# system default will be used if available.
|
|
477
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
|
478
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
|
371
479
|
#
|
|
372
480
|
def initialize(*args)
|
|
373
481
|
super
|
|
@@ -381,8 +489,8 @@ module Aws::STS
|
|
|
381
489
|
# token. Typically, you use `AssumeRole` within your account or for
|
|
382
490
|
# cross-account access. For a comparison of `AssumeRole` with other API
|
|
383
491
|
# operations that produce temporary credentials, see [Requesting
|
|
384
|
-
# Temporary Security Credentials][1] and [
|
|
385
|
-
#
|
|
492
|
+
# Temporary Security Credentials][1] and [Compare STS credentials][2] in
|
|
493
|
+
# the *IAM User Guide*.
|
|
386
494
|
#
|
|
387
495
|
# **Permissions**
|
|
388
496
|
#
|
|
@@ -391,9 +499,9 @@ module Aws::STS
|
|
|
391
499
|
# following exception: You cannot call the Amazon Web Services STS
|
|
392
500
|
# `GetFederationToken` or `GetSessionToken` API operations.
|
|
393
501
|
#
|
|
394
|
-
# (Optional) You can pass inline or managed
|
|
395
|
-
#
|
|
396
|
-
#
|
|
502
|
+
# (Optional) You can pass inline or managed session policies to this
|
|
503
|
+
# operation. You can pass a single JSON policy document to use as an
|
|
504
|
+
# inline session policy. You can also specify up to 10 managed policy
|
|
397
505
|
# Amazon Resource Names (ARNs) to use as managed session policies. The
|
|
398
506
|
# plaintext that you use for both inline and managed session policies
|
|
399
507
|
# can't exceed 2,048 characters. Passing policies to this operation
|
|
@@ -406,10 +514,11 @@ module Aws::STS
|
|
|
406
514
|
# identity-based policy of the role that is being assumed. For more
|
|
407
515
|
# information, see [Session Policies][3] in the *IAM User Guide*.
|
|
408
516
|
#
|
|
409
|
-
# When you create a role, you create two policies:
|
|
410
|
-
# that specifies *who* can assume the role and a permissions policy
|
|
411
|
-
# specifies *what* can be done with the role. You specify the
|
|
412
|
-
# principal
|
|
517
|
+
# When you create a role, you create two policies: a role trust policy
|
|
518
|
+
# that specifies *who* can assume the role, and a permissions policy
|
|
519
|
+
# that specifies *what* can be done with the role. You specify the
|
|
520
|
+
# trusted principal that is allowed to assume the role in the role trust
|
|
521
|
+
# policy.
|
|
413
522
|
#
|
|
414
523
|
# To assume a role from a different account, your Amazon Web Services
|
|
415
524
|
# account must be trusted by the role. The trust relationship is defined
|
|
@@ -418,10 +527,9 @@ module Aws::STS
|
|
|
418
527
|
# users in the account.
|
|
419
528
|
#
|
|
420
529
|
# A user who wants to access a role in a different account must also
|
|
421
|
-
# have permissions that are delegated from the
|
|
422
|
-
#
|
|
423
|
-
#
|
|
424
|
-
# account.
|
|
530
|
+
# have permissions that are delegated from the account administrator.
|
|
531
|
+
# The administrator must attach a policy that allows the user to call
|
|
532
|
+
# `AssumeRole` for the ARN of the role in the other account.
|
|
425
533
|
#
|
|
426
534
|
# To allow a user to assume a role in the same account, you can do
|
|
427
535
|
# either of the following:
|
|
@@ -466,7 +574,7 @@ module Aws::STS
|
|
|
466
574
|
# denied. The condition in a trust policy that tests for MFA
|
|
467
575
|
# authentication might look like the following example.
|
|
468
576
|
#
|
|
469
|
-
# `"Condition":
|
|
577
|
+
# `"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}`
|
|
470
578
|
#
|
|
471
579
|
# For more information, see [Configuring MFA-Protected API Access][8] in
|
|
472
580
|
# the *IAM User Guide* guide.
|
|
@@ -479,7 +587,7 @@ module Aws::STS
|
|
|
479
587
|
#
|
|
480
588
|
#
|
|
481
589
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
|
|
482
|
-
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
590
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html
|
|
483
591
|
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session
|
|
484
592
|
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html
|
|
485
593
|
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html
|
|
@@ -502,10 +610,21 @@ module Aws::STS
|
|
|
502
610
|
# credentials will expose the role session name to the external account
|
|
503
611
|
# in their CloudTrail logs.
|
|
504
612
|
#
|
|
613
|
+
# For security purposes, administrators can view this field in
|
|
614
|
+
# [CloudTrail logs][1] to help identify who performed an action in
|
|
615
|
+
# Amazon Web Services. Your administrator might require that you specify
|
|
616
|
+
# your user name as the session name when you assume the role. For more
|
|
617
|
+
# information, see [ `sts:RoleSessionName` ][2].
|
|
618
|
+
#
|
|
505
619
|
# The regex used to validate this parameter is a string of characters
|
|
506
620
|
# consisting of upper- and lower-case alphanumeric characters with no
|
|
507
621
|
# spaces. You can also include underscores or any of the following
|
|
508
|
-
# characters:
|
|
622
|
+
# characters: +=,.@-
|
|
623
|
+
#
|
|
624
|
+
#
|
|
625
|
+
#
|
|
626
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html#cloudtrail-integration_signin-tempcreds
|
|
627
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_rolesessionname
|
|
509
628
|
#
|
|
510
629
|
# @option params [Array<Types::PolicyDescriptorType>] :policy_arns
|
|
511
630
|
# The Amazon Resource Names (ARNs) of the IAM managed policies that you
|
|
@@ -572,6 +691,9 @@ module Aws::STS
|
|
|
572
691
|
#
|
|
573
692
|
# </note>
|
|
574
693
|
#
|
|
694
|
+
# For more information about role session permissions, see [Session
|
|
695
|
+
# policies][1].
|
|
696
|
+
#
|
|
575
697
|
#
|
|
576
698
|
#
|
|
577
699
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session
|
|
@@ -594,9 +716,8 @@ module Aws::STS
|
|
|
594
716
|
# depending on the maximum session duration setting for your role.
|
|
595
717
|
# However, if you assume a role using role chaining and provide a
|
|
596
718
|
# `DurationSeconds` parameter value greater than one hour, the operation
|
|
597
|
-
# fails. To learn how to view the maximum value for your role, see
|
|
598
|
-
# the
|
|
599
|
-
# Guide*.
|
|
719
|
+
# fails. To learn how to view the maximum value for your role, see
|
|
720
|
+
# [Update the maximum session duration for a role][1].
|
|
600
721
|
#
|
|
601
722
|
# By default, the value is set to `3600` seconds.
|
|
602
723
|
#
|
|
@@ -612,7 +733,7 @@ module Aws::STS
|
|
|
612
733
|
#
|
|
613
734
|
#
|
|
614
735
|
#
|
|
615
|
-
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
736
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_update-role-settings.html#id_roles_update-session-duration
|
|
616
737
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html
|
|
617
738
|
#
|
|
618
739
|
# @option params [Array<Types::Tag>] :tags
|
|
@@ -665,9 +786,8 @@ module Aws::STS
|
|
|
665
786
|
# passes to subsequent sessions in a role chain. For more information,
|
|
666
787
|
# see [Chaining Roles with Session Tags][1] in the *IAM User Guide*.
|
|
667
788
|
#
|
|
668
|
-
# This parameter is optional.
|
|
669
|
-
#
|
|
670
|
-
# affected.
|
|
789
|
+
# This parameter is optional. The transitive status of a session tag
|
|
790
|
+
# does not impact its packed binary size.
|
|
671
791
|
#
|
|
672
792
|
# If you choose not to specify a transitive tag key, then no tags are
|
|
673
793
|
# passed from this session to any subsequent sessions.
|
|
@@ -693,7 +813,7 @@ module Aws::STS
|
|
|
693
813
|
# The regex used to validate this parameter is a string of characters
|
|
694
814
|
# consisting of upper- and lower-case alphanumeric characters with no
|
|
695
815
|
# spaces. You can also include underscores or any of the following
|
|
696
|
-
# characters:
|
|
816
|
+
# characters: +=,.@:\\/-
|
|
697
817
|
#
|
|
698
818
|
#
|
|
699
819
|
#
|
|
@@ -711,7 +831,7 @@ module Aws::STS
|
|
|
711
831
|
# The regex used to validate this parameter is a string of characters
|
|
712
832
|
# consisting of upper- and lower-case alphanumeric characters with no
|
|
713
833
|
# spaces. You can also include underscores or any of the following
|
|
714
|
-
# characters:
|
|
834
|
+
# characters: +=/:,.@-
|
|
715
835
|
#
|
|
716
836
|
# @option params [String] :token_code
|
|
717
837
|
# The value provided by the MFA device, if the trust policy of the role
|
|
@@ -725,26 +845,40 @@ module Aws::STS
|
|
|
725
845
|
#
|
|
726
846
|
# @option params [String] :source_identity
|
|
727
847
|
# The source identity specified by the principal that is calling the
|
|
728
|
-
# `AssumeRole` operation.
|
|
848
|
+
# `AssumeRole` operation. The source identity value persists across
|
|
849
|
+
# [chained role][1] sessions.
|
|
729
850
|
#
|
|
730
851
|
# You can require users to specify a source identity when they assume a
|
|
731
|
-
# role. You do this by using the `sts:SourceIdentity` condition
|
|
732
|
-
# role trust policy. You can use source identity information in
|
|
852
|
+
# role. You do this by using the [ `sts:SourceIdentity` ][2] condition
|
|
853
|
+
# key in a role trust policy. You can use source identity information in
|
|
733
854
|
# CloudTrail logs to determine who took actions with a role. You can use
|
|
734
855
|
# the `aws:SourceIdentity` condition key to further control access to
|
|
735
856
|
# Amazon Web Services resources based on the value of source identity.
|
|
736
857
|
# For more information about using source identity, see [Monitor and
|
|
737
|
-
# control actions taken with assumed roles][
|
|
858
|
+
# control actions taken with assumed roles][3] in the *IAM User Guide*.
|
|
738
859
|
#
|
|
739
860
|
# The regex used to validate this parameter is a string of characters
|
|
740
861
|
# consisting of upper- and lower-case alphanumeric characters with no
|
|
741
862
|
# spaces. You can also include underscores or any of the following
|
|
742
|
-
# characters:
|
|
863
|
+
# characters: +=,.@-. You cannot use a value that begins with the text
|
|
743
864
|
# `aws:`. This prefix is reserved for Amazon Web Services internal use.
|
|
744
865
|
#
|
|
745
866
|
#
|
|
746
867
|
#
|
|
747
|
-
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
868
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html#iam-term-role-chaining
|
|
869
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceidentity
|
|
870
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html
|
|
871
|
+
#
|
|
872
|
+
# @option params [Array<Types::ProvidedContext>] :provided_contexts
|
|
873
|
+
# A list of previously acquired trusted context assertions in the format
|
|
874
|
+
# of a JSON array. The trusted context assertion is signed and encrypted
|
|
875
|
+
# by Amazon Web Services STS.
|
|
876
|
+
#
|
|
877
|
+
# The following is an example of a `ProvidedContext` value that includes
|
|
878
|
+
# a single trusted context assertion and the ARN of the context provider
|
|
879
|
+
# from which the trusted context assertion was generated.
|
|
880
|
+
#
|
|
881
|
+
# `[{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"}]`
|
|
748
882
|
#
|
|
749
883
|
# @return [Types::AssumeRoleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
750
884
|
#
|
|
@@ -758,7 +892,7 @@ module Aws::STS
|
|
|
758
892
|
#
|
|
759
893
|
# resp = client.assume_role({
|
|
760
894
|
# external_id: "123ABC",
|
|
761
|
-
# policy: "
|
|
895
|
+
# policy: "escaped-JSON-IAM-POLICY",
|
|
762
896
|
# role_arn: "arn:aws:iam::123456789012:role/demo",
|
|
763
897
|
# role_session_name: "testAssumeRoleSession",
|
|
764
898
|
# tags: [
|
|
@@ -806,7 +940,7 @@ module Aws::STS
|
|
|
806
940
|
# arn: "arnType",
|
|
807
941
|
# },
|
|
808
942
|
# ],
|
|
809
|
-
# policy: "
|
|
943
|
+
# policy: "unrestrictedSessionPolicyDocumentType",
|
|
810
944
|
# duration_seconds: 1,
|
|
811
945
|
# tags: [
|
|
812
946
|
# {
|
|
@@ -819,6 +953,12 @@ module Aws::STS
|
|
|
819
953
|
# serial_number: "serialNumberType",
|
|
820
954
|
# token_code: "tokenCodeType",
|
|
821
955
|
# source_identity: "sourceIdentityType",
|
|
956
|
+
# provided_contexts: [
|
|
957
|
+
# {
|
|
958
|
+
# provider_arn: "arnType",
|
|
959
|
+
# context_assertion: "contextAssertionType",
|
|
960
|
+
# },
|
|
961
|
+
# ],
|
|
822
962
|
# })
|
|
823
963
|
#
|
|
824
964
|
# @example Response structure
|
|
@@ -848,14 +988,19 @@ module Aws::STS
|
|
|
848
988
|
# user-specific credentials or configuration. For a comparison of
|
|
849
989
|
# `AssumeRoleWithSAML` with the other API operations that produce
|
|
850
990
|
# temporary credentials, see [Requesting Temporary Security
|
|
851
|
-
# Credentials][1] and [
|
|
852
|
-
#
|
|
991
|
+
# Credentials][1] and [Compare STS credentials][2] in the *IAM User
|
|
992
|
+
# Guide*.
|
|
853
993
|
#
|
|
854
994
|
# The temporary security credentials returned by this operation consist
|
|
855
995
|
# of an access key ID, a secret access key, and a security token.
|
|
856
996
|
# Applications can use these temporary security credentials to sign
|
|
857
997
|
# calls to Amazon Web Services services.
|
|
858
998
|
#
|
|
999
|
+
# <note markdown="1"> AssumeRoleWithSAML will not work on IAM Identity Center managed roles.
|
|
1000
|
+
# These roles' names start with `AWSReservedSSO_`.
|
|
1001
|
+
#
|
|
1002
|
+
# </note>
|
|
1003
|
+
#
|
|
859
1004
|
# **Session Duration**
|
|
860
1005
|
#
|
|
861
1006
|
# By default, the temporary security credentials created by
|
|
@@ -979,7 +1124,7 @@ module Aws::STS
|
|
|
979
1124
|
#
|
|
980
1125
|
#
|
|
981
1126
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
|
|
982
|
-
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
1127
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html
|
|
983
1128
|
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session
|
|
984
1129
|
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
|
|
985
1130
|
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining
|
|
@@ -1067,6 +1212,9 @@ module Aws::STS
|
|
|
1067
1212
|
# the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)
|
|
1068
1213
|
# characters.
|
|
1069
1214
|
#
|
|
1215
|
+
# For more information about role session permissions, see [Session
|
|
1216
|
+
# policies][1].
|
|
1217
|
+
#
|
|
1070
1218
|
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
|
1071
1219
|
# policy, managed policy ARNs, and session tags into a packed binary
|
|
1072
1220
|
# format that has a separate limit. Your request can fail for this limit
|
|
@@ -1206,10 +1354,8 @@ module Aws::STS
|
|
|
1206
1354
|
# the user with a consistent identity throughout the lifetime of an
|
|
1207
1355
|
# application.
|
|
1208
1356
|
#
|
|
1209
|
-
# To learn more about Amazon Cognito, see [Amazon Cognito
|
|
1210
|
-
# in *Amazon
|
|
1211
|
-
# Cognito Overview][5] in the *Amazon Web Services SDK for iOS Developer
|
|
1212
|
-
# Guide*.
|
|
1357
|
+
# To learn more about Amazon Cognito, see [Amazon Cognito identity
|
|
1358
|
+
# pools][1] in *Amazon Cognito Developer Guide*.
|
|
1213
1359
|
#
|
|
1214
1360
|
# </note>
|
|
1215
1361
|
#
|
|
@@ -1223,8 +1369,8 @@ module Aws::STS
|
|
|
1223
1369
|
# a token from the web identity provider. For a comparison of
|
|
1224
1370
|
# `AssumeRoleWithWebIdentity` with the other API operations that produce
|
|
1225
1371
|
# temporary credentials, see [Requesting Temporary Security
|
|
1226
|
-
# Credentials][
|
|
1227
|
-
#
|
|
1372
|
+
# Credentials][4] and [Compare STS credentials][5] in the *IAM User
|
|
1373
|
+
# Guide*.
|
|
1228
1374
|
#
|
|
1229
1375
|
# The temporary security credentials returned by this API consist of an
|
|
1230
1376
|
# access key ID, a secret access key, and a security token. Applications
|
|
@@ -1239,12 +1385,12 @@ module Aws::STS
|
|
|
1239
1385
|
# your session. You can provide a value from 900 seconds (15 minutes) up
|
|
1240
1386
|
# to the maximum session duration setting for the role. This setting can
|
|
1241
1387
|
# have a value from 1 hour to 12 hours. To learn how to view the maximum
|
|
1242
|
-
# value for your role, see [
|
|
1243
|
-
#
|
|
1244
|
-
#
|
|
1388
|
+
# value for your role, see [Update the maximum session duration for a
|
|
1389
|
+
# role ][6] in the *IAM User Guide*. The maximum session duration limit
|
|
1390
|
+
# applies when you use the `AssumeRole*` API operations or the
|
|
1245
1391
|
# `assume-role*` CLI commands. However the limit does not apply when you
|
|
1246
1392
|
# use those operations to create a console URL. For more information,
|
|
1247
|
-
# see [Using IAM Roles][
|
|
1393
|
+
# see [Using IAM Roles][7] in the *IAM User Guide*.
|
|
1248
1394
|
#
|
|
1249
1395
|
# **Permissions**
|
|
1250
1396
|
#
|
|
@@ -1253,7 +1399,7 @@ module Aws::STS
|
|
|
1253
1399
|
# Amazon Web Services service with the following exception: you cannot
|
|
1254
1400
|
# call the STS `GetFederationToken` or `GetSessionToken` API operations.
|
|
1255
1401
|
#
|
|
1256
|
-
# (Optional) You can pass inline or managed [session policies][
|
|
1402
|
+
# (Optional) You can pass inline or managed [session policies][8] to
|
|
1257
1403
|
# this operation. You can pass a single JSON policy document to use as
|
|
1258
1404
|
# an inline session policy. You can also specify up to 10 managed policy
|
|
1259
1405
|
# Amazon Resource Names (ARNs) to use as managed session policies. The
|
|
@@ -1266,19 +1412,20 @@ module Aws::STS
|
|
|
1266
1412
|
# resources in the account that owns the role. You cannot use session
|
|
1267
1413
|
# policies to grant more permissions than those allowed by the
|
|
1268
1414
|
# identity-based policy of the role that is being assumed. For more
|
|
1269
|
-
# information, see [Session Policies][
|
|
1415
|
+
# information, see [Session Policies][8] in the *IAM User Guide*.
|
|
1270
1416
|
#
|
|
1271
1417
|
# **Tags**
|
|
1272
1418
|
#
|
|
1273
1419
|
# (Optional) You can configure your IdP to pass attributes into your web
|
|
1274
1420
|
# identity token as session tags. Each session tag consists of a key
|
|
1275
1421
|
# name and an associated value. For more information about session tags,
|
|
1276
|
-
# see [Passing
|
|
1422
|
+
# see [Passing session tags using AssumeRoleWithWebIdentity][9] in the
|
|
1423
|
+
# *IAM User Guide*.
|
|
1277
1424
|
#
|
|
1278
1425
|
# You can pass up to 50 session tags. The plaintext session tag keys
|
|
1279
1426
|
# can’t exceed 128 characters and the values can’t exceed 256
|
|
1280
1427
|
# characters. For these and additional limits, see [IAM and STS
|
|
1281
|
-
# Character Limits][
|
|
1428
|
+
# Character Limits][10] in the *IAM User Guide*.
|
|
1282
1429
|
#
|
|
1283
1430
|
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
|
1284
1431
|
# policy, managed policy ARNs, and session tags into a packed binary
|
|
@@ -1296,12 +1443,12 @@ module Aws::STS
|
|
|
1296
1443
|
# An administrator must grant you the permissions necessary to pass
|
|
1297
1444
|
# session tags. The administrator can also create granular permissions
|
|
1298
1445
|
# to allow you to pass only specific session tags. For more information,
|
|
1299
|
-
# see [Tutorial: Using Tags for Attribute-Based Access Control][
|
|
1446
|
+
# see [Tutorial: Using Tags for Attribute-Based Access Control][11] in
|
|
1300
1447
|
# the *IAM User Guide*.
|
|
1301
1448
|
#
|
|
1302
1449
|
# You can set the session tags as transitive. Transitive tags persist
|
|
1303
1450
|
# during role chaining. For more information, see [Chaining Roles with
|
|
1304
|
-
# Session Tags][
|
|
1451
|
+
# Session Tags][12] in the *IAM User Guide*.
|
|
1305
1452
|
#
|
|
1306
1453
|
# **Identities**
|
|
1307
1454
|
#
|
|
@@ -1313,22 +1460,17 @@ module Aws::STS
|
|
|
1313
1460
|
# specified in the role's trust policy.
|
|
1314
1461
|
#
|
|
1315
1462
|
# Calling `AssumeRoleWithWebIdentity` can result in an entry in your
|
|
1316
|
-
# CloudTrail logs. The entry includes the [Subject][
|
|
1463
|
+
# CloudTrail logs. The entry includes the [Subject][13] of the provided
|
|
1317
1464
|
# web identity token. We recommend that you avoid using any personally
|
|
1318
1465
|
# identifiable information (PII) in this field. For example, you could
|
|
1319
1466
|
# instead use a GUID or a pairwise identifier, as [suggested in the OIDC
|
|
1320
|
-
# specification][
|
|
1467
|
+
# specification][14].
|
|
1321
1468
|
#
|
|
1322
|
-
# For more information about how to use
|
|
1469
|
+
# For more information about how to use OIDC federation and the
|
|
1323
1470
|
# `AssumeRoleWithWebIdentity` API, see the following resources:
|
|
1324
1471
|
#
|
|
1325
|
-
# * [Using Web Identity Federation API Operations for Mobile Apps][
|
|
1326
|
-
# and [Federation Through a Web-based Identity Provider][
|
|
1327
|
-
#
|
|
1328
|
-
# * [ Web Identity Federation Playground][19]. Walk through the process
|
|
1329
|
-
# of authenticating through Login with Amazon, Facebook, or Google,
|
|
1330
|
-
# getting temporary security credentials, and then using those
|
|
1331
|
-
# credentials to make a request to Amazon Web Services.
|
|
1472
|
+
# * [Using Web Identity Federation API Operations for Mobile Apps][15]
|
|
1473
|
+
# and [Federation Through a Web-based Identity Provider][16].
|
|
1332
1474
|
#
|
|
1333
1475
|
# * [Amazon Web Services SDK for iOS Developer Guide][2] and [Amazon Web
|
|
1334
1476
|
# Services SDK for Android Developer Guide][3]. These toolkits contain
|
|
@@ -1336,37 +1478,47 @@ module Aws::STS
|
|
|
1336
1478
|
# toolkits then show how to use the information from these providers
|
|
1337
1479
|
# to get and use temporary security credentials.
|
|
1338
1480
|
#
|
|
1339
|
-
# * [Web Identity Federation with Mobile Applications][20]. This article
|
|
1340
|
-
# discusses web identity federation and shows an example of how to use
|
|
1341
|
-
# web identity federation to get access to content in Amazon S3.
|
|
1342
|
-
#
|
|
1343
1481
|
#
|
|
1344
1482
|
#
|
|
1345
1483
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html
|
|
1346
1484
|
# [2]: http://aws.amazon.com/sdkforios/
|
|
1347
1485
|
# [3]: http://aws.amazon.com/sdkforandroid/
|
|
1348
|
-
# [4]: https://docs.aws.amazon.com/
|
|
1349
|
-
# [5]: https://docs.aws.amazon.com/
|
|
1350
|
-
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
1351
|
-
# [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
1352
|
-
# [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
1353
|
-
# [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
1354
|
-
# [10]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
1355
|
-
# [11]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
1356
|
-
# [12]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
1357
|
-
# [13]:
|
|
1358
|
-
# [14]:
|
|
1359
|
-
# [15]:
|
|
1360
|
-
# [16]:
|
|
1361
|
-
# [17]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html
|
|
1362
|
-
# [18]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity
|
|
1363
|
-
# [19]: https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/
|
|
1364
|
-
# [20]: http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications
|
|
1486
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
|
|
1487
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html
|
|
1488
|
+
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_update-role-settings.html#id_roles_update-session-duration
|
|
1489
|
+
# [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
|
|
1490
|
+
# [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session
|
|
1491
|
+
# [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_adding-assume-role-idp
|
|
1492
|
+
# [10]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length
|
|
1493
|
+
# [11]: https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html
|
|
1494
|
+
# [12]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining
|
|
1495
|
+
# [13]: http://openid.net/specs/openid-connect-core-1_0.html#Claims
|
|
1496
|
+
# [14]: http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes
|
|
1497
|
+
# [15]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html
|
|
1498
|
+
# [16]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity
|
|
1365
1499
|
#
|
|
1366
1500
|
# @option params [required, String] :role_arn
|
|
1367
1501
|
# The Amazon Resource Name (ARN) of the role that the caller is
|
|
1368
1502
|
# assuming.
|
|
1369
1503
|
#
|
|
1504
|
+
# <note markdown="1"> Additional considerations apply to Amazon Cognito identity pools that
|
|
1505
|
+
# assume [cross-account IAM roles][1]. The trust policies of these roles
|
|
1506
|
+
# must accept the `cognito-identity.amazonaws.com` service principal and
|
|
1507
|
+
# must contain the `cognito-identity.amazonaws.com:aud` condition key to
|
|
1508
|
+
# restrict role assumption to users from your intended identity pools. A
|
|
1509
|
+
# policy that trusts Amazon Cognito identity pools without this
|
|
1510
|
+
# condition creates a risk that a user from an unintended identity pool
|
|
1511
|
+
# can assume the role. For more information, see [ Trust policies for
|
|
1512
|
+
# IAM roles in Basic (Classic) authentication ][2] in the *Amazon
|
|
1513
|
+
# Cognito Developer Guide*.
|
|
1514
|
+
#
|
|
1515
|
+
# </note>
|
|
1516
|
+
#
|
|
1517
|
+
#
|
|
1518
|
+
#
|
|
1519
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-cross-account-resource-access.html
|
|
1520
|
+
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/iam-roles.html#trust-policies
|
|
1521
|
+
#
|
|
1370
1522
|
# @option params [required, String] :role_session_name
|
|
1371
1523
|
# An identifier for the assumed role session. Typically, you pass the
|
|
1372
1524
|
# name or identifier that is associated with the user who is using your
|
|
@@ -1375,17 +1527,31 @@ module Aws::STS
|
|
|
1375
1527
|
# is included as part of the ARN and assumed role ID in the
|
|
1376
1528
|
# `AssumedRoleUser` response element.
|
|
1377
1529
|
#
|
|
1530
|
+
# For security purposes, administrators can view this field in
|
|
1531
|
+
# [CloudTrail logs][1] to help identify who performed an action in
|
|
1532
|
+
# Amazon Web Services. Your administrator might require that you specify
|
|
1533
|
+
# your user name as the session name when you assume the role. For more
|
|
1534
|
+
# information, see [ `sts:RoleSessionName` ][2].
|
|
1535
|
+
#
|
|
1378
1536
|
# The regex used to validate this parameter is a string of characters
|
|
1379
1537
|
# consisting of upper- and lower-case alphanumeric characters with no
|
|
1380
1538
|
# spaces. You can also include underscores or any of the following
|
|
1381
1539
|
# characters: =,.@-
|
|
1382
1540
|
#
|
|
1541
|
+
#
|
|
1542
|
+
#
|
|
1543
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html#cloudtrail-integration_signin-tempcreds
|
|
1544
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_rolesessionname
|
|
1545
|
+
#
|
|
1383
1546
|
# @option params [required, String] :web_identity_token
|
|
1384
1547
|
# The OAuth 2.0 access token or OpenID Connect ID token that is provided
|
|
1385
1548
|
# by the identity provider. Your application must get this token by
|
|
1386
1549
|
# authenticating the user who is using your application with a web
|
|
1387
1550
|
# identity provider before the application makes an
|
|
1388
|
-
# `AssumeRoleWithWebIdentity` call.
|
|
1551
|
+
# `AssumeRoleWithWebIdentity` call. Timestamps in the token must be
|
|
1552
|
+
# formatted as either an integer or a long integer. Tokens must be
|
|
1553
|
+
# signed using either RSA keys (RS256, RS384, or RS512) or ECDSA keys
|
|
1554
|
+
# (ES256, ES384, or ES512).
|
|
1389
1555
|
#
|
|
1390
1556
|
# @option params [String] :provider_id
|
|
1391
1557
|
# The fully qualified host component of the domain name of the OAuth 2.0
|
|
@@ -1454,6 +1620,9 @@ module Aws::STS
|
|
|
1454
1620
|
# the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)
|
|
1455
1621
|
# characters.
|
|
1456
1622
|
#
|
|
1623
|
+
# For more information about role session permissions, see [Session
|
|
1624
|
+
# policies][1].
|
|
1625
|
+
#
|
|
1457
1626
|
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
|
1458
1627
|
# policy, managed policy ARNs, and session tags into a packed binary
|
|
1459
1628
|
# format that has a separate limit. Your request can fail for this limit
|
|
@@ -1510,7 +1679,7 @@ module Aws::STS
|
|
|
1510
1679
|
#
|
|
1511
1680
|
# resp = client.assume_role_with_web_identity({
|
|
1512
1681
|
# duration_seconds: 3600,
|
|
1513
|
-
# policy: "
|
|
1682
|
+
# policy: "escaped-JSON-IAM-POLICY",
|
|
1514
1683
|
# provider_id: "www.amazon.com",
|
|
1515
1684
|
# role_arn: "arn:aws:iam::123456789012:role/FederatedWebIdentityRole",
|
|
1516
1685
|
# role_session_name: "app1",
|
|
@@ -1574,6 +1743,134 @@ module Aws::STS
|
|
|
1574
1743
|
req.send_request(options)
|
|
1575
1744
|
end
|
|
1576
1745
|
|
|
1746
|
+
# Returns a set of short term credentials you can use to perform
|
|
1747
|
+
# privileged tasks on a member account in your organization. You must
|
|
1748
|
+
# use credentials from an Organizations management account or a
|
|
1749
|
+
# delegated administrator account for IAM to call `AssumeRoot`. You
|
|
1750
|
+
# cannot use root user credentials to make this call.
|
|
1751
|
+
#
|
|
1752
|
+
# Before you can launch a privileged session, you must have centralized
|
|
1753
|
+
# root access in your organization. For steps to enable this feature,
|
|
1754
|
+
# see [Centralize root access for member accounts][1] in the *IAM User
|
|
1755
|
+
# Guide*.
|
|
1756
|
+
#
|
|
1757
|
+
# <note markdown="1"> The STS global endpoint is not supported for AssumeRoot. You must send
|
|
1758
|
+
# this request to a Regional STS endpoint. For more information, see
|
|
1759
|
+
# [Endpoints][2].
|
|
1760
|
+
#
|
|
1761
|
+
# </note>
|
|
1762
|
+
#
|
|
1763
|
+
# You can track AssumeRoot in CloudTrail logs to determine what actions
|
|
1764
|
+
# were performed in a session. For more information, see [Track
|
|
1765
|
+
# privileged tasks in CloudTrail][3] in the *IAM User Guide*.
|
|
1766
|
+
#
|
|
1767
|
+
# When granting access to privileged tasks you should only grant the
|
|
1768
|
+
# necessary permissions required to perform that task. For more
|
|
1769
|
+
# information, see [Security best practices in IAM][4]. In addition, you
|
|
1770
|
+
# can use [service control policies][5] (SCPs) to manage and limit
|
|
1771
|
+
# permissions in your organization. See [General examples][6] in the
|
|
1772
|
+
# *Organizations User Guide* for more information on SCPs.
|
|
1773
|
+
#
|
|
1774
|
+
#
|
|
1775
|
+
#
|
|
1776
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html
|
|
1777
|
+
# [2]: https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html#sts-endpoints
|
|
1778
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-track-privileged-tasks.html
|
|
1779
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html
|
|
1780
|
+
# [5]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html
|
|
1781
|
+
# [6]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps_examples_general.html
|
|
1782
|
+
#
|
|
1783
|
+
# @option params [required, String] :target_principal
|
|
1784
|
+
# The member account principal ARN or account ID.
|
|
1785
|
+
#
|
|
1786
|
+
# @option params [required, Types::PolicyDescriptorType] :task_policy_arn
|
|
1787
|
+
# The identity based policy that scopes the session to the privileged
|
|
1788
|
+
# tasks that can be performed. You must use one of following Amazon Web
|
|
1789
|
+
# Services managed policies to scope root session actions:
|
|
1790
|
+
#
|
|
1791
|
+
# * [IAMAuditRootUserCredentials][1]
|
|
1792
|
+
#
|
|
1793
|
+
# * [IAMCreateRootUserPassword][2]
|
|
1794
|
+
#
|
|
1795
|
+
# * [IAMDeleteRootUserCredentials][3]
|
|
1796
|
+
#
|
|
1797
|
+
# * [S3UnlockBucketPolicy][4]
|
|
1798
|
+
#
|
|
1799
|
+
# * [SQSUnlockQueuePolicy][5]
|
|
1800
|
+
#
|
|
1801
|
+
#
|
|
1802
|
+
#
|
|
1803
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMAuditRootUserCredentials
|
|
1804
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMCreateRootUserPassword
|
|
1805
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMDeleteRootUserCredentials
|
|
1806
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-S3UnlockBucketPolicy
|
|
1807
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-SQSUnlockQueuePolicy
|
|
1808
|
+
#
|
|
1809
|
+
# @option params [Integer] :duration_seconds
|
|
1810
|
+
# The duration, in seconds, of the privileged session. The value can
|
|
1811
|
+
# range from 0 seconds up to the maximum session duration of 900 seconds
|
|
1812
|
+
# (15 minutes). If you specify a value higher than this setting, the
|
|
1813
|
+
# operation fails.
|
|
1814
|
+
#
|
|
1815
|
+
# By default, the value is set to `900` seconds.
|
|
1816
|
+
#
|
|
1817
|
+
# @return [Types::AssumeRootResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1818
|
+
#
|
|
1819
|
+
# * {Types::AssumeRootResponse#credentials #credentials} => Types::Credentials
|
|
1820
|
+
# * {Types::AssumeRootResponse#source_identity #source_identity} => String
|
|
1821
|
+
#
|
|
1822
|
+
#
|
|
1823
|
+
# @example Example: To launch a privileged session
|
|
1824
|
+
#
|
|
1825
|
+
# # The following command retrieves a set of short-term credentials you can use to unlock an S3 bucket for a member account
|
|
1826
|
+
# # by removing the bucket policy.
|
|
1827
|
+
#
|
|
1828
|
+
# resp = client.assume_root({
|
|
1829
|
+
# duration_seconds: 900,
|
|
1830
|
+
# target_principal: "111122223333",
|
|
1831
|
+
# task_policy_arn: {
|
|
1832
|
+
# arn: "arn:aws:iam::aws:policy/root-task/S3UnlockBucketPolicy",
|
|
1833
|
+
# },
|
|
1834
|
+
# })
|
|
1835
|
+
#
|
|
1836
|
+
# resp.to_h outputs the following:
|
|
1837
|
+
# {
|
|
1838
|
+
# credentials: {
|
|
1839
|
+
# access_key_id: "ASIAJEXAMPLEXEG2JICEA",
|
|
1840
|
+
# expiration: Time.parse("2024-11-15T00:05:07Z"),
|
|
1841
|
+
# secret_access_key: "9drTJvcXLB89EXAMPLELB8923FB892xMFI",
|
|
1842
|
+
# session_token: "AQoXdzELDDY//////////wEaoAK1wvxJY12r2IrDFT2IvAzTCn3zHoZ7YNtpiQLF0MqZye/qwjzP2iEXAMPLEbw/m3hsj8VBTkPORGvr9jM5sgP+w9IZWZnU+LWhmg+a5fDi2oTGUYcdg9uexQ4mtCHIHfi4citgqZTgco40Yqr4lIlo4V2b2Dyauk0eYFNebHtYlFVgAUj+7Indz3LU0aTWk1WKIjHmmMCIoTkyYp/k7kUG7moeEYKSitwQIi6Gjn+nyzM+PtoA3685ixzv0R7i5rjQi0YE0lf1oeie3bDiNHncmzosRM6SFiPzSvp6h/32xQuZsjcypmwsPSDtTPYcs0+YN/8BRi2/IcrxSpnWEXAMPLEXSDFTAQAM6Dl9zR0tXoybnlrZIwMLlMi1Kcgo5OytwU=",
|
|
1843
|
+
# },
|
|
1844
|
+
# source_identity: "Alice",
|
|
1845
|
+
# }
|
|
1846
|
+
#
|
|
1847
|
+
# @example Request syntax with placeholder values
|
|
1848
|
+
#
|
|
1849
|
+
# resp = client.assume_root({
|
|
1850
|
+
# target_principal: "TargetPrincipalType", # required
|
|
1851
|
+
# task_policy_arn: { # required
|
|
1852
|
+
# arn: "arnType",
|
|
1853
|
+
# },
|
|
1854
|
+
# duration_seconds: 1,
|
|
1855
|
+
# })
|
|
1856
|
+
#
|
|
1857
|
+
# @example Response structure
|
|
1858
|
+
#
|
|
1859
|
+
# resp.credentials.access_key_id #=> String
|
|
1860
|
+
# resp.credentials.secret_access_key #=> String
|
|
1861
|
+
# resp.credentials.session_token #=> String
|
|
1862
|
+
# resp.credentials.expiration #=> Time
|
|
1863
|
+
# resp.source_identity #=> String
|
|
1864
|
+
#
|
|
1865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoot AWS API Documentation
|
|
1866
|
+
#
|
|
1867
|
+
# @overload assume_root(params = {})
|
|
1868
|
+
# @param [Hash] params ({})
|
|
1869
|
+
def assume_root(params = {}, options = {})
|
|
1870
|
+
req = build_request(:assume_root, params)
|
|
1871
|
+
req.send_request(options)
|
|
1872
|
+
end
|
|
1873
|
+
|
|
1577
1874
|
# Decodes additional information about the authorization status of a
|
|
1578
1875
|
# request from an encoded message returned in response to an Amazon Web
|
|
1579
1876
|
# Services request.
|
|
@@ -1720,11 +2017,11 @@ module Aws::STS
|
|
|
1720
2017
|
# to call the operation.
|
|
1721
2018
|
#
|
|
1722
2019
|
# <note markdown="1"> No permissions are required to perform this operation. If an
|
|
1723
|
-
# administrator
|
|
2020
|
+
# administrator attaches a policy to your identity that explicitly
|
|
1724
2021
|
# denies access to the `sts:GetCallerIdentity` action, you can still
|
|
1725
2022
|
# perform this operation. Permissions are not required because the same
|
|
1726
|
-
# information is returned when
|
|
1727
|
-
#
|
|
2023
|
+
# information is returned when access is denied. To view an example
|
|
2024
|
+
# response, see [I Am Not Authorized to Perform:
|
|
1728
2025
|
# iam:DeleteVirtualMFADevice][1] in the *IAM User Guide*.
|
|
1729
2026
|
#
|
|
1730
2027
|
# </note>
|
|
@@ -1800,44 +2097,84 @@ module Aws::STS
|
|
|
1800
2097
|
req.send_request(options)
|
|
1801
2098
|
end
|
|
1802
2099
|
|
|
2100
|
+
# Exchanges a trade-in token for temporary Amazon Web Services
|
|
2101
|
+
# credentials with the permissions associated with the assumed
|
|
2102
|
+
# principal. This operation allows you to obtain credentials for a
|
|
2103
|
+
# specific principal based on a trade-in token, enabling delegation of
|
|
2104
|
+
# access to Amazon Web Services resources.
|
|
2105
|
+
#
|
|
2106
|
+
# @option params [required, String] :trade_in_token
|
|
2107
|
+
# The token to exchange for temporary Amazon Web Services credentials.
|
|
2108
|
+
# This token must be valid and unexpired at the time of the request.
|
|
2109
|
+
#
|
|
2110
|
+
# @return [Types::GetDelegatedAccessTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2111
|
+
#
|
|
2112
|
+
# * {Types::GetDelegatedAccessTokenResponse#credentials #credentials} => Types::Credentials
|
|
2113
|
+
# * {Types::GetDelegatedAccessTokenResponse#packed_policy_size #packed_policy_size} => Integer
|
|
2114
|
+
# * {Types::GetDelegatedAccessTokenResponse#assumed_principal #assumed_principal} => String
|
|
2115
|
+
#
|
|
2116
|
+
# @example Request syntax with placeholder values
|
|
2117
|
+
#
|
|
2118
|
+
# resp = client.get_delegated_access_token({
|
|
2119
|
+
# trade_in_token: "tradeInTokenType", # required
|
|
2120
|
+
# })
|
|
2121
|
+
#
|
|
2122
|
+
# @example Response structure
|
|
2123
|
+
#
|
|
2124
|
+
# resp.credentials.access_key_id #=> String
|
|
2125
|
+
# resp.credentials.secret_access_key #=> String
|
|
2126
|
+
# resp.credentials.session_token #=> String
|
|
2127
|
+
# resp.credentials.expiration #=> Time
|
|
2128
|
+
# resp.packed_policy_size #=> Integer
|
|
2129
|
+
# resp.assumed_principal #=> String
|
|
2130
|
+
#
|
|
2131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetDelegatedAccessToken AWS API Documentation
|
|
2132
|
+
#
|
|
2133
|
+
# @overload get_delegated_access_token(params = {})
|
|
2134
|
+
# @param [Hash] params ({})
|
|
2135
|
+
def get_delegated_access_token(params = {}, options = {})
|
|
2136
|
+
req = build_request(:get_delegated_access_token, params)
|
|
2137
|
+
req.send_request(options)
|
|
2138
|
+
end
|
|
2139
|
+
|
|
1803
2140
|
# Returns a set of temporary security credentials (consisting of an
|
|
1804
|
-
# access key ID, a secret access key, and a security token) for a
|
|
1805
|
-
#
|
|
1806
|
-
#
|
|
1807
|
-
#
|
|
1808
|
-
#
|
|
1809
|
-
#
|
|
1810
|
-
#
|
|
1811
|
-
#
|
|
1812
|
-
#
|
|
1813
|
-
#
|
|
1814
|
-
#
|
|
2141
|
+
# access key ID, a secret access key, and a security token) for a user.
|
|
2142
|
+
# A typical use is in a proxy application that gets temporary security
|
|
2143
|
+
# credentials on behalf of distributed applications inside a corporate
|
|
2144
|
+
# network.
|
|
2145
|
+
#
|
|
2146
|
+
# You must call the `GetFederationToken` operation using the long-term
|
|
2147
|
+
# security credentials of an IAM user. As a result, this call is
|
|
2148
|
+
# appropriate in contexts where those credentials can be safeguarded,
|
|
2149
|
+
# usually in a server-based application. For a comparison of
|
|
2150
|
+
# `GetFederationToken` with the other API operations that produce
|
|
2151
|
+
# temporary credentials, see [Requesting Temporary Security
|
|
2152
|
+
# Credentials][1] and [Compare STS credentials][2] in the *IAM User
|
|
2153
|
+
# Guide*.
|
|
2154
|
+
#
|
|
2155
|
+
# Although it is possible to call `GetFederationToken` using the
|
|
2156
|
+
# security credentials of an Amazon Web Services account root user
|
|
2157
|
+
# rather than an IAM user that you create for the purpose of a proxy
|
|
2158
|
+
# application, we do not recommend it. For more information, see
|
|
2159
|
+
# [Safeguard your root user credentials and don't use them for everyday
|
|
2160
|
+
# tasks][3] in the *IAM User Guide*.
|
|
1815
2161
|
#
|
|
1816
2162
|
# <note markdown="1"> You can create a mobile-based or browser-based app that can
|
|
1817
2163
|
# authenticate users using a web identity provider like Login with
|
|
1818
2164
|
# Amazon, Facebook, Google, or an OpenID Connect-compatible identity
|
|
1819
|
-
# provider. In this case, we recommend that you use [Amazon Cognito][
|
|
2165
|
+
# provider. In this case, we recommend that you use [Amazon Cognito][4]
|
|
1820
2166
|
# or `AssumeRoleWithWebIdentity`. For more information, see [Federation
|
|
1821
|
-
# Through a Web-based Identity Provider][
|
|
2167
|
+
# Through a Web-based Identity Provider][5] in the *IAM User Guide*.
|
|
1822
2168
|
#
|
|
1823
2169
|
# </note>
|
|
1824
2170
|
#
|
|
1825
|
-
# You can also call `GetFederationToken` using the security credentials
|
|
1826
|
-
# of an Amazon Web Services account root user, but we do not recommend
|
|
1827
|
-
# it. Instead, we recommend that you create an IAM user for the purpose
|
|
1828
|
-
# of the proxy application. Then attach a policy to the IAM user that
|
|
1829
|
-
# limits federated users to only the actions and resources that they
|
|
1830
|
-
# need to access. For more information, see [IAM Best Practices][5] in
|
|
1831
|
-
# the *IAM User Guide*.
|
|
1832
|
-
#
|
|
1833
2171
|
# **Session duration**
|
|
1834
2172
|
#
|
|
1835
2173
|
# The temporary credentials are valid for the specified duration, from
|
|
1836
2174
|
# 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36
|
|
1837
2175
|
# hours). The default session duration is 43,200 seconds (12 hours).
|
|
1838
|
-
# Temporary credentials obtained by using the
|
|
1839
|
-
#
|
|
1840
|
-
# (1 hour).
|
|
2176
|
+
# Temporary credentials obtained by using the root user credentials have
|
|
2177
|
+
# a maximum duration of 3,600 seconds (1 hour).
|
|
1841
2178
|
#
|
|
1842
2179
|
# **Permissions**
|
|
1843
2180
|
#
|
|
@@ -1887,9 +2224,9 @@ module Aws::STS
|
|
|
1887
2224
|
# <note markdown="1"> You can create a mobile-based or browser-based app that can
|
|
1888
2225
|
# authenticate users using a web identity provider like Login with
|
|
1889
2226
|
# Amazon, Facebook, Google, or an OpenID Connect-compatible identity
|
|
1890
|
-
# provider. In this case, we recommend that you use [Amazon Cognito][
|
|
2227
|
+
# provider. In this case, we recommend that you use [Amazon Cognito][4]
|
|
1891
2228
|
# or `AssumeRoleWithWebIdentity`. For more information, see [Federation
|
|
1892
|
-
# Through a Web-based Identity Provider][
|
|
2229
|
+
# Through a Web-based Identity Provider][5] in the *IAM User Guide*.
|
|
1893
2230
|
#
|
|
1894
2231
|
# </note>
|
|
1895
2232
|
#
|
|
@@ -1910,10 +2247,10 @@ module Aws::STS
|
|
|
1910
2247
|
#
|
|
1911
2248
|
#
|
|
1912
2249
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
|
|
1913
|
-
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
1914
|
-
# [3]:
|
|
1915
|
-
# [4]:
|
|
1916
|
-
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
2250
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html
|
|
2251
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials
|
|
2252
|
+
# [4]: http://aws.amazon.com/cognito/
|
|
2253
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity
|
|
1917
2254
|
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session
|
|
1918
2255
|
# [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken
|
|
1919
2256
|
# [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html
|
|
@@ -2030,10 +2367,10 @@ module Aws::STS
|
|
|
2030
2367
|
# The duration, in seconds, that the session should last. Acceptable
|
|
2031
2368
|
# durations for federation sessions range from 900 seconds (15 minutes)
|
|
2032
2369
|
# to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the
|
|
2033
|
-
# default. Sessions obtained using
|
|
2034
|
-
#
|
|
2035
|
-
#
|
|
2036
|
-
#
|
|
2370
|
+
# default. Sessions obtained using root user credentials are restricted
|
|
2371
|
+
# to a maximum of 3,600 seconds (one hour). If the specified duration is
|
|
2372
|
+
# longer than one hour, the session obtained by using root user
|
|
2373
|
+
# credentials defaults to one hour.
|
|
2037
2374
|
#
|
|
2038
2375
|
# @option params [Array<Types::Tag>] :tags
|
|
2039
2376
|
# A list of session tags. Each session tag consists of a key name and an
|
|
@@ -2082,7 +2419,7 @@ module Aws::STS
|
|
|
2082
2419
|
# resp = client.get_federation_token({
|
|
2083
2420
|
# duration_seconds: 3600,
|
|
2084
2421
|
# name: "testFedUserSession",
|
|
2085
|
-
# policy: "
|
|
2422
|
+
# policy: "escaped-JSON-IAM-POLICY",
|
|
2086
2423
|
# tags: [
|
|
2087
2424
|
# {
|
|
2088
2425
|
# key: "Project",
|
|
@@ -2153,16 +2490,17 @@ module Aws::STS
|
|
|
2153
2490
|
# secret access key, and a security token. Typically, you use
|
|
2154
2491
|
# `GetSessionToken` if you want to use MFA to protect programmatic calls
|
|
2155
2492
|
# to specific Amazon Web Services API operations like Amazon EC2
|
|
2156
|
-
# `StopInstances`.
|
|
2157
|
-
#
|
|
2158
|
-
# MFA
|
|
2159
|
-
#
|
|
2160
|
-
#
|
|
2161
|
-
#
|
|
2162
|
-
#
|
|
2163
|
-
#
|
|
2164
|
-
#
|
|
2165
|
-
#
|
|
2493
|
+
# `StopInstances`.
|
|
2494
|
+
#
|
|
2495
|
+
# MFA-enabled IAM users must call `GetSessionToken` and submit an MFA
|
|
2496
|
+
# code that is associated with their MFA device. Using the temporary
|
|
2497
|
+
# security credentials that the call returns, IAM users can then make
|
|
2498
|
+
# programmatic calls to API operations that require MFA authentication.
|
|
2499
|
+
# An incorrect MFA code causes the API to return an access denied error.
|
|
2500
|
+
# For a comparison of `GetSessionToken` with the other API operations
|
|
2501
|
+
# that produce temporary credentials, see [Requesting Temporary Security
|
|
2502
|
+
# Credentials][1] and [Compare STS credentials][2] in the *IAM User
|
|
2503
|
+
# Guide*.
|
|
2166
2504
|
#
|
|
2167
2505
|
# <note markdown="1"> No permissions are required for users to perform this operation. The
|
|
2168
2506
|
# purpose of the `sts:GetSessionToken` operation is to authenticate the
|
|
@@ -2175,13 +2513,13 @@ module Aws::STS
|
|
|
2175
2513
|
# **Session Duration**
|
|
2176
2514
|
#
|
|
2177
2515
|
# The `GetSessionToken` operation must be called by using the long-term
|
|
2178
|
-
# Amazon Web Services security credentials of
|
|
2179
|
-
#
|
|
2180
|
-
#
|
|
2181
|
-
#
|
|
2182
|
-
# (
|
|
2183
|
-
#
|
|
2184
|
-
#
|
|
2516
|
+
# Amazon Web Services security credentials of an IAM user. Credentials
|
|
2517
|
+
# that are created by IAM users are valid for the duration that you
|
|
2518
|
+
# specify. This duration can range from 900 seconds (15 minutes) up to a
|
|
2519
|
+
# maximum of 129,600 seconds (36 hours), with a default of 43,200
|
|
2520
|
+
# seconds (12 hours). Credentials based on account credentials can range
|
|
2521
|
+
# from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a
|
|
2522
|
+
# default of 1 hour.
|
|
2185
2523
|
#
|
|
2186
2524
|
# **Permissions**
|
|
2187
2525
|
#
|
|
@@ -2195,32 +2533,31 @@ module Aws::STS
|
|
|
2195
2533
|
# * You cannot call any STS API *except* `AssumeRole` or
|
|
2196
2534
|
# `GetCallerIdentity`.
|
|
2197
2535
|
#
|
|
2198
|
-
#
|
|
2199
|
-
#
|
|
2200
|
-
#
|
|
2201
|
-
#
|
|
2202
|
-
# with Amazon Web Services.
|
|
2536
|
+
# The credentials that `GetSessionToken` returns are based on
|
|
2537
|
+
# permissions associated with the IAM user whose credentials were used
|
|
2538
|
+
# to call the operation. The temporary credentials have the same
|
|
2539
|
+
# permissions as the IAM user.
|
|
2203
2540
|
#
|
|
2204
|
-
#
|
|
2541
|
+
# <note markdown="1"> Although it is possible to call `GetSessionToken` using the security
|
|
2542
|
+
# credentials of an Amazon Web Services account root user rather than an
|
|
2543
|
+
# IAM user, we do not recommend it. If `GetSessionToken` is called using
|
|
2544
|
+
# root user credentials, the temporary credentials have root user
|
|
2545
|
+
# permissions. For more information, see [Safeguard your root user
|
|
2546
|
+
# credentials and don't use them for everyday tasks][4] in the *IAM
|
|
2547
|
+
# User Guide*
|
|
2205
2548
|
#
|
|
2206
|
-
#
|
|
2207
|
-
# permissions associated with the user whose credentials were used to
|
|
2208
|
-
# call the operation. If `GetSessionToken` is called using Amazon Web
|
|
2209
|
-
# Services account root user credentials, the temporary credentials have
|
|
2210
|
-
# root user permissions. Similarly, if `GetSessionToken` is called using
|
|
2211
|
-
# the credentials of an IAM user, the temporary credentials have the
|
|
2212
|
-
# same permissions as the IAM user.
|
|
2549
|
+
# </note>
|
|
2213
2550
|
#
|
|
2214
2551
|
# For more information about using `GetSessionToken` to create temporary
|
|
2215
|
-
# credentials,
|
|
2552
|
+
# credentials, see [Temporary Credentials for Users in Untrusted
|
|
2216
2553
|
# Environments][5] in the *IAM User Guide*.
|
|
2217
2554
|
#
|
|
2218
2555
|
#
|
|
2219
2556
|
#
|
|
2220
2557
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
|
|
2221
|
-
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
|
2558
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html
|
|
2222
2559
|
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getsessiontoken.html
|
|
2223
|
-
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#
|
|
2560
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials
|
|
2224
2561
|
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken
|
|
2225
2562
|
#
|
|
2226
2563
|
# @option params [Integer] :duration_seconds
|
|
@@ -2305,20 +2642,90 @@ module Aws::STS
|
|
|
2305
2642
|
req.send_request(options)
|
|
2306
2643
|
end
|
|
2307
2644
|
|
|
2645
|
+
# Returns a signed JSON Web Token (JWT) that represents the calling
|
|
2646
|
+
# Amazon Web Services identity. The returned JWT can be used to
|
|
2647
|
+
# authenticate with external services that support OIDC discovery. The
|
|
2648
|
+
# token is signed by Amazon Web Services STS and can be publicly
|
|
2649
|
+
# verified using the verification keys published at the issuer's JWKS
|
|
2650
|
+
# endpoint.
|
|
2651
|
+
#
|
|
2652
|
+
# @option params [required, Array<String>] :audience
|
|
2653
|
+
# The intended recipient of the web identity token. This value populates
|
|
2654
|
+
# the `aud` claim in the JWT and should identify the service or
|
|
2655
|
+
# application that will validate and use the token. The external service
|
|
2656
|
+
# should verify this claim to ensure the token was intended for their
|
|
2657
|
+
# use.
|
|
2658
|
+
#
|
|
2659
|
+
# @option params [Integer] :duration_seconds
|
|
2660
|
+
# The duration, in seconds, for which the JSON Web Token (JWT) will
|
|
2661
|
+
# remain valid. The value can range from 60 seconds (1 minute) to 3600
|
|
2662
|
+
# seconds (1 hour). If not specified, the default duration is 300
|
|
2663
|
+
# seconds (5 minutes). The token is designed to be short-lived and
|
|
2664
|
+
# should be used for proof of identity, then exchanged for credentials
|
|
2665
|
+
# or short-lived tokens in the external service.
|
|
2666
|
+
#
|
|
2667
|
+
# @option params [required, String] :signing_algorithm
|
|
2668
|
+
# The cryptographic algorithm to use for signing the JSON Web Token
|
|
2669
|
+
# (JWT). Valid values are RS256 (RSA with SHA-256) and ES384 (ECDSA
|
|
2670
|
+
# using P-384 curve with SHA-384).
|
|
2671
|
+
#
|
|
2672
|
+
# @option params [Array<Types::Tag>] :tags
|
|
2673
|
+
# An optional list of tags to include in the JSON Web Token (JWT). These
|
|
2674
|
+
# tags are added as custom claims to the JWT and can be used by the
|
|
2675
|
+
# downstream service for authorization decisions.
|
|
2676
|
+
#
|
|
2677
|
+
# @return [Types::GetWebIdentityTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2678
|
+
#
|
|
2679
|
+
# * {Types::GetWebIdentityTokenResponse#web_identity_token #web_identity_token} => String
|
|
2680
|
+
# * {Types::GetWebIdentityTokenResponse#expiration #expiration} => Time
|
|
2681
|
+
#
|
|
2682
|
+
# @example Request syntax with placeholder values
|
|
2683
|
+
#
|
|
2684
|
+
# resp = client.get_web_identity_token({
|
|
2685
|
+
# audience: ["webIdentityTokenAudienceStringType"], # required
|
|
2686
|
+
# duration_seconds: 1,
|
|
2687
|
+
# signing_algorithm: "jwtAlgorithmType", # required
|
|
2688
|
+
# tags: [
|
|
2689
|
+
# {
|
|
2690
|
+
# key: "tagKeyType", # required
|
|
2691
|
+
# value: "tagValueType", # required
|
|
2692
|
+
# },
|
|
2693
|
+
# ],
|
|
2694
|
+
# })
|
|
2695
|
+
#
|
|
2696
|
+
# @example Response structure
|
|
2697
|
+
#
|
|
2698
|
+
# resp.web_identity_token #=> String
|
|
2699
|
+
# resp.expiration #=> Time
|
|
2700
|
+
#
|
|
2701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetWebIdentityToken AWS API Documentation
|
|
2702
|
+
#
|
|
2703
|
+
# @overload get_web_identity_token(params = {})
|
|
2704
|
+
# @param [Hash] params ({})
|
|
2705
|
+
def get_web_identity_token(params = {}, options = {})
|
|
2706
|
+
req = build_request(:get_web_identity_token, params)
|
|
2707
|
+
req.send_request(options)
|
|
2708
|
+
end
|
|
2709
|
+
|
|
2308
2710
|
# @!endgroup
|
|
2309
2711
|
|
|
2310
2712
|
# @param params ({})
|
|
2311
2713
|
# @api private
|
|
2312
2714
|
def build_request(operation_name, params = {})
|
|
2313
2715
|
handlers = @handlers.for(operation_name)
|
|
2716
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
|
2717
|
+
Aws::Telemetry.module_to_tracer_name('Aws::STS')
|
|
2718
|
+
)
|
|
2314
2719
|
context = Seahorse::Client::RequestContext.new(
|
|
2315
2720
|
operation_name: operation_name,
|
|
2316
2721
|
operation: config.api.operation(operation_name),
|
|
2317
2722
|
client: self,
|
|
2318
2723
|
params: params,
|
|
2319
|
-
config: config
|
|
2724
|
+
config: config,
|
|
2725
|
+
tracer: tracer
|
|
2726
|
+
)
|
|
2320
2727
|
context[:gem_name] = 'aws-sdk-core'
|
|
2321
|
-
context[:gem_version] = '3.
|
|
2728
|
+
context[:gem_version] = '3.240.0'
|
|
2322
2729
|
Seahorse::Client::Request.new(handlers, context)
|
|
2323
2730
|
end
|
|
2324
2731
|
|