aws-sdk-core 3.190.2 → 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.
Files changed (203) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +650 -0
  3. data/VERSION +1 -1
  4. data/lib/aws-defaults.rb +4 -1
  5. data/lib/aws-sdk-core/arn.rb +1 -3
  6. data/lib/aws-sdk-core/assume_role_credentials.rb +21 -13
  7. data/lib/aws-sdk-core/assume_role_web_identity_credentials.rb +16 -9
  8. data/lib/aws-sdk-core/binary/decode_handler.rb +3 -9
  9. data/lib/aws-sdk-core/binary/encode_handler.rb +1 -1
  10. data/lib/aws-sdk-core/binary/event_builder.rb +34 -37
  11. data/lib/aws-sdk-core/binary/event_stream_decoder.rb +1 -0
  12. data/lib/aws-sdk-core/binary/event_stream_encoder.rb +4 -3
  13. data/lib/aws-sdk-core/cbor/decoder.rb +308 -0
  14. data/lib/aws-sdk-core/cbor/encoder.rb +243 -0
  15. data/lib/aws-sdk-core/cbor.rb +53 -0
  16. data/lib/aws-sdk-core/client_side_monitoring.rb +9 -0
  17. data/lib/aws-sdk-core/client_stubs.rb +39 -58
  18. data/lib/aws-sdk-core/credential_provider.rb +5 -1
  19. data/lib/aws-sdk-core/credential_provider_chain.rb +101 -25
  20. data/lib/aws-sdk-core/credentials.rb +19 -6
  21. data/lib/aws-sdk-core/ec2_metadata.rb +1 -1
  22. data/lib/aws-sdk-core/ecs_credentials.rb +16 -14
  23. data/lib/aws-sdk-core/endpoints/endpoint.rb +3 -1
  24. data/lib/aws-sdk-core/endpoints/matchers.rb +8 -10
  25. data/lib/aws-sdk-core/endpoints.rb +101 -21
  26. data/lib/aws-sdk-core/error_handler.rb +46 -0
  27. data/lib/aws-sdk-core/errors.rb +16 -4
  28. data/lib/aws-sdk-core/event_emitter.rb +1 -17
  29. data/lib/aws-sdk-core/instance_profile_credentials.rb +148 -157
  30. data/lib/aws-sdk-core/json/builder.rb +8 -1
  31. data/lib/aws-sdk-core/json/error_handler.rb +29 -13
  32. data/lib/aws-sdk-core/json/handler.rb +6 -6
  33. data/lib/aws-sdk-core/json/json_engine.rb +3 -1
  34. data/lib/aws-sdk-core/json/oj_engine.rb +7 -1
  35. data/lib/aws-sdk-core/json/parser.rb +6 -1
  36. data/lib/aws-sdk-core/json.rb +43 -14
  37. data/lib/aws-sdk-core/log/param_filter.rb +2 -2
  38. data/lib/aws-sdk-core/log/param_formatter.rb +7 -3
  39. data/lib/aws-sdk-core/log.rb +10 -0
  40. data/lib/aws-sdk-core/login_credentials.rb +229 -0
  41. data/lib/aws-sdk-core/lru_cache.rb +75 -0
  42. data/lib/aws-sdk-core/pageable_response.rb +1 -1
  43. data/lib/aws-sdk-core/param_validator.rb +7 -2
  44. data/lib/aws-sdk-core/plugins/bearer_authorization.rb +2 -0
  45. data/lib/aws-sdk-core/plugins/checksum_algorithm.rb +347 -170
  46. data/lib/aws-sdk-core/plugins/client_metrics_plugin.rb +1 -1
  47. data/lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb +14 -2
  48. data/lib/aws-sdk-core/plugins/credentials_configuration.rb +78 -56
  49. data/lib/aws-sdk-core/plugins/endpoint_pattern.rb +40 -32
  50. data/lib/aws-sdk-core/plugins/global_configuration.rb +8 -9
  51. data/lib/aws-sdk-core/plugins/http_checksum.rb +2 -8
  52. data/lib/aws-sdk-core/plugins/invocation_id.rb +1 -11
  53. data/lib/aws-sdk-core/plugins/logging.rb +2 -0
  54. data/lib/aws-sdk-core/plugins/protocols/api_gateway.rb +3 -1
  55. data/lib/aws-sdk-core/plugins/protocols/ec2.rb +2 -24
  56. data/lib/aws-sdk-core/plugins/protocols/json_rpc.rb +6 -8
  57. data/lib/aws-sdk-core/plugins/protocols/query.rb +4 -2
  58. data/lib/aws-sdk-core/plugins/protocols/rest_json.rb +3 -15
  59. data/lib/aws-sdk-core/plugins/protocols/rest_xml.rb +3 -0
  60. data/lib/aws-sdk-core/plugins/protocols/rpc_v2.rb +17 -0
  61. data/lib/aws-sdk-core/plugins/regional_endpoint.rb +74 -25
  62. data/lib/aws-sdk-core/plugins/request_compression.rb +11 -2
  63. data/lib/aws-sdk-core/plugins/retry_errors.rb +12 -3
  64. data/lib/aws-sdk-core/plugins/sign.rb +42 -26
  65. data/lib/aws-sdk-core/plugins/signature_v2.rb +2 -1
  66. data/lib/aws-sdk-core/plugins/signature_v4.rb +2 -1
  67. data/lib/aws-sdk-core/plugins/stub_responses.rb +59 -9
  68. data/lib/aws-sdk-core/plugins/telemetry.rb +75 -0
  69. data/lib/aws-sdk-core/plugins/transfer_encoding.rb +16 -9
  70. data/lib/aws-sdk-core/plugins/user_agent.rb +103 -26
  71. data/lib/aws-sdk-core/plugins.rb +39 -0
  72. data/lib/aws-sdk-core/process_credentials.rb +48 -29
  73. data/lib/aws-sdk-core/query/ec2_handler.rb +27 -0
  74. data/lib/aws-sdk-core/query/ec2_param_builder.rb +5 -7
  75. data/lib/aws-sdk-core/query/handler.rb +4 -4
  76. data/lib/aws-sdk-core/query/param_builder.rb +2 -2
  77. data/lib/aws-sdk-core/query.rb +2 -1
  78. data/lib/aws-sdk-core/refreshing_credentials.rb +8 -11
  79. data/lib/aws-sdk-core/resources.rb +8 -0
  80. data/lib/aws-sdk-core/rest/content_type_handler.rb +60 -0
  81. data/lib/aws-sdk-core/rest/handler.rb +3 -4
  82. data/lib/aws-sdk-core/rest/request/body.rb +32 -5
  83. data/lib/aws-sdk-core/rest/request/endpoint.rb +24 -4
  84. data/lib/aws-sdk-core/rest/request/headers.rb +15 -7
  85. data/lib/aws-sdk-core/rest/request/querystring_builder.rb +23 -11
  86. data/lib/aws-sdk-core/rest/response/body.rb +15 -1
  87. data/lib/aws-sdk-core/rest/response/header_list_parser.rb +79 -0
  88. data/lib/aws-sdk-core/rest/response/headers.rb +8 -3
  89. data/lib/aws-sdk-core/rest.rb +1 -0
  90. data/lib/aws-sdk-core/rpc_v2/builder.rb +62 -0
  91. data/lib/aws-sdk-core/rpc_v2/cbor_engine.rb +18 -0
  92. data/lib/aws-sdk-core/rpc_v2/content_type_handler.rb +47 -0
  93. data/lib/aws-sdk-core/rpc_v2/error_handler.rb +95 -0
  94. data/lib/aws-sdk-core/rpc_v2/handler.rb +79 -0
  95. data/lib/aws-sdk-core/rpc_v2/parser.rb +98 -0
  96. data/lib/aws-sdk-core/rpc_v2.rb +69 -0
  97. data/lib/aws-sdk-core/shared_config.rb +108 -22
  98. data/lib/aws-sdk-core/shared_credentials.rb +1 -7
  99. data/lib/aws-sdk-core/sso_credentials.rb +5 -2
  100. data/lib/aws-sdk-core/static_token_provider.rb +1 -2
  101. data/lib/aws-sdk-core/stubbing/protocols/ec2.rb +12 -11
  102. data/lib/aws-sdk-core/stubbing/protocols/json.rb +11 -10
  103. data/lib/aws-sdk-core/stubbing/protocols/query.rb +7 -6
  104. data/lib/aws-sdk-core/stubbing/protocols/rest.rb +2 -1
  105. data/lib/aws-sdk-core/stubbing/protocols/rest_json.rb +9 -8
  106. data/lib/aws-sdk-core/stubbing/protocols/rest_xml.rb +6 -5
  107. data/lib/aws-sdk-core/stubbing/protocols/rpc_v2.rb +39 -0
  108. data/lib/aws-sdk-core/stubbing.rb +22 -0
  109. data/lib/aws-sdk-core/telemetry/base.rb +177 -0
  110. data/lib/aws-sdk-core/telemetry/no_op.rb +70 -0
  111. data/lib/aws-sdk-core/telemetry/otel.rb +235 -0
  112. data/lib/aws-sdk-core/telemetry/span_kind.rb +22 -0
  113. data/lib/aws-sdk-core/telemetry/span_status.rb +59 -0
  114. data/lib/aws-sdk-core/telemetry.rb +78 -0
  115. data/lib/aws-sdk-core/token.rb +3 -3
  116. data/lib/aws-sdk-core/token_provider.rb +4 -0
  117. data/lib/aws-sdk-core/token_provider_chain.rb +2 -6
  118. data/lib/aws-sdk-core/util.rb +41 -1
  119. data/lib/aws-sdk-core/waiters/poller.rb +10 -5
  120. data/lib/aws-sdk-core/xml/builder.rb +17 -9
  121. data/lib/aws-sdk-core/xml/error_handler.rb +35 -43
  122. data/lib/aws-sdk-core/xml/parser/frame.rb +4 -20
  123. data/lib/aws-sdk-core/xml/parser/stack.rb +2 -0
  124. data/lib/aws-sdk-core/xml/parser.rb +2 -6
  125. data/lib/aws-sdk-core.rb +86 -107
  126. data/lib/aws-sdk-signin/client.rb +604 -0
  127. data/lib/aws-sdk-signin/client_api.rb +119 -0
  128. data/lib/aws-sdk-signin/customizations.rb +1 -0
  129. data/lib/aws-sdk-signin/endpoint_parameters.rb +69 -0
  130. data/lib/aws-sdk-signin/endpoint_provider.rb +59 -0
  131. data/lib/aws-sdk-signin/endpoints.rb +20 -0
  132. data/lib/aws-sdk-signin/errors.rb +122 -0
  133. data/lib/aws-sdk-signin/plugins/endpoints.rb +77 -0
  134. data/lib/aws-sdk-signin/resource.rb +26 -0
  135. data/lib/aws-sdk-signin/types.rb +299 -0
  136. data/lib/aws-sdk-signin.rb +63 -0
  137. data/lib/aws-sdk-sso/client.rb +189 -96
  138. data/lib/aws-sdk-sso/client_api.rb +7 -0
  139. data/lib/aws-sdk-sso/endpoint_parameters.rb +13 -10
  140. data/lib/aws-sdk-sso/endpoint_provider.rb +16 -20
  141. data/lib/aws-sdk-sso/endpoints.rb +2 -54
  142. data/lib/aws-sdk-sso/plugins/endpoints.rb +20 -20
  143. data/lib/aws-sdk-sso/types.rb +1 -0
  144. data/lib/aws-sdk-sso.rb +15 -11
  145. data/lib/aws-sdk-ssooidc/client.rb +293 -122
  146. data/lib/aws-sdk-ssooidc/client_api.rb +38 -0
  147. data/lib/aws-sdk-ssooidc/endpoint_parameters.rb +13 -10
  148. data/lib/aws-sdk-ssooidc/endpoint_provider.rb +14 -18
  149. data/lib/aws-sdk-ssooidc/endpoints.rb +2 -54
  150. data/lib/aws-sdk-ssooidc/errors.rb +31 -0
  151. data/lib/aws-sdk-ssooidc/plugins/endpoints.rb +20 -20
  152. data/lib/aws-sdk-ssooidc/types.rb +142 -29
  153. data/lib/aws-sdk-ssooidc.rb +15 -11
  154. data/lib/aws-sdk-sts/client.rb +529 -156
  155. data/lib/aws-sdk-sts/client_api.rb +108 -8
  156. data/lib/aws-sdk-sts/customizations.rb +5 -2
  157. data/lib/aws-sdk-sts/endpoint_parameters.rb +15 -14
  158. data/lib/aws-sdk-sts/endpoint_provider.rb +50 -55
  159. data/lib/aws-sdk-sts/endpoints.rb +2 -118
  160. data/lib/aws-sdk-sts/errors.rb +79 -0
  161. data/lib/aws-sdk-sts/plugins/endpoints.rb +20 -28
  162. data/lib/aws-sdk-sts/presigner.rb +2 -6
  163. data/lib/aws-sdk-sts/types.rb +344 -32
  164. data/lib/aws-sdk-sts.rb +15 -11
  165. data/lib/seahorse/client/async_base.rb +4 -5
  166. data/lib/seahorse/client/async_response.rb +19 -0
  167. data/lib/seahorse/client/base.rb +18 -21
  168. data/lib/seahorse/client/h2/connection.rb +18 -28
  169. data/lib/seahorse/client/h2/handler.rb +19 -3
  170. data/lib/seahorse/client/handler.rb +1 -1
  171. data/lib/seahorse/client/http/response.rb +1 -1
  172. data/lib/seahorse/client/net_http/connection_pool.rb +15 -12
  173. data/lib/seahorse/client/net_http/handler.rb +21 -9
  174. data/lib/seahorse/client/networking_error.rb +1 -1
  175. data/lib/seahorse/client/plugin.rb +9 -0
  176. data/lib/seahorse/client/plugins/endpoint.rb +0 -1
  177. data/lib/seahorse/client/plugins/h2.rb +4 -4
  178. data/lib/seahorse/client/plugins/net_http.rb +57 -16
  179. data/lib/seahorse/client/request_context.rb +9 -2
  180. data/lib/seahorse/client/response.rb +2 -0
  181. data/lib/seahorse/model/shapes.rb +2 -2
  182. data/lib/seahorse/util.rb +2 -1
  183. data/sig/aws-sdk-core/async_client_stubs.rbs +21 -0
  184. data/sig/aws-sdk-core/client_stubs.rbs +10 -0
  185. data/sig/aws-sdk-core/errors.rbs +22 -0
  186. data/sig/aws-sdk-core/resources/collection.rbs +21 -0
  187. data/sig/aws-sdk-core/structure.rbs +4 -0
  188. data/sig/aws-sdk-core/telemetry/base.rbs +46 -0
  189. data/sig/aws-sdk-core/telemetry/otel.rbs +22 -0
  190. data/sig/aws-sdk-core/telemetry/span_kind.rbs +15 -0
  191. data/sig/aws-sdk-core/telemetry/span_status.rbs +24 -0
  192. data/sig/aws-sdk-core/waiters/errors.rbs +20 -0
  193. data/sig/aws-sdk-core.rbs +7 -0
  194. data/sig/seahorse/client/async_base.rbs +18 -0
  195. data/sig/seahorse/client/base.rbs +25 -0
  196. data/sig/seahorse/client/handler_builder.rbs +16 -0
  197. data/sig/seahorse/client/response.rbs +61 -0
  198. metadata +117 -23
  199. /data/lib/aws-sdk-core/xml/parser/{engines/libxml.rb → libxml_engine.rb} +0 -0
  200. /data/lib/aws-sdk-core/xml/parser/{engines/nokogiri.rb → nokogiri_engine.rb} +0 -0
  201. /data/lib/aws-sdk-core/xml/parser/{engines/oga.rb → oga_engine.rb} +0 -0
  202. /data/lib/aws-sdk-core/xml/parser/{engines/ox.rb → ox_engine.rb} +0 -0
  203. /data/lib/aws-sdk-core/xml/parser/{engines/rexml.rb → rexml_engine.rb} +0 -0
@@ -7,35 +7,35 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
- require 'seahorse/client/plugins/content_length.rb'
11
- require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
- require 'aws-sdk-core/plugins/logging.rb'
13
- require 'aws-sdk-core/plugins/param_converter.rb'
14
- require 'aws-sdk-core/plugins/param_validator.rb'
15
- require 'aws-sdk-core/plugins/user_agent.rb'
16
- require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
- require 'aws-sdk-core/plugins/retry_errors.rb'
18
- require 'aws-sdk-core/plugins/global_configuration.rb'
19
- require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
- require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
- require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
- require 'aws-sdk-core/plugins/response_paging.rb'
23
- require 'aws-sdk-core/plugins/stub_responses.rb'
24
- require 'aws-sdk-core/plugins/idempotency_token.rb'
25
- require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
- require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
- require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
- require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
- require 'aws-sdk-core/plugins/http_checksum.rb'
30
- require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
- require 'aws-sdk-core/plugins/request_compression.rb'
32
- require 'aws-sdk-core/plugins/defaults_mode.rb'
33
- require 'aws-sdk-core/plugins/recursion_detection.rb'
34
- require 'aws-sdk-core/plugins/sign.rb'
35
- require 'aws-sdk-core/plugins/protocols/query.rb'
36
- require 'aws-sdk-sts/plugins/sts_regional_endpoints.rb'
37
-
38
- Aws::Plugins::GlobalConfiguration.add_identifier(:sts)
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'
39
39
 
40
40
  module Aws::STS
41
41
  # An API client for STS. To construct a client, you need to configure a `:region` and `:credentials`.
@@ -73,6 +73,7 @@ module Aws::STS
73
73
  add_plugin(Aws::Plugins::ResponsePaging)
74
74
  add_plugin(Aws::Plugins::StubResponses)
75
75
  add_plugin(Aws::Plugins::IdempotencyToken)
76
+ add_plugin(Aws::Plugins::InvocationId)
76
77
  add_plugin(Aws::Plugins::JsonvalueConverter)
77
78
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
78
79
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -82,6 +83,7 @@ module Aws::STS
82
83
  add_plugin(Aws::Plugins::RequestCompression)
83
84
  add_plugin(Aws::Plugins::DefaultsMode)
84
85
  add_plugin(Aws::Plugins::RecursionDetection)
86
+ add_plugin(Aws::Plugins::Telemetry)
85
87
  add_plugin(Aws::Plugins::Sign)
86
88
  add_plugin(Aws::Plugins::Protocols::Query)
87
89
  add_plugin(Aws::STS::Plugins::STSRegionalEndpoints)
@@ -89,9 +91,14 @@ module Aws::STS
89
91
 
90
92
  # @overload initialize(options)
91
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
+ #
92
99
  # @option options [required, Aws::CredentialProvider] :credentials
93
- # Your AWS credentials. This can be an instance of any one of the
94
- # 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:
95
102
  #
96
103
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
97
104
  # credentials.
@@ -119,20 +126,24 @@ module Aws::STS
119
126
  # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
120
127
  # from the Cognito Identity service.
121
128
  #
122
- # When `:credentials` are not configured directly, the following
123
- # locations will be searched for credentials:
129
+ # When `:credentials` are not configured directly, the following locations will be searched for credentials:
124
130
  #
125
131
  # * `Aws.config[:credentials]`
126
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
127
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
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
+ #
128
139
  # * `~/.aws/credentials`
140
+ #
129
141
  # * `~/.aws/config`
130
- # * EC2/ECS IMDS instance profile - When used by default, the timeouts
131
- # are very aggressive. Construct and pass an instance of
132
- # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
133
- # enable retries and extended timeouts. Instance profile credential
134
- # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
135
- # 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`.
136
147
  #
137
148
  # @option options [required, String] :region
138
149
  # The AWS region to connect to. The configured `:region` is
@@ -148,6 +159,8 @@ module Aws::STS
148
159
  #
149
160
  # @option options [String] :access_key_id
150
161
  #
162
+ # @option options [String] :account_id
163
+ #
151
164
  # @option options [Boolean] :active_endpoint_cache (false)
152
165
  # When set to `true`, a thread polling for endpoints will be running in
153
166
  # the background every 60 secs (default). Defaults to `false`.
@@ -158,6 +171,11 @@ module Aws::STS
158
171
  # When false, the request will raise a `RetryCapacityNotAvailableError` and will
159
172
  # not retry instead of sleeping.
160
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
+ #
161
179
  # @option options [Boolean] :client_side_monitoring (false)
162
180
  # When `true`, client-side metrics will be collected for all API requests from
163
181
  # this client.
@@ -191,17 +209,22 @@ module Aws::STS
191
209
  # accepted modes and the configuration defaults that are included.
192
210
  #
193
211
  # @option options [Boolean] :disable_host_prefix_injection (false)
194
- # Set to true to disable SDK automatically adding host prefix
195
- # to default service endpoint when available.
212
+ # When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
196
213
  #
197
214
  # @option options [Boolean] :disable_request_compression (false)
198
215
  # When set to 'true' the request body will not be compressed
199
216
  # for supported operations.
200
217
  #
201
- # @option options [String] :endpoint
202
- # The client endpoint is normally constructed from the `:region`
203
- # option. You should only configure an `:endpoint` when connecting
204
- # to test or custom endpoints. This should be a valid HTTP(S) URI.
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:
224
+ #
225
+ # 'http://example.com'
226
+ # 'https://example.com'
227
+ # 'http://example.com:123'
205
228
  #
206
229
  # @option options [Integer] :endpoint_cache_max_entries (1000)
207
230
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -239,14 +262,37 @@ module Aws::STS
239
262
  # 4 times. Used in `standard` and `adaptive` retry modes.
240
263
  #
241
264
  # @option options [String] :profile ("default")
242
- # Used when loading credentials from the shared credentials file
243
- # at HOME/.aws/credentials. When not specified, 'default' is used.
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.
244
279
  #
245
280
  # @option options [Integer] :request_min_compression_size_bytes (10240)
246
281
  # The minimum size in bytes that triggers compression for request
247
282
  # bodies. The value must be non-negative integer value between 0
248
283
  # and 10485780 bytes inclusive.
249
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`.
295
+ #
250
296
  # @option options [Proc] :retry_backoff
251
297
  # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
252
298
  # This option is only used in the `legacy` retry mode.
@@ -291,16 +337,25 @@ module Aws::STS
291
337
  # throttling. This is a provisional mode that may change behavior
292
338
  # in the future.
293
339
  #
294
- #
295
340
  # @option options [String] :sdk_ua_app_id
296
341
  # A unique and opaque application ID that is appended to the
297
- # User-Agent header as app/<sdk_ua_app_id>. It should have a
298
- # maximum length of 50.
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.
299
345
  #
300
346
  # @option options [String] :secret_access_key
301
347
  #
302
348
  # @option options [String] :session_token
303
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
+ #
304
359
  # @option options [String] :sts_regional_endpoints ("regional")
305
360
  # Passing in 'regional' to enable regional endpoint for STS for all supported
306
361
  # regions (except 'aws-global'). Using 'legacy' mode will force all legacy
@@ -315,9 +370,19 @@ module Aws::STS
315
370
  # ** Please note ** When response stubbing is enabled, no HTTP
316
371
  # requests are made, and retries are disabled.
317
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
+ #
318
383
  # @option options [Aws::TokenProvider] :token_provider
319
- # A Bearer Token Provider. This can be an instance of any one of the
320
- # 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:
321
386
  #
322
387
  # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
323
388
  # tokens.
@@ -342,52 +407,75 @@ module Aws::STS
342
407
  # sending the request.
343
408
  #
344
409
  # @option options [Aws::STS::EndpointProvider] :endpoint_provider
345
- # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::STS::EndpointParameters`
346
- #
347
- # @option options [URI::HTTP,String] :http_proxy A proxy to send
348
- # requests through. Formatted like 'http://proxy.com:123'.
349
- #
350
- # @option options [Float] :http_open_timeout (15) The number of
351
- # seconds to wait when opening a HTTP session before raising a
352
- # `Timeout::Error`.
353
- #
354
- # @option options [Float] :http_read_timeout (60) The default
355
- # number of seconds to wait for response data. This value can
356
- # safely be set per-request on the session.
357
- #
358
- # @option options [Float] :http_idle_timeout (5) The number of
359
- # seconds a connection is allowed to sit idle before it is
360
- # considered stale. Stale connections are closed and removed
361
- # from the pool before making a request.
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.
362
464
  #
363
- # @option options [Float] :http_continue_timeout (1) The number of
364
- # seconds to wait for a 100-continue response before sending the
365
- # request body. This option has no effect unless the request has
366
- # "Expect" header set to "100-continue". Defaults to `nil` which
367
- # disables this behaviour. This value can safely be set per
368
- # request on the session.
465
+ # @option options [String] :ssl_ca_store
466
+ # Sets the X509::Store to verify peer certificate.
369
467
  #
370
- # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
371
- # in seconds.
468
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
469
+ # Sets a client certificate when creating http connections.
372
470
  #
373
- # @option options [Boolean] :http_wire_trace (false) When `true`,
374
- # HTTP debug output will be sent to the `:logger`.
471
+ # @option options [OpenSSL::PKey] :ssl_key
472
+ # Sets a client key when creating http connections.
375
473
  #
376
- # @option options [Boolean] :ssl_verify_peer (true) When `true`,
377
- # SSL peer certificates are verified when establishing a
378
- # connection.
474
+ # @option options [Float] :ssl_timeout
475
+ # Sets the SSL timeout in seconds
379
476
  #
380
- # @option options [String] :ssl_ca_bundle Full path to the SSL
381
- # certificate authority bundle file that should be used when
382
- # verifying peer certificates. If you do not pass
383
- # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
384
- # will be used if available.
385
- #
386
- # @option options [String] :ssl_ca_directory Full path of the
387
- # directory that contains the unbundled SSL certificate
388
- # authority files for verifying peer certificates. If you do
389
- # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
390
- # 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.
391
479
  #
392
480
  def initialize(*args)
393
481
  super
@@ -401,8 +489,8 @@ module Aws::STS
401
489
  # token. Typically, you use `AssumeRole` within your account or for
402
490
  # cross-account access. For a comparison of `AssumeRole` with other API
403
491
  # operations that produce temporary credentials, see [Requesting
404
- # Temporary Security Credentials][1] and [Comparing the Amazon Web
405
- # Services STS API operations][2] in the *IAM User Guide*.
492
+ # Temporary Security Credentials][1] and [Compare STS credentials][2] in
493
+ # the *IAM User Guide*.
406
494
  #
407
495
  # **Permissions**
408
496
  #
@@ -411,9 +499,9 @@ module Aws::STS
411
499
  # following exception: You cannot call the Amazon Web Services STS
412
500
  # `GetFederationToken` or `GetSessionToken` API operations.
413
501
  #
414
- # (Optional) You can pass inline or managed [session policies][3] to
415
- # this operation. You can pass a single JSON policy document to use as
416
- # an inline session policy. You can also specify up to 10 managed policy
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
417
505
  # Amazon Resource Names (ARNs) to use as managed session policies. The
418
506
  # plaintext that you use for both inline and managed session policies
419
507
  # can't exceed 2,048 characters. Passing policies to this operation
@@ -486,7 +574,7 @@ module Aws::STS
486
574
  # denied. The condition in a trust policy that tests for MFA
487
575
  # authentication might look like the following example.
488
576
  #
489
- # `"Condition": \{"Bool": \{"aws:MultiFactorAuthPresent": true\}\}`
577
+ # `"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}`
490
578
  #
491
579
  # For more information, see [Configuring MFA-Protected API Access][8] in
492
580
  # the *IAM User Guide* guide.
@@ -499,7 +587,7 @@ module Aws::STS
499
587
  #
500
588
  #
501
589
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
502
- # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison
590
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html
503
591
  # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session
504
592
  # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html
505
593
  # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html
@@ -522,10 +610,21 @@ module Aws::STS
522
610
  # credentials will expose the role session name to the external account
523
611
  # in their CloudTrail logs.
524
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
+ #
525
619
  # The regex used to validate this parameter is a string of characters
526
620
  # consisting of upper- and lower-case alphanumeric characters with no
527
621
  # spaces. You can also include underscores or any of the following
528
- # 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
529
628
  #
530
629
  # @option params [Array<Types::PolicyDescriptorType>] :policy_arns
531
630
  # The Amazon Resource Names (ARNs) of the IAM managed policies that you
@@ -592,6 +691,9 @@ module Aws::STS
592
691
  #
593
692
  # </note>
594
693
  #
694
+ # For more information about role session permissions, see [Session
695
+ # policies][1].
696
+ #
595
697
  #
596
698
  #
597
699
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session
@@ -614,9 +716,8 @@ module Aws::STS
614
716
  # depending on the maximum session duration setting for your role.
615
717
  # However, if you assume a role using role chaining and provide a
616
718
  # `DurationSeconds` parameter value greater than one hour, the operation
617
- # fails. To learn how to view the maximum value for your role, see [View
618
- # the Maximum Session Duration Setting for a Role][1] in the *IAM User
619
- # 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].
620
721
  #
621
722
  # By default, the value is set to `3600` seconds.
622
723
  #
@@ -632,7 +733,7 @@ module Aws::STS
632
733
  #
633
734
  #
634
735
  #
635
- # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session
736
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_update-role-settings.html#id_roles_update-session-duration
636
737
  # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html
637
738
  #
638
739
  # @option params [Array<Types::Tag>] :tags
@@ -685,9 +786,8 @@ module Aws::STS
685
786
  # passes to subsequent sessions in a role chain. For more information,
686
787
  # see [Chaining Roles with Session Tags][1] in the *IAM User Guide*.
687
788
  #
688
- # This parameter is optional. When you set session tags as transitive,
689
- # the session policy and session tags packed binary limit is not
690
- # affected.
789
+ # This parameter is optional. The transitive status of a session tag
790
+ # does not impact its packed binary size.
691
791
  #
692
792
  # If you choose not to specify a transitive tag key, then no tags are
693
793
  # passed from this session to any subsequent sessions.
@@ -713,7 +813,7 @@ module Aws::STS
713
813
  # The regex used to validate this parameter is a string of characters
714
814
  # consisting of upper- and lower-case alphanumeric characters with no
715
815
  # spaces. You can also include underscores or any of the following
716
- # characters: =,.@:/-
816
+ # characters: +=,.@:\\/-
717
817
  #
718
818
  #
719
819
  #
@@ -731,7 +831,7 @@ module Aws::STS
731
831
  # The regex used to validate this parameter is a string of characters
732
832
  # consisting of upper- and lower-case alphanumeric characters with no
733
833
  # spaces. You can also include underscores or any of the following
734
- # characters: =,.@-
834
+ # characters: +=/:,.@-
735
835
  #
736
836
  # @option params [String] :token_code
737
837
  # The value provided by the MFA device, if the trust policy of the role
@@ -745,26 +845,29 @@ module Aws::STS
745
845
  #
746
846
  # @option params [String] :source_identity
747
847
  # The source identity specified by the principal that is calling the
748
- # `AssumeRole` operation.
848
+ # `AssumeRole` operation. The source identity value persists across
849
+ # [chained role][1] sessions.
749
850
  #
750
851
  # You can require users to specify a source identity when they assume a
751
- # role. You do this by using the `sts:SourceIdentity` condition key in a
752
- # 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
753
854
  # CloudTrail logs to determine who took actions with a role. You can use
754
855
  # the `aws:SourceIdentity` condition key to further control access to
755
856
  # Amazon Web Services resources based on the value of source identity.
756
857
  # For more information about using source identity, see [Monitor and
757
- # control actions taken with assumed roles][1] in the *IAM User Guide*.
858
+ # control actions taken with assumed roles][3] in the *IAM User Guide*.
758
859
  #
759
860
  # The regex used to validate this parameter is a string of characters
760
861
  # consisting of upper- and lower-case alphanumeric characters with no
761
862
  # spaces. You can also include underscores or any of the following
762
- # characters: =,.@-. You cannot use a value that begins with the text
863
+ # characters: +=,.@-. You cannot use a value that begins with the text
763
864
  # `aws:`. This prefix is reserved for Amazon Web Services internal use.
764
865
  #
765
866
  #
766
867
  #
767
- # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html
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
768
871
  #
769
872
  # @option params [Array<Types::ProvidedContext>] :provided_contexts
770
873
  # A list of previously acquired trusted context assertions in the format
@@ -775,7 +878,7 @@ module Aws::STS
775
878
  # a single trusted context assertion and the ARN of the context provider
776
879
  # from which the trusted context assertion was generated.
777
880
  #
778
- # `[\{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"\}]`
881
+ # `[{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"}]`
779
882
  #
780
883
  # @return [Types::AssumeRoleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
781
884
  #
@@ -789,7 +892,7 @@ module Aws::STS
789
892
  #
790
893
  # resp = client.assume_role({
791
894
  # external_id: "123ABC",
792
- # policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Stmt1\",\"Effect\":\"Allow\",\"Action\":\"s3:ListAllMyBuckets\",\"Resource\":\"*\"}]}",
895
+ # policy: "escaped-JSON-IAM-POLICY",
793
896
  # role_arn: "arn:aws:iam::123456789012:role/demo",
794
897
  # role_session_name: "testAssumeRoleSession",
795
898
  # tags: [
@@ -885,14 +988,19 @@ module Aws::STS
885
988
  # user-specific credentials or configuration. For a comparison of
886
989
  # `AssumeRoleWithSAML` with the other API operations that produce
887
990
  # temporary credentials, see [Requesting Temporary Security
888
- # Credentials][1] and [Comparing the Amazon Web Services STS API
889
- # operations][2] in the *IAM User Guide*.
991
+ # Credentials][1] and [Compare STS credentials][2] in the *IAM User
992
+ # Guide*.
890
993
  #
891
994
  # The temporary security credentials returned by this operation consist
892
995
  # of an access key ID, a secret access key, and a security token.
893
996
  # Applications can use these temporary security credentials to sign
894
997
  # calls to Amazon Web Services services.
895
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
+ #
896
1004
  # **Session Duration**
897
1005
  #
898
1006
  # By default, the temporary security credentials created by
@@ -1016,7 +1124,7 @@ module Aws::STS
1016
1124
  #
1017
1125
  #
1018
1126
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
1019
- # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison
1127
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html
1020
1128
  # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session
1021
1129
  # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
1022
1130
  # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining
@@ -1104,6 +1212,9 @@ module Aws::STS
1104
1212
  # the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)
1105
1213
  # characters.
1106
1214
  #
1215
+ # For more information about role session permissions, see [Session
1216
+ # policies][1].
1217
+ #
1107
1218
  # <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
1108
1219
  # policy, managed policy ARNs, and session tags into a packed binary
1109
1220
  # format that has a separate limit. Your request can fail for this limit
@@ -1258,8 +1369,8 @@ module Aws::STS
1258
1369
  # a token from the web identity provider. For a comparison of
1259
1370
  # `AssumeRoleWithWebIdentity` with the other API operations that produce
1260
1371
  # temporary credentials, see [Requesting Temporary Security
1261
- # Credentials][4] and [Comparing the Amazon Web Services STS API
1262
- # operations][5] in the *IAM User Guide*.
1372
+ # Credentials][4] and [Compare STS credentials][5] in the *IAM User
1373
+ # Guide*.
1263
1374
  #
1264
1375
  # The temporary security credentials returned by this API consist of an
1265
1376
  # access key ID, a secret access key, and a security token. Applications
@@ -1274,9 +1385,9 @@ module Aws::STS
1274
1385
  # your session. You can provide a value from 900 seconds (15 minutes) up
1275
1386
  # to the maximum session duration setting for the role. This setting can
1276
1387
  # have a value from 1 hour to 12 hours. To learn how to view the maximum
1277
- # value for your role, see [View the Maximum Session Duration Setting
1278
- # for a Role][6] in the *IAM User Guide*. The maximum session duration
1279
- # limit applies when you use the `AssumeRole*` API operations or the
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
1280
1391
  # `assume-role*` CLI commands. However the limit does not apply when you
1281
1392
  # use those operations to create a console URL. For more information,
1282
1393
  # see [Using IAM Roles][7] in the *IAM User Guide*.
@@ -1308,7 +1419,8 @@ module Aws::STS
1308
1419
  # (Optional) You can configure your IdP to pass attributes into your web
1309
1420
  # identity token as session tags. Each session tag consists of a key
1310
1421
  # name and an associated value. For more information about session tags,
1311
- # see [Passing Session Tags in STS][9] in the *IAM User Guide*.
1422
+ # see [Passing session tags using AssumeRoleWithWebIdentity][9] in the
1423
+ # *IAM User Guide*.
1312
1424
  #
1313
1425
  # You can pass up to 50 session tags. The plaintext session tag keys
1314
1426
  # can’t exceed 128 characters and the values can’t exceed 256
@@ -1354,38 +1466,29 @@ module Aws::STS
1354
1466
  # instead use a GUID or a pairwise identifier, as [suggested in the OIDC
1355
1467
  # specification][14].
1356
1468
  #
1357
- # For more information about how to use web identity federation and the
1469
+ # For more information about how to use OIDC federation and the
1358
1470
  # `AssumeRoleWithWebIdentity` API, see the following resources:
1359
1471
  #
1360
1472
  # * [Using Web Identity Federation API Operations for Mobile Apps][15]
1361
1473
  # and [Federation Through a Web-based Identity Provider][16].
1362
1474
  #
1363
- # * [ Web Identity Federation Playground][17]. Walk through the process
1364
- # of authenticating through Login with Amazon, Facebook, or Google,
1365
- # getting temporary security credentials, and then using those
1366
- # credentials to make a request to Amazon Web Services.
1367
- #
1368
1475
  # * [Amazon Web Services SDK for iOS Developer Guide][2] and [Amazon Web
1369
1476
  # Services SDK for Android Developer Guide][3]. These toolkits contain
1370
1477
  # sample apps that show how to invoke the identity providers. The
1371
1478
  # toolkits then show how to use the information from these providers
1372
1479
  # to get and use temporary security credentials.
1373
1480
  #
1374
- # * [Web Identity Federation with Mobile Applications][18]. This article
1375
- # discusses web identity federation and shows an example of how to use
1376
- # web identity federation to get access to content in Amazon S3.
1377
- #
1378
1481
  #
1379
1482
  #
1380
1483
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html
1381
1484
  # [2]: http://aws.amazon.com/sdkforios/
1382
1485
  # [3]: http://aws.amazon.com/sdkforandroid/
1383
1486
  # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
1384
- # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison
1385
- # [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session
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
1386
1489
  # [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
1387
1490
  # [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session
1388
- # [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html
1491
+ # [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_adding-assume-role-idp
1389
1492
  # [10]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length
1390
1493
  # [11]: https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html
1391
1494
  # [12]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining
@@ -1393,13 +1496,29 @@ module Aws::STS
1393
1496
  # [14]: http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes
1394
1497
  # [15]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html
1395
1498
  # [16]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity
1396
- # [17]: https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/
1397
- # [18]: http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications
1398
1499
  #
1399
1500
  # @option params [required, String] :role_arn
1400
1501
  # The Amazon Resource Name (ARN) of the role that the caller is
1401
1502
  # assuming.
1402
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
+ #
1403
1522
  # @option params [required, String] :role_session_name
1404
1523
  # An identifier for the assumed role session. Typically, you pass the
1405
1524
  # name or identifier that is associated with the user who is using your
@@ -1408,18 +1527,31 @@ module Aws::STS
1408
1527
  # is included as part of the ARN and assumed role ID in the
1409
1528
  # `AssumedRoleUser` response element.
1410
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
+ #
1411
1536
  # The regex used to validate this parameter is a string of characters
1412
1537
  # consisting of upper- and lower-case alphanumeric characters with no
1413
1538
  # spaces. You can also include underscores or any of the following
1414
1539
  # characters: =,.@-
1415
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
+ #
1416
1546
  # @option params [required, String] :web_identity_token
1417
1547
  # The OAuth 2.0 access token or OpenID Connect ID token that is provided
1418
1548
  # by the identity provider. Your application must get this token by
1419
1549
  # authenticating the user who is using your application with a web
1420
1550
  # identity provider before the application makes an
1421
- # `AssumeRoleWithWebIdentity` call. Only tokens with RSA algorithms
1422
- # (RS256) are supported.
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).
1423
1555
  #
1424
1556
  # @option params [String] :provider_id
1425
1557
  # The fully qualified host component of the domain name of the OAuth 2.0
@@ -1488,6 +1620,9 @@ module Aws::STS
1488
1620
  # the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)
1489
1621
  # characters.
1490
1622
  #
1623
+ # For more information about role session permissions, see [Session
1624
+ # policies][1].
1625
+ #
1491
1626
  # <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
1492
1627
  # policy, managed policy ARNs, and session tags into a packed binary
1493
1628
  # format that has a separate limit. Your request can fail for this limit
@@ -1544,7 +1679,7 @@ module Aws::STS
1544
1679
  #
1545
1680
  # resp = client.assume_role_with_web_identity({
1546
1681
  # duration_seconds: 3600,
1547
- # policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Stmt1\",\"Effect\":\"Allow\",\"Action\":\"s3:ListAllMyBuckets\",\"Resource\":\"*\"}]}",
1682
+ # policy: "escaped-JSON-IAM-POLICY",
1548
1683
  # provider_id: "www.amazon.com",
1549
1684
  # role_arn: "arn:aws:iam::123456789012:role/FederatedWebIdentityRole",
1550
1685
  # role_session_name: "app1",
@@ -1608,6 +1743,134 @@ module Aws::STS
1608
1743
  req.send_request(options)
1609
1744
  end
1610
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
+
1611
1874
  # Decodes additional information about the authorization status of a
1612
1875
  # request from an encoded message returned in response to an Amazon Web
1613
1876
  # Services request.
@@ -1834,6 +2097,46 @@ module Aws::STS
1834
2097
  req.send_request(options)
1835
2098
  end
1836
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
+
1837
2140
  # Returns a set of temporary security credentials (consisting of an
1838
2141
  # access key ID, a secret access key, and a security token) for a user.
1839
2142
  # A typical use is in a proxy application that gets temporary security
@@ -1846,8 +2149,8 @@ module Aws::STS
1846
2149
  # usually in a server-based application. For a comparison of
1847
2150
  # `GetFederationToken` with the other API operations that produce
1848
2151
  # temporary credentials, see [Requesting Temporary Security
1849
- # Credentials][1] and [Comparing the Amazon Web Services STS API
1850
- # operations][2] in the *IAM User Guide*.
2152
+ # Credentials][1] and [Compare STS credentials][2] in the *IAM User
2153
+ # Guide*.
1851
2154
  #
1852
2155
  # Although it is possible to call `GetFederationToken` using the
1853
2156
  # security credentials of an Amazon Web Services account root user
@@ -1944,7 +2247,7 @@ module Aws::STS
1944
2247
  #
1945
2248
  #
1946
2249
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
1947
- # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison
2250
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html
1948
2251
  # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials
1949
2252
  # [4]: http://aws.amazon.com/cognito/
1950
2253
  # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity
@@ -2116,7 +2419,7 @@ module Aws::STS
2116
2419
  # resp = client.get_federation_token({
2117
2420
  # duration_seconds: 3600,
2118
2421
  # name: "testFedUserSession",
2119
- # policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Stmt1\",\"Effect\":\"Allow\",\"Action\":\"s3:ListAllMyBuckets\",\"Resource\":\"*\"}]}",
2422
+ # policy: "escaped-JSON-IAM-POLICY",
2120
2423
  # tags: [
2121
2424
  # {
2122
2425
  # key: "Project",
@@ -2196,8 +2499,8 @@ module Aws::STS
2196
2499
  # An incorrect MFA code causes the API to return an access denied error.
2197
2500
  # For a comparison of `GetSessionToken` with the other API operations
2198
2501
  # that produce temporary credentials, see [Requesting Temporary Security
2199
- # Credentials][1] and [Comparing the Amazon Web Services STS API
2200
- # operations][2] in the *IAM User Guide*.
2502
+ # Credentials][1] and [Compare STS credentials][2] in the *IAM User
2503
+ # Guide*.
2201
2504
  #
2202
2505
  # <note markdown="1"> No permissions are required for users to perform this operation. The
2203
2506
  # purpose of the `sts:GetSessionToken` operation is to authenticate the
@@ -2252,7 +2555,7 @@ module Aws::STS
2252
2555
  #
2253
2556
  #
2254
2557
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
2255
- # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison
2558
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html
2256
2559
  # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getsessiontoken.html
2257
2560
  # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials
2258
2561
  # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken
@@ -2339,20 +2642,90 @@ module Aws::STS
2339
2642
  req.send_request(options)
2340
2643
  end
2341
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
+
2342
2710
  # @!endgroup
2343
2711
 
2344
2712
  # @param params ({})
2345
2713
  # @api private
2346
2714
  def build_request(operation_name, params = {})
2347
2715
  handlers = @handlers.for(operation_name)
2716
+ tracer = config.telemetry_provider.tracer_provider.tracer(
2717
+ Aws::Telemetry.module_to_tracer_name('Aws::STS')
2718
+ )
2348
2719
  context = Seahorse::Client::RequestContext.new(
2349
2720
  operation_name: operation_name,
2350
2721
  operation: config.api.operation(operation_name),
2351
2722
  client: self,
2352
2723
  params: params,
2353
- config: config)
2724
+ config: config,
2725
+ tracer: tracer
2726
+ )
2354
2727
  context[:gem_name] = 'aws-sdk-core'
2355
- context[:gem_version] = '3.190.2'
2728
+ context[:gem_version] = '3.240.0'
2356
2729
  Seahorse::Client::Request.new(handlers, context)
2357
2730
  end
2358
2731