aws-sdk-core 3.124.0 → 3.186.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +552 -0
- data/VERSION +1 -1
- data/lib/aws-defaults/default_configuration.rb +153 -0
- data/lib/aws-defaults/defaults_mode_config_resolver.rb +107 -0
- data/lib/aws-defaults.rb +3 -0
- data/lib/aws-sdk-core/arn.rb +13 -0
- data/lib/aws-sdk-core/assume_role_credentials.rb +21 -7
- data/lib/aws-sdk-core/assume_role_web_identity_credentials.rb +14 -10
- data/lib/aws-sdk-core/binary/encode_handler.rb +12 -1
- data/lib/aws-sdk-core/client_stubs.rb +5 -1
- data/lib/aws-sdk-core/credential_provider.rb +3 -0
- data/lib/aws-sdk-core/credential_provider_chain.rb +8 -5
- data/lib/aws-sdk-core/ec2_metadata.rb +3 -2
- data/lib/aws-sdk-core/ecs_credentials.rb +121 -53
- data/lib/aws-sdk-core/endpoints/condition.rb +41 -0
- data/lib/aws-sdk-core/endpoints/endpoint.rb +17 -0
- data/lib/aws-sdk-core/endpoints/endpoint_rule.rb +75 -0
- data/lib/aws-sdk-core/endpoints/error_rule.rb +42 -0
- data/lib/aws-sdk-core/endpoints/function.rb +80 -0
- data/lib/aws-sdk-core/endpoints/matchers.rb +131 -0
- data/lib/aws-sdk-core/endpoints/reference.rb +31 -0
- data/lib/aws-sdk-core/endpoints/rule.rb +25 -0
- data/lib/aws-sdk-core/endpoints/rule_set.rb +52 -0
- data/lib/aws-sdk-core/endpoints/rules_provider.rb +37 -0
- data/lib/aws-sdk-core/endpoints/templater.rb +58 -0
- data/lib/aws-sdk-core/endpoints/tree_rule.rb +45 -0
- data/lib/aws-sdk-core/endpoints/url.rb +60 -0
- data/lib/aws-sdk-core/endpoints.rb +78 -0
- data/lib/aws-sdk-core/errors.rb +15 -2
- data/lib/aws-sdk-core/ini_parser.rb +7 -0
- data/lib/aws-sdk-core/instance_profile_credentials.rb +124 -31
- data/lib/aws-sdk-core/json/error_handler.rb +20 -1
- data/lib/aws-sdk-core/json/parser.rb +1 -1
- data/lib/aws-sdk-core/log/formatter.rb +6 -0
- data/lib/aws-sdk-core/pageable_response.rb +81 -32
- data/lib/aws-sdk-core/param_validator.rb +2 -2
- data/lib/aws-sdk-core/plugins/bearer_authorization.rb +67 -0
- data/lib/aws-sdk-core/plugins/checksum_algorithm.rb +340 -0
- data/lib/aws-sdk-core/plugins/credentials_configuration.rb +24 -0
- data/lib/aws-sdk-core/plugins/defaults_mode.rb +40 -0
- data/lib/aws-sdk-core/plugins/endpoint_discovery.rb +6 -2
- data/lib/aws-sdk-core/plugins/http_checksum.rb +8 -1
- data/lib/aws-sdk-core/plugins/jsonvalue_converter.rb +34 -6
- data/lib/aws-sdk-core/plugins/recursion_detection.rb +38 -0
- data/lib/aws-sdk-core/plugins/regional_endpoint.rb +111 -30
- data/lib/aws-sdk-core/plugins/request_compression.rb +217 -0
- data/lib/aws-sdk-core/plugins/response_paging.rb +1 -1
- data/lib/aws-sdk-core/plugins/retries/error_inspector.rb +7 -4
- data/lib/aws-sdk-core/plugins/retry_errors.rb +21 -5
- data/lib/aws-sdk-core/plugins/sign.rb +201 -0
- data/lib/aws-sdk-core/plugins/signature_v2.rb +1 -0
- data/lib/aws-sdk-core/plugins/signature_v4.rb +15 -8
- data/lib/aws-sdk-core/plugins/stub_responses.rb +5 -1
- data/lib/aws-sdk-core/plugins/user_agent.rb +117 -14
- data/lib/aws-sdk-core/process_credentials.rb +9 -11
- data/lib/aws-sdk-core/refreshing_credentials.rb +41 -16
- data/lib/aws-sdk-core/refreshing_token.rb +71 -0
- data/lib/aws-sdk-core/rest/handler.rb +1 -1
- data/lib/aws-sdk-core/rest/request/headers.rb +11 -8
- data/lib/aws-sdk-core/rest/request/querystring_builder.rb +43 -29
- data/lib/aws-sdk-core/shared_config.rb +108 -12
- data/lib/aws-sdk-core/sso_credentials.rb +91 -50
- data/lib/aws-sdk-core/sso_token_provider.rb +135 -0
- data/lib/aws-sdk-core/static_token_provider.rb +14 -0
- data/lib/aws-sdk-core/structure.rb +6 -4
- data/lib/aws-sdk-core/stubbing/stub_data.rb +11 -0
- data/lib/aws-sdk-core/token.rb +31 -0
- data/lib/aws-sdk-core/token_provider.rb +15 -0
- data/lib/aws-sdk-core/token_provider_chain.rb +51 -0
- data/lib/aws-sdk-core/waiters/poller.rb +3 -1
- data/lib/aws-sdk-core/xml/error_handler.rb +7 -0
- data/lib/aws-sdk-core/xml/parser/engines/oga.rb +2 -0
- data/lib/aws-sdk-core/xml/parser/engines/ox.rb +1 -1
- data/lib/aws-sdk-core.rb +17 -0
- data/lib/aws-sdk-sso/client.rb +85 -12
- data/lib/aws-sdk-sso/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-sso/endpoint_provider.rb +57 -0
- data/lib/aws-sdk-sso/endpoints.rb +72 -0
- data/lib/aws-sdk-sso/plugins/endpoints.rb +76 -0
- data/lib/aws-sdk-sso/types.rb +8 -43
- data/lib/aws-sdk-sso.rb +5 -1
- data/lib/aws-sdk-ssooidc/client.rb +626 -0
- data/lib/aws-sdk-ssooidc/client_api.rb +216 -0
- data/lib/aws-sdk-ssooidc/customizations.rb +1 -0
- data/lib/aws-sdk-ssooidc/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-ssooidc/endpoint_provider.rb +57 -0
- data/lib/aws-sdk-ssooidc/endpoints.rb +58 -0
- data/lib/aws-sdk-ssooidc/errors.rb +290 -0
- data/lib/aws-sdk-ssooidc/plugins/endpoints.rb +74 -0
- data/lib/aws-sdk-ssooidc/resource.rb +26 -0
- data/lib/aws-sdk-ssooidc/types.rb +502 -0
- data/lib/aws-sdk-ssooidc.rb +59 -0
- data/lib/aws-sdk-sts/client.rb +332 -263
- data/lib/aws-sdk-sts/client_api.rb +12 -1
- data/lib/aws-sdk-sts/endpoint_parameters.rb +78 -0
- data/lib/aws-sdk-sts/endpoint_provider.rb +112 -0
- data/lib/aws-sdk-sts/endpoints.rb +136 -0
- data/lib/aws-sdk-sts/plugins/endpoints.rb +84 -0
- data/lib/aws-sdk-sts/plugins/sts_regional_endpoints.rb +5 -1
- data/lib/aws-sdk-sts/presigner.rb +13 -15
- data/lib/aws-sdk-sts/types.rb +121 -204
- data/lib/aws-sdk-sts.rb +5 -1
- data/lib/seahorse/client/async_base.rb +0 -1
- data/lib/seahorse/client/configuration.rb +1 -5
- data/lib/seahorse/client/h2/connection.rb +12 -11
- data/lib/seahorse/client/net_http/connection_pool.rb +7 -0
- data/lib/seahorse/client/plugins/net_http.rb +33 -2
- data/lib/seahorse/client/plugins/request_callback.rb +40 -9
- data/lib/seahorse/client/response.rb +6 -0
- data/lib/seahorse/model/operation.rb +6 -0
- data/lib/seahorse/util.rb +4 -0
- metadata +62 -8
data/lib/aws-sdk-sts/client.rb
CHANGED
@@ -27,7 +27,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
-
require 'aws-sdk-core/plugins/
|
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'
|
31
35
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
32
36
|
require 'aws-sdk-sts/plugins/sts_regional_endpoints.rb'
|
33
37
|
|
@@ -74,9 +78,14 @@ module Aws::STS
|
|
74
78
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
75
79
|
add_plugin(Aws::Plugins::TransferEncoding)
|
76
80
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
-
add_plugin(Aws::Plugins::
|
81
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
82
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
83
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
84
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
85
|
+
add_plugin(Aws::Plugins::Sign)
|
78
86
|
add_plugin(Aws::Plugins::Protocols::Query)
|
79
87
|
add_plugin(Aws::STS::Plugins::STSRegionalEndpoints)
|
88
|
+
add_plugin(Aws::STS::Plugins::Endpoints)
|
80
89
|
|
81
90
|
# @overload initialize(options)
|
82
91
|
# @param [Hash] options
|
@@ -177,10 +186,18 @@ module Aws::STS
|
|
177
186
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
178
187
|
# a clock skew correction and retry requests with skewed client clocks.
|
179
188
|
#
|
189
|
+
# @option options [String] :defaults_mode ("legacy")
|
190
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
191
|
+
# accepted modes and the configuration defaults that are included.
|
192
|
+
#
|
180
193
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
181
194
|
# Set to true to disable SDK automatically adding host prefix
|
182
195
|
# to default service endpoint when available.
|
183
196
|
#
|
197
|
+
# @option options [Boolean] :disable_request_compression (false)
|
198
|
+
# When set to 'true' the request body will not be compressed
|
199
|
+
# for supported operations.
|
200
|
+
#
|
184
201
|
# @option options [String] :endpoint
|
185
202
|
# The client endpoint is normally constructed from the `:region`
|
186
203
|
# option. You should only configure an `:endpoint` when connecting
|
@@ -201,6 +218,10 @@ module Aws::STS
|
|
201
218
|
# @option options [Boolean] :endpoint_discovery (false)
|
202
219
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
203
220
|
#
|
221
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
222
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
223
|
+
# variables and the shared configuration file.
|
224
|
+
#
|
204
225
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
205
226
|
# The log formatter.
|
206
227
|
#
|
@@ -221,6 +242,11 @@ module Aws::STS
|
|
221
242
|
# Used when loading credentials from the shared credentials file
|
222
243
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
223
244
|
#
|
245
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
246
|
+
# The minimum size in bytes that triggers compression for request
|
247
|
+
# bodies. The value must be non-negative integer value between 0
|
248
|
+
# and 10485780 bytes inclusive.
|
249
|
+
#
|
224
250
|
# @option options [Proc] :retry_backoff
|
225
251
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
226
252
|
# This option is only used in the `legacy` retry mode.
|
@@ -266,6 +292,11 @@ module Aws::STS
|
|
266
292
|
# in the future.
|
267
293
|
#
|
268
294
|
#
|
295
|
+
# @option options [String] :sdk_ua_app_id
|
296
|
+
# 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.
|
299
|
+
#
|
269
300
|
# @option options [String] :secret_access_key
|
270
301
|
#
|
271
302
|
# @option options [String] :session_token
|
@@ -284,6 +315,19 @@ module Aws::STS
|
|
284
315
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
285
316
|
# requests are made, and retries are disabled.
|
286
317
|
#
|
318
|
+
# @option options [Aws::TokenProvider] :token_provider
|
319
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
320
|
+
# following classes:
|
321
|
+
#
|
322
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
323
|
+
# tokens.
|
324
|
+
#
|
325
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
326
|
+
# access token generated from `aws login`.
|
327
|
+
#
|
328
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
329
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
330
|
+
#
|
287
331
|
# @option options [Boolean] :use_dualstack_endpoint
|
288
332
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
289
333
|
# will be used if available.
|
@@ -297,6 +341,9 @@ module Aws::STS
|
|
297
341
|
# When `true`, request parameters are validated before
|
298
342
|
# sending the request.
|
299
343
|
#
|
344
|
+
# @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
|
+
#
|
300
347
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
301
348
|
# requests through. Formatted like 'http://proxy.com:123'.
|
302
349
|
#
|
@@ -304,7 +351,7 @@ module Aws::STS
|
|
304
351
|
# seconds to wait when opening a HTTP session before raising a
|
305
352
|
# `Timeout::Error`.
|
306
353
|
#
|
307
|
-
# @option options [
|
354
|
+
# @option options [Float] :http_read_timeout (60) The default
|
308
355
|
# number of seconds to wait for response data. This value can
|
309
356
|
# safely be set per-request on the session.
|
310
357
|
#
|
@@ -320,6 +367,9 @@ module Aws::STS
|
|
320
367
|
# disables this behaviour. This value can safely be set per
|
321
368
|
# request on the session.
|
322
369
|
#
|
370
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
371
|
+
# in seconds.
|
372
|
+
#
|
323
373
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
324
374
|
# HTTP debug output will be sent to the `:logger`.
|
325
375
|
#
|
@@ -346,14 +396,13 @@ module Aws::STS
|
|
346
396
|
# @!group API Operations
|
347
397
|
|
348
398
|
# Returns a set of temporary security credentials that you can use to
|
349
|
-
# access Amazon Web Services resources
|
350
|
-
#
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
# operations][2] in the *IAM User Guide*.
|
399
|
+
# access Amazon Web Services resources. These temporary credentials
|
400
|
+
# consist of an access key ID, a secret access key, and a security
|
401
|
+
# token. Typically, you use `AssumeRole` within your account or for
|
402
|
+
# cross-account access. For a comparison of `AssumeRole` with other API
|
403
|
+
# 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*.
|
357
406
|
#
|
358
407
|
# **Permissions**
|
359
408
|
#
|
@@ -364,23 +413,24 @@ module Aws::STS
|
|
364
413
|
#
|
365
414
|
# (Optional) You can pass inline or managed [session policies][3] to
|
366
415
|
# this operation. You can pass a single JSON policy document to use as
|
367
|
-
# an inline session policy. You can also specify up to 10 managed
|
368
|
-
#
|
369
|
-
# use for both inline and managed session policies
|
370
|
-
# characters. Passing policies to this operation
|
371
|
-
# credentials. The resulting session's
|
372
|
-
# of the role's identity-based policy
|
373
|
-
# use the role's temporary
|
374
|
-
# Services API calls to access
|
375
|
-
# role. You cannot use session
|
376
|
-
#
|
377
|
-
#
|
378
|
-
# User Guide*.
|
379
|
-
#
|
380
|
-
# When you create a role, you create two policies:
|
381
|
-
# that specifies *who* can assume the role and a permissions policy
|
382
|
-
# specifies *what* can be done with the role. You specify the
|
383
|
-
# principal
|
416
|
+
# an inline session policy. You can also specify up to 10 managed policy
|
417
|
+
# Amazon Resource Names (ARNs) to use as managed session policies. The
|
418
|
+
# plaintext that you use for both inline and managed session policies
|
419
|
+
# can't exceed 2,048 characters. Passing policies to this operation
|
420
|
+
# returns new temporary credentials. The resulting session's
|
421
|
+
# permissions are the intersection of the role's identity-based policy
|
422
|
+
# and the session policies. You can use the role's temporary
|
423
|
+
# credentials in subsequent Amazon Web Services API calls to access
|
424
|
+
# resources in the account that owns the role. You cannot use session
|
425
|
+
# policies to grant more permissions than those allowed by the
|
426
|
+
# identity-based policy of the role that is being assumed. For more
|
427
|
+
# information, see [Session Policies][3] in the *IAM User Guide*.
|
428
|
+
#
|
429
|
+
# When you create a role, you create two policies: a role trust policy
|
430
|
+
# that specifies *who* can assume the role, and a permissions policy
|
431
|
+
# that specifies *what* can be done with the role. You specify the
|
432
|
+
# trusted principal that is allowed to assume the role in the role trust
|
433
|
+
# policy.
|
384
434
|
#
|
385
435
|
# To assume a role from a different account, your Amazon Web Services
|
386
436
|
# account must be trusted by the role. The trust relationship is defined
|
@@ -389,10 +439,9 @@ module Aws::STS
|
|
389
439
|
# users in the account.
|
390
440
|
#
|
391
441
|
# A user who wants to access a role in a different account must also
|
392
|
-
# have permissions that are delegated from the
|
393
|
-
#
|
394
|
-
#
|
395
|
-
# account.
|
442
|
+
# have permissions that are delegated from the account administrator.
|
443
|
+
# The administrator must attach a policy that allows the user to call
|
444
|
+
# `AssumeRole` for the ARN of the role in the other account.
|
396
445
|
#
|
397
446
|
# To allow a user to assume a role in the same account, you can do
|
398
447
|
# either of the following:
|
@@ -489,12 +538,12 @@ module Aws::STS
|
|
489
538
|
# about ARNs, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
490
539
|
# Service Namespaces][1] in the Amazon Web Services General Reference.
|
491
540
|
#
|
492
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
493
|
-
#
|
494
|
-
# separate limit. Your request can fail for this limit
|
495
|
-
# plaintext meets the other requirements. The
|
496
|
-
# response element indicates by percentage how close
|
497
|
-
# tags for your request are to the upper size limit.
|
541
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
542
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
543
|
+
# format that has a separate limit. Your request can fail for this limit
|
544
|
+
# even if your plaintext meets the other requirements. The
|
545
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
546
|
+
# the policies and tags for your request are to the upper size limit.
|
498
547
|
#
|
499
548
|
# </note>
|
500
549
|
#
|
@@ -534,12 +583,12 @@ module Aws::STS
|
|
534
583
|
# the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)
|
535
584
|
# characters.
|
536
585
|
#
|
537
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
538
|
-
#
|
539
|
-
# separate limit. Your request can fail for this limit
|
540
|
-
# plaintext meets the other requirements. The
|
541
|
-
# response element indicates by percentage how close
|
542
|
-
# tags for your request are to the upper size limit.
|
586
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
587
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
588
|
+
# format that has a separate limit. Your request can fail for this limit
|
589
|
+
# even if your plaintext meets the other requirements. The
|
590
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
591
|
+
# the policies and tags for your request are to the upper size limit.
|
543
592
|
#
|
544
593
|
# </note>
|
545
594
|
#
|
@@ -597,12 +646,12 @@ module Aws::STS
|
|
597
646
|
# can’t exceed 256 characters. For these and additional limits, see [IAM
|
598
647
|
# and STS Character Limits][2] in the *IAM User Guide*.
|
599
648
|
#
|
600
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
601
|
-
#
|
602
|
-
# separate limit. Your request can fail for this limit
|
603
|
-
# plaintext meets the other requirements. The
|
604
|
-
# response element indicates by percentage how close
|
605
|
-
# tags for your request are to the upper size limit.
|
649
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
650
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
651
|
+
# format that has a separate limit. Your request can fail for this limit
|
652
|
+
# even if your plaintext meets the other requirements. The
|
653
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
654
|
+
# the policies and tags for your request are to the upper size limit.
|
606
655
|
#
|
607
656
|
# </note>
|
608
657
|
#
|
@@ -628,7 +677,7 @@ module Aws::STS
|
|
628
677
|
#
|
629
678
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html
|
630
679
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length
|
631
|
-
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
680
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_ctlogs
|
632
681
|
#
|
633
682
|
# @option params [Array<String>] :transitive_tag_keys
|
634
683
|
# A list of keys for session tags that you want to set as transitive. If
|
@@ -717,6 +766,9 @@ module Aws::STS
|
|
717
766
|
#
|
718
767
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html
|
719
768
|
#
|
769
|
+
# @option params [Array<Types::ProvidedContext>] :provided_contexts
|
770
|
+
# Reserved for future use.
|
771
|
+
#
|
720
772
|
# @return [Types::AssumeRoleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
721
773
|
#
|
722
774
|
# * {Types::AssumeRoleResponse#credentials #credentials} => Types::Credentials
|
@@ -777,7 +829,7 @@ module Aws::STS
|
|
777
829
|
# arn: "arnType",
|
778
830
|
# },
|
779
831
|
# ],
|
780
|
-
# policy: "
|
832
|
+
# policy: "unrestrictedSessionPolicyDocumentType",
|
781
833
|
# duration_seconds: 1,
|
782
834
|
# tags: [
|
783
835
|
# {
|
@@ -790,6 +842,12 @@ module Aws::STS
|
|
790
842
|
# serial_number: "serialNumberType",
|
791
843
|
# token_code: "tokenCodeType",
|
792
844
|
# source_identity: "sourceIdentityType",
|
845
|
+
# provided_contexts: [
|
846
|
+
# {
|
847
|
+
# provider_arn: "arnType",
|
848
|
+
# context_assertion: "contextAssertionType",
|
849
|
+
# },
|
850
|
+
# ],
|
793
851
|
# })
|
794
852
|
#
|
795
853
|
# @example Response structure
|
@@ -865,18 +923,18 @@ module Aws::STS
|
|
865
923
|
#
|
866
924
|
# (Optional) You can pass inline or managed [session policies][6] to
|
867
925
|
# this operation. You can pass a single JSON policy document to use as
|
868
|
-
# an inline session policy. You can also specify up to 10 managed
|
869
|
-
#
|
870
|
-
# use for both inline and managed session policies
|
871
|
-
# characters. Passing policies to this operation
|
872
|
-
# credentials. The resulting session's
|
873
|
-
# of the role's identity-based policy
|
874
|
-
# use the role's temporary
|
875
|
-
# Services API calls to access
|
876
|
-
# role. You cannot use session
|
877
|
-
#
|
878
|
-
#
|
879
|
-
# User Guide*.
|
926
|
+
# an inline session policy. You can also specify up to 10 managed policy
|
927
|
+
# Amazon Resource Names (ARNs) to use as managed session policies. The
|
928
|
+
# plaintext that you use for both inline and managed session policies
|
929
|
+
# can't exceed 2,048 characters. Passing policies to this operation
|
930
|
+
# returns new temporary credentials. The resulting session's
|
931
|
+
# permissions are the intersection of the role's identity-based policy
|
932
|
+
# and the session policies. You can use the role's temporary
|
933
|
+
# credentials in subsequent Amazon Web Services API calls to access
|
934
|
+
# resources in the account that owns the role. You cannot use session
|
935
|
+
# policies to grant more permissions than those allowed by the
|
936
|
+
# identity-based policy of the role that is being assumed. For more
|
937
|
+
# information, see [Session Policies][6] in the *IAM User Guide*.
|
880
938
|
#
|
881
939
|
# Calling `AssumeRoleWithSAML` does not require the use of Amazon Web
|
882
940
|
# Services security credentials. The identity of the caller is validated
|
@@ -902,12 +960,12 @@ module Aws::STS
|
|
902
960
|
# characters. For these and additional limits, see [IAM and STS
|
903
961
|
# Character Limits][8] in the *IAM User Guide*.
|
904
962
|
#
|
905
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
906
|
-
#
|
907
|
-
# separate limit. Your request can fail for this limit
|
908
|
-
# plaintext meets the other requirements. The
|
909
|
-
# response element indicates by percentage how close
|
910
|
-
# tags for your request are to the upper size limit.
|
963
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
964
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
965
|
+
# format that has a separate limit. Your request can fail for this limit
|
966
|
+
# even if your plaintext meets the other requirements. The
|
967
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
968
|
+
# the policies and tags for your request are to the upper size limit.
|
911
969
|
#
|
912
970
|
# </note>
|
913
971
|
#
|
@@ -993,12 +1051,12 @@ module Aws::STS
|
|
993
1051
|
# about ARNs, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
994
1052
|
# Service Namespaces][1] in the Amazon Web Services General Reference.
|
995
1053
|
#
|
996
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
997
|
-
#
|
998
|
-
# separate limit. Your request can fail for this limit
|
999
|
-
# plaintext meets the other requirements. The
|
1000
|
-
# response element indicates by percentage how close
|
1001
|
-
# tags for your request are to the upper size limit.
|
1054
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
1055
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
1056
|
+
# format that has a separate limit. Your request can fail for this limit
|
1057
|
+
# even if your plaintext meets the other requirements. The
|
1058
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
1059
|
+
# the policies and tags for your request are to the upper size limit.
|
1002
1060
|
#
|
1003
1061
|
# </note>
|
1004
1062
|
#
|
@@ -1038,12 +1096,12 @@ module Aws::STS
|
|
1038
1096
|
# the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)
|
1039
1097
|
# characters.
|
1040
1098
|
#
|
1041
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
1042
|
-
#
|
1043
|
-
# separate limit. Your request can fail for this limit
|
1044
|
-
# plaintext meets the other requirements. The
|
1045
|
-
# response element indicates by percentage how close
|
1046
|
-
# tags for your request are to the upper size limit.
|
1099
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
1100
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
1101
|
+
# format that has a separate limit. Your request can fail for this limit
|
1102
|
+
# even if your plaintext meets the other requirements. The
|
1103
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
1104
|
+
# the policies and tags for your request are to the upper size limit.
|
1047
1105
|
#
|
1048
1106
|
# </note>
|
1049
1107
|
#
|
@@ -1166,20 +1224,19 @@ module Aws::STS
|
|
1166
1224
|
|
1167
1225
|
# Returns a set of temporary security credentials for users who have
|
1168
1226
|
# been authenticated in a mobile or web application with a web identity
|
1169
|
-
# provider. Example providers include
|
1170
|
-
# Facebook,
|
1227
|
+
# provider. Example providers include the OAuth 2.0 providers Login with
|
1228
|
+
# Amazon and Facebook, or any OpenID Connect-compatible identity
|
1229
|
+
# provider such as Google or [Amazon Cognito federated identities][1].
|
1171
1230
|
#
|
1172
1231
|
# <note markdown="1"> For mobile applications, we recommend that you use Amazon Cognito. You
|
1173
1232
|
# can use Amazon Cognito with the [Amazon Web Services SDK for iOS
|
1174
|
-
# Developer Guide][
|
1175
|
-
# Developer Guide][
|
1233
|
+
# Developer Guide][2] and the [Amazon Web Services SDK for Android
|
1234
|
+
# Developer Guide][3] to uniquely identify a user. You can also supply
|
1176
1235
|
# the user with a consistent identity throughout the lifetime of an
|
1177
1236
|
# application.
|
1178
1237
|
#
|
1179
|
-
# To learn more about Amazon Cognito, see [Amazon Cognito
|
1180
|
-
# in *Amazon
|
1181
|
-
# Cognito Overview][4] in the *Amazon Web Services SDK for iOS Developer
|
1182
|
-
# Guide*.
|
1238
|
+
# To learn more about Amazon Cognito, see [Amazon Cognito identity
|
1239
|
+
# pools][1] in *Amazon Cognito Developer Guide*.
|
1183
1240
|
#
|
1184
1241
|
# </note>
|
1185
1242
|
#
|
@@ -1193,8 +1250,8 @@ module Aws::STS
|
|
1193
1250
|
# a token from the web identity provider. For a comparison of
|
1194
1251
|
# `AssumeRoleWithWebIdentity` with the other API operations that produce
|
1195
1252
|
# temporary credentials, see [Requesting Temporary Security
|
1196
|
-
# Credentials][
|
1197
|
-
# operations][
|
1253
|
+
# Credentials][4] and [Comparing the Amazon Web Services STS API
|
1254
|
+
# operations][5] in the *IAM User Guide*.
|
1198
1255
|
#
|
1199
1256
|
# The temporary security credentials returned by this API consist of an
|
1200
1257
|
# access key ID, a secret access key, and a security token. Applications
|
@@ -1210,11 +1267,11 @@ module Aws::STS
|
|
1210
1267
|
# to the maximum session duration setting for the role. This setting can
|
1211
1268
|
# have a value from 1 hour to 12 hours. To learn how to view the maximum
|
1212
1269
|
# value for your role, see [View the Maximum Session Duration Setting
|
1213
|
-
# for a Role][
|
1270
|
+
# for a Role][6] in the *IAM User Guide*. The maximum session duration
|
1214
1271
|
# limit applies when you use the `AssumeRole*` API operations or the
|
1215
1272
|
# `assume-role*` CLI commands. However the limit does not apply when you
|
1216
1273
|
# use those operations to create a console URL. For more information,
|
1217
|
-
# see [Using IAM Roles][
|
1274
|
+
# see [Using IAM Roles][7] in the *IAM User Guide*.
|
1218
1275
|
#
|
1219
1276
|
# **Permissions**
|
1220
1277
|
#
|
@@ -1223,39 +1280,39 @@ module Aws::STS
|
|
1223
1280
|
# Amazon Web Services service with the following exception: you cannot
|
1224
1281
|
# call the STS `GetFederationToken` or `GetSessionToken` API operations.
|
1225
1282
|
#
|
1226
|
-
# (Optional) You can pass inline or managed [session policies][
|
1283
|
+
# (Optional) You can pass inline or managed [session policies][8] to
|
1227
1284
|
# this operation. You can pass a single JSON policy document to use as
|
1228
|
-
# an inline session policy. You can also specify up to 10 managed
|
1229
|
-
#
|
1230
|
-
# use for both inline and managed session policies
|
1231
|
-
# characters. Passing policies to this operation
|
1232
|
-
# credentials. The resulting session's
|
1233
|
-
# of the role's identity-based policy
|
1234
|
-
# use the role's temporary
|
1235
|
-
# Services API calls to access
|
1236
|
-
# role. You cannot use session
|
1237
|
-
#
|
1238
|
-
#
|
1239
|
-
# User Guide*.
|
1285
|
+
# an inline session policy. You can also specify up to 10 managed policy
|
1286
|
+
# Amazon Resource Names (ARNs) to use as managed session policies. The
|
1287
|
+
# plaintext that you use for both inline and managed session policies
|
1288
|
+
# can't exceed 2,048 characters. Passing policies to this operation
|
1289
|
+
# returns new temporary credentials. The resulting session's
|
1290
|
+
# permissions are the intersection of the role's identity-based policy
|
1291
|
+
# and the session policies. You can use the role's temporary
|
1292
|
+
# credentials in subsequent Amazon Web Services API calls to access
|
1293
|
+
# resources in the account that owns the role. You cannot use session
|
1294
|
+
# policies to grant more permissions than those allowed by the
|
1295
|
+
# identity-based policy of the role that is being assumed. For more
|
1296
|
+
# information, see [Session Policies][8] in the *IAM User Guide*.
|
1240
1297
|
#
|
1241
1298
|
# **Tags**
|
1242
1299
|
#
|
1243
1300
|
# (Optional) You can configure your IdP to pass attributes into your web
|
1244
1301
|
# identity token as session tags. Each session tag consists of a key
|
1245
1302
|
# name and an associated value. For more information about session tags,
|
1246
|
-
# see [Passing Session Tags in STS][
|
1303
|
+
# see [Passing Session Tags in STS][9] in the *IAM User Guide*.
|
1247
1304
|
#
|
1248
1305
|
# You can pass up to 50 session tags. The plaintext session tag keys
|
1249
1306
|
# can’t exceed 128 characters and the values can’t exceed 256
|
1250
1307
|
# characters. For these and additional limits, see [IAM and STS
|
1251
|
-
# Character Limits][
|
1308
|
+
# Character Limits][10] in the *IAM User Guide*.
|
1252
1309
|
#
|
1253
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
1254
|
-
#
|
1255
|
-
# separate limit. Your request can fail for this limit
|
1256
|
-
# plaintext meets the other requirements. The
|
1257
|
-
# response element indicates by percentage how close
|
1258
|
-
# tags for your request are to the upper size limit.
|
1310
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
1311
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
1312
|
+
# format that has a separate limit. Your request can fail for this limit
|
1313
|
+
# even if your plaintext meets the other requirements. The
|
1314
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
1315
|
+
# the policies and tags for your request are to the upper size limit.
|
1259
1316
|
#
|
1260
1317
|
# </note>
|
1261
1318
|
#
|
@@ -1266,12 +1323,12 @@ module Aws::STS
|
|
1266
1323
|
# An administrator must grant you the permissions necessary to pass
|
1267
1324
|
# session tags. The administrator can also create granular permissions
|
1268
1325
|
# to allow you to pass only specific session tags. For more information,
|
1269
|
-
# see [Tutorial: Using Tags for Attribute-Based Access Control][
|
1326
|
+
# see [Tutorial: Using Tags for Attribute-Based Access Control][11] in
|
1270
1327
|
# the *IAM User Guide*.
|
1271
1328
|
#
|
1272
1329
|
# You can set the session tags as transitive. Transitive tags persist
|
1273
1330
|
# during role chaining. For more information, see [Chaining Roles with
|
1274
|
-
# Session Tags][
|
1331
|
+
# Session Tags][12] in the *IAM User Guide*.
|
1275
1332
|
#
|
1276
1333
|
# **Identities**
|
1277
1334
|
#
|
@@ -1283,54 +1340,53 @@ module Aws::STS
|
|
1283
1340
|
# specified in the role's trust policy.
|
1284
1341
|
#
|
1285
1342
|
# Calling `AssumeRoleWithWebIdentity` can result in an entry in your
|
1286
|
-
# CloudTrail logs. The entry includes the [Subject][
|
1343
|
+
# CloudTrail logs. The entry includes the [Subject][13] of the provided
|
1287
1344
|
# web identity token. We recommend that you avoid using any personally
|
1288
1345
|
# identifiable information (PII) in this field. For example, you could
|
1289
1346
|
# instead use a GUID or a pairwise identifier, as [suggested in the OIDC
|
1290
|
-
# specification][
|
1347
|
+
# specification][14].
|
1291
1348
|
#
|
1292
1349
|
# For more information about how to use web identity federation and the
|
1293
1350
|
# `AssumeRoleWithWebIdentity` API, see the following resources:
|
1294
1351
|
#
|
1295
|
-
# * [Using Web Identity Federation API Operations for Mobile Apps][
|
1296
|
-
# and [Federation Through a Web-based Identity Provider][
|
1352
|
+
# * [Using Web Identity Federation API Operations for Mobile Apps][15]
|
1353
|
+
# and [Federation Through a Web-based Identity Provider][16].
|
1297
1354
|
#
|
1298
|
-
# * [ Web Identity Federation Playground][
|
1355
|
+
# * [ Web Identity Federation Playground][17]. Walk through the process
|
1299
1356
|
# of authenticating through Login with Amazon, Facebook, or Google,
|
1300
1357
|
# getting temporary security credentials, and then using those
|
1301
1358
|
# credentials to make a request to Amazon Web Services.
|
1302
1359
|
#
|
1303
|
-
# * [Amazon Web Services SDK for iOS Developer Guide][
|
1304
|
-
# Services SDK for Android Developer Guide][
|
1360
|
+
# * [Amazon Web Services SDK for iOS Developer Guide][2] and [Amazon Web
|
1361
|
+
# Services SDK for Android Developer Guide][3]. These toolkits contain
|
1305
1362
|
# sample apps that show how to invoke the identity providers. The
|
1306
1363
|
# toolkits then show how to use the information from these providers
|
1307
1364
|
# to get and use temporary security credentials.
|
1308
1365
|
#
|
1309
|
-
# * [Web Identity Federation with Mobile Applications][
|
1366
|
+
# * [Web Identity Federation with Mobile Applications][18]. This article
|
1310
1367
|
# discusses web identity federation and shows an example of how to use
|
1311
1368
|
# web identity federation to get access to content in Amazon S3.
|
1312
1369
|
#
|
1313
1370
|
#
|
1314
1371
|
#
|
1315
|
-
# [1]:
|
1316
|
-
# [2]: http://aws.amazon.com/
|
1317
|
-
# [3]:
|
1318
|
-
# [4]: https://docs.aws.amazon.com/
|
1319
|
-
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
|
1320
|
-
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
1321
|
-
# [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
|
1322
|
-
# [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
1323
|
-
# [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
1324
|
-
# [10]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
1325
|
-
# [11]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
1326
|
-
# [12]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
1327
|
-
# [13]:
|
1328
|
-
# [14]: http://openid.net/specs/openid-connect-core-1_0.html#
|
1329
|
-
# [15]:
|
1330
|
-
# [16]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
1331
|
-
# [17]: https://
|
1332
|
-
# [18]:
|
1333
|
-
# [19]: http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications
|
1372
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html
|
1373
|
+
# [2]: http://aws.amazon.com/sdkforios/
|
1374
|
+
# [3]: http://aws.amazon.com/sdkforandroid/
|
1375
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
|
1376
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison
|
1377
|
+
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session
|
1378
|
+
# [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
|
1379
|
+
# [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session
|
1380
|
+
# [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html
|
1381
|
+
# [10]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length
|
1382
|
+
# [11]: https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html
|
1383
|
+
# [12]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining
|
1384
|
+
# [13]: http://openid.net/specs/openid-connect-core-1_0.html#Claims
|
1385
|
+
# [14]: http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes
|
1386
|
+
# [15]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html
|
1387
|
+
# [16]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity
|
1388
|
+
# [17]: https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/
|
1389
|
+
# [18]: http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications
|
1334
1390
|
#
|
1335
1391
|
# @option params [required, String] :role_arn
|
1336
1392
|
# The Amazon Resource Name (ARN) of the role that the caller is
|
@@ -1354,16 +1410,17 @@ module Aws::STS
|
|
1354
1410
|
# by the identity provider. Your application must get this token by
|
1355
1411
|
# authenticating the user who is using your application with a web
|
1356
1412
|
# identity provider before the application makes an
|
1357
|
-
# `AssumeRoleWithWebIdentity` call.
|
1413
|
+
# `AssumeRoleWithWebIdentity` call. Only tokens with RSA algorithms
|
1414
|
+
# (RS256) are supported.
|
1358
1415
|
#
|
1359
1416
|
# @option params [String] :provider_id
|
1360
|
-
# The fully qualified host component of the domain name of the
|
1361
|
-
# provider.
|
1417
|
+
# The fully qualified host component of the domain name of the OAuth 2.0
|
1418
|
+
# identity provider. Do not specify this value for an OpenID Connect
|
1419
|
+
# identity provider.
|
1362
1420
|
#
|
1363
|
-
#
|
1364
|
-
#
|
1365
|
-
#
|
1366
|
-
# schemes and port numbers.
|
1421
|
+
# Currently `www.amazon.com` and `graph.facebook.com` are the only
|
1422
|
+
# supported identity providers for OAuth 2.0 access tokens. Do not
|
1423
|
+
# include URL schemes and port numbers.
|
1367
1424
|
#
|
1368
1425
|
# Do not specify this value for OpenID Connect ID tokens.
|
1369
1426
|
#
|
@@ -1378,12 +1435,12 @@ module Aws::STS
|
|
1378
1435
|
# about ARNs, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
1379
1436
|
# Service Namespaces][1] in the Amazon Web Services General Reference.
|
1380
1437
|
#
|
1381
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
1382
|
-
#
|
1383
|
-
# separate limit. Your request can fail for this limit
|
1384
|
-
# plaintext meets the other requirements. The
|
1385
|
-
# response element indicates by percentage how close
|
1386
|
-
# tags for your request are to the upper size limit.
|
1438
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
1439
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
1440
|
+
# format that has a separate limit. Your request can fail for this limit
|
1441
|
+
# even if your plaintext meets the other requirements. The
|
1442
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
1443
|
+
# the policies and tags for your request are to the upper size limit.
|
1387
1444
|
#
|
1388
1445
|
# </note>
|
1389
1446
|
#
|
@@ -1423,12 +1480,12 @@ module Aws::STS
|
|
1423
1480
|
# the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)
|
1424
1481
|
# characters.
|
1425
1482
|
#
|
1426
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
1427
|
-
#
|
1428
|
-
# separate limit. Your request can fail for this limit
|
1429
|
-
# plaintext meets the other requirements. The
|
1430
|
-
# response element indicates by percentage how close
|
1431
|
-
# tags for your request are to the upper size limit.
|
1483
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
1484
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
1485
|
+
# format that has a separate limit. Your request can fail for this limit
|
1486
|
+
# even if your plaintext meets the other requirements. The
|
1487
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
1488
|
+
# the policies and tags for your request are to the upper size limit.
|
1432
1489
|
#
|
1433
1490
|
# </note>
|
1434
1491
|
#
|
@@ -1689,11 +1746,11 @@ module Aws::STS
|
|
1689
1746
|
# to call the operation.
|
1690
1747
|
#
|
1691
1748
|
# <note markdown="1"> No permissions are required to perform this operation. If an
|
1692
|
-
# administrator
|
1749
|
+
# administrator attaches a policy to your identity that explicitly
|
1693
1750
|
# denies access to the `sts:GetCallerIdentity` action, you can still
|
1694
1751
|
# perform this operation. Permissions are not required because the same
|
1695
|
-
# information is returned when
|
1696
|
-
#
|
1752
|
+
# information is returned when access is denied. To view an example
|
1753
|
+
# response, see [I Am Not Authorized to Perform:
|
1697
1754
|
# iam:DeleteVirtualMFADevice][1] in the *IAM User Guide*.
|
1698
1755
|
#
|
1699
1756
|
# </note>
|
@@ -1770,60 +1827,63 @@ module Aws::STS
|
|
1770
1827
|
end
|
1771
1828
|
|
1772
1829
|
# Returns a set of temporary security credentials (consisting of an
|
1773
|
-
# access key ID, a secret access key, and a security token) for a
|
1774
|
-
#
|
1775
|
-
#
|
1776
|
-
#
|
1777
|
-
#
|
1778
|
-
#
|
1779
|
-
#
|
1780
|
-
#
|
1781
|
-
#
|
1830
|
+
# access key ID, a secret access key, and a security token) for a user.
|
1831
|
+
# A typical use is in a proxy application that gets temporary security
|
1832
|
+
# credentials on behalf of distributed applications inside a corporate
|
1833
|
+
# network.
|
1834
|
+
#
|
1835
|
+
# You must call the `GetFederationToken` operation using the long-term
|
1836
|
+
# security credentials of an IAM user. As a result, this call is
|
1837
|
+
# appropriate in contexts where those credentials can be safeguarded,
|
1838
|
+
# usually in a server-based application. For a comparison of
|
1839
|
+
# `GetFederationToken` with the other API operations that produce
|
1840
|
+
# temporary credentials, see [Requesting Temporary Security
|
1782
1841
|
# Credentials][1] and [Comparing the Amazon Web Services STS API
|
1783
1842
|
# operations][2] in the *IAM User Guide*.
|
1784
1843
|
#
|
1844
|
+
# Although it is possible to call `GetFederationToken` using the
|
1845
|
+
# security credentials of an Amazon Web Services account root user
|
1846
|
+
# rather than an IAM user that you create for the purpose of a proxy
|
1847
|
+
# application, we do not recommend it. For more information, see
|
1848
|
+
# [Safeguard your root user credentials and don't use them for everyday
|
1849
|
+
# tasks][3] in the *IAM User Guide*.
|
1850
|
+
#
|
1785
1851
|
# <note markdown="1"> You can create a mobile-based or browser-based app that can
|
1786
1852
|
# authenticate users using a web identity provider like Login with
|
1787
1853
|
# Amazon, Facebook, Google, or an OpenID Connect-compatible identity
|
1788
|
-
# provider. In this case, we recommend that you use [Amazon Cognito][
|
1854
|
+
# provider. In this case, we recommend that you use [Amazon Cognito][4]
|
1789
1855
|
# or `AssumeRoleWithWebIdentity`. For more information, see [Federation
|
1790
|
-
# Through a Web-based Identity Provider][
|
1856
|
+
# Through a Web-based Identity Provider][5] in the *IAM User Guide*.
|
1791
1857
|
#
|
1792
1858
|
# </note>
|
1793
1859
|
#
|
1794
|
-
# You can also call `GetFederationToken` using the security credentials
|
1795
|
-
# of an Amazon Web Services account root user, but we do not recommend
|
1796
|
-
# it. Instead, we recommend that you create an IAM user for the purpose
|
1797
|
-
# of the proxy application. Then attach a policy to the IAM user that
|
1798
|
-
# limits federated users to only the actions and resources that they
|
1799
|
-
# need to access. For more information, see [IAM Best Practices][5] in
|
1800
|
-
# the *IAM User Guide*.
|
1801
|
-
#
|
1802
1860
|
# **Session duration**
|
1803
1861
|
#
|
1804
1862
|
# The temporary credentials are valid for the specified duration, from
|
1805
1863
|
# 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36
|
1806
1864
|
# hours). The default session duration is 43,200 seconds (12 hours).
|
1807
|
-
# Temporary credentials obtained by using the
|
1808
|
-
#
|
1809
|
-
# (1 hour).
|
1865
|
+
# Temporary credentials obtained by using the root user credentials have
|
1866
|
+
# a maximum duration of 3,600 seconds (1 hour).
|
1810
1867
|
#
|
1811
1868
|
# **Permissions**
|
1812
1869
|
#
|
1813
1870
|
# You can use the temporary credentials created by `GetFederationToken`
|
1814
|
-
# in any Amazon Web Services service
|
1871
|
+
# in any Amazon Web Services service with the following exceptions:
|
1815
1872
|
#
|
1816
1873
|
# * You cannot call any IAM operations using the CLI or the Amazon Web
|
1817
|
-
# Services API.
|
1874
|
+
# Services API. This limitation does not apply to console sessions.
|
1818
1875
|
#
|
1819
1876
|
# * You cannot call any STS operations except `GetCallerIdentity`.
|
1820
1877
|
#
|
1878
|
+
# You can use temporary credentials for single sign-on (SSO) to the
|
1879
|
+
# console.
|
1880
|
+
#
|
1821
1881
|
# You must pass an inline or managed [session policy][6] to this
|
1822
1882
|
# operation. You can pass a single JSON policy document to use as an
|
1823
|
-
# inline session policy. You can also specify up to 10 managed
|
1824
|
-
# to use as managed session policies. The
|
1825
|
-
# both inline and managed session policies
|
1826
|
-
# characters.
|
1883
|
+
# inline session policy. You can also specify up to 10 managed policy
|
1884
|
+
# Amazon Resource Names (ARNs) to use as managed session policies. The
|
1885
|
+
# plaintext that you use for both inline and managed session policies
|
1886
|
+
# can't exceed 2,048 characters.
|
1827
1887
|
#
|
1828
1888
|
# Though the session policy parameters are optional, if you do not pass
|
1829
1889
|
# a policy, then the resulting federated user session has no
|
@@ -1853,9 +1913,9 @@ module Aws::STS
|
|
1853
1913
|
# <note markdown="1"> You can create a mobile-based or browser-based app that can
|
1854
1914
|
# authenticate users using a web identity provider like Login with
|
1855
1915
|
# Amazon, Facebook, Google, or an OpenID Connect-compatible identity
|
1856
|
-
# provider. In this case, we recommend that you use [Amazon Cognito][
|
1916
|
+
# provider. In this case, we recommend that you use [Amazon Cognito][4]
|
1857
1917
|
# or `AssumeRoleWithWebIdentity`. For more information, see [Federation
|
1858
|
-
# Through a Web-based Identity Provider][
|
1918
|
+
# Through a Web-based Identity Provider][5] in the *IAM User Guide*.
|
1859
1919
|
#
|
1860
1920
|
# </note>
|
1861
1921
|
#
|
@@ -1877,9 +1937,9 @@ module Aws::STS
|
|
1877
1937
|
#
|
1878
1938
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
|
1879
1939
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison
|
1880
|
-
# [3]:
|
1881
|
-
# [4]:
|
1882
|
-
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
1940
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials
|
1941
|
+
# [4]: http://aws.amazon.com/cognito/
|
1942
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity
|
1883
1943
|
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session
|
1884
1944
|
# [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken
|
1885
1945
|
# [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html
|
@@ -1902,8 +1962,8 @@ module Aws::STS
|
|
1902
1962
|
#
|
1903
1963
|
# You must pass an inline or managed [session policy][1] to this
|
1904
1964
|
# operation. You can pass a single JSON policy document to use as an
|
1905
|
-
# inline session policy. You can also specify up to 10 managed
|
1906
|
-
# to use as managed session policies.
|
1965
|
+
# inline session policy. You can also specify up to 10 managed policy
|
1966
|
+
# Amazon Resource Names (ARNs) to use as managed session policies.
|
1907
1967
|
#
|
1908
1968
|
# This parameter is optional. However, if you do not pass any session
|
1909
1969
|
# policies, then the resulting federated user session has no
|
@@ -1931,12 +1991,12 @@ module Aws::STS
|
|
1931
1991
|
# the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)
|
1932
1992
|
# characters.
|
1933
1993
|
#
|
1934
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
1935
|
-
#
|
1936
|
-
# separate limit. Your request can fail for this limit
|
1937
|
-
# plaintext meets the other requirements. The
|
1938
|
-
# response element indicates by percentage how close
|
1939
|
-
# tags for your request are to the upper size limit.
|
1994
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
1995
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
1996
|
+
# format that has a separate limit. Your request can fail for this limit
|
1997
|
+
# even if your plaintext meets the other requirements. The
|
1998
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
1999
|
+
# the policies and tags for your request are to the upper size limit.
|
1940
2000
|
#
|
1941
2001
|
# </note>
|
1942
2002
|
#
|
@@ -1951,13 +2011,13 @@ module Aws::STS
|
|
1951
2011
|
#
|
1952
2012
|
# You must pass an inline or managed [session policy][1] to this
|
1953
2013
|
# operation. You can pass a single JSON policy document to use as an
|
1954
|
-
# inline session policy. You can also specify up to 10 managed
|
1955
|
-
# to use as managed session policies. The
|
1956
|
-
# both inline and managed session policies
|
1957
|
-
# characters. You can provide up to 10 managed
|
1958
|
-
# information about ARNs, see [Amazon Resource
|
1959
|
-
# Web Services Service Namespaces][2] in the
|
1960
|
-
# Reference.
|
2014
|
+
# inline session policy. You can also specify up to 10 managed policy
|
2015
|
+
# Amazon Resource Names (ARNs) to use as managed session policies. The
|
2016
|
+
# plaintext that you use for both inline and managed session policies
|
2017
|
+
# can't exceed 2,048 characters. You can provide up to 10 managed
|
2018
|
+
# policy ARNs. For more information about ARNs, see [Amazon Resource
|
2019
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][2] in the
|
2020
|
+
# Amazon Web Services General Reference.
|
1961
2021
|
#
|
1962
2022
|
# This parameter is optional. However, if you do not pass any session
|
1963
2023
|
# policies, then the resulting federated user session has no
|
@@ -1978,12 +2038,12 @@ module Aws::STS
|
|
1978
2038
|
# are granted in addition to the permissions that are granted by the
|
1979
2039
|
# session policies.
|
1980
2040
|
#
|
1981
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
1982
|
-
#
|
1983
|
-
# separate limit. Your request can fail for this limit
|
1984
|
-
# plaintext meets the other requirements. The
|
1985
|
-
# response element indicates by percentage how close
|
1986
|
-
# tags for your request are to the upper size limit.
|
2041
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
2042
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
2043
|
+
# format that has a separate limit. Your request can fail for this limit
|
2044
|
+
# even if your plaintext meets the other requirements. The
|
2045
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
2046
|
+
# the policies and tags for your request are to the upper size limit.
|
1987
2047
|
#
|
1988
2048
|
# </note>
|
1989
2049
|
#
|
@@ -1996,10 +2056,10 @@ module Aws::STS
|
|
1996
2056
|
# The duration, in seconds, that the session should last. Acceptable
|
1997
2057
|
# durations for federation sessions range from 900 seconds (15 minutes)
|
1998
2058
|
# to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the
|
1999
|
-
# default. Sessions obtained using
|
2000
|
-
#
|
2001
|
-
#
|
2002
|
-
#
|
2059
|
+
# default. Sessions obtained using root user credentials are restricted
|
2060
|
+
# to a maximum of 3,600 seconds (one hour). If the specified duration is
|
2061
|
+
# longer than one hour, the session obtained by using root user
|
2062
|
+
# credentials defaults to one hour.
|
2003
2063
|
#
|
2004
2064
|
# @option params [Array<Types::Tag>] :tags
|
2005
2065
|
# A list of session tags. Each session tag consists of a key name and an
|
@@ -2011,12 +2071,12 @@ module Aws::STS
|
|
2011
2071
|
# can’t exceed 256 characters. For these and additional limits, see [IAM
|
2012
2072
|
# and STS Character Limits][2] in the *IAM User Guide*.
|
2013
2073
|
#
|
2014
|
-
# <note markdown="1"> An Amazon Web Services conversion compresses the passed session
|
2015
|
-
#
|
2016
|
-
# separate limit. Your request can fail for this limit
|
2017
|
-
# plaintext meets the other requirements. The
|
2018
|
-
# response element indicates by percentage how close
|
2019
|
-
# tags for your request are to the upper size limit.
|
2074
|
+
# <note markdown="1"> An Amazon Web Services conversion compresses the passed inline session
|
2075
|
+
# policy, managed policy ARNs, and session tags into a packed binary
|
2076
|
+
# format that has a separate limit. Your request can fail for this limit
|
2077
|
+
# even if your plaintext meets the other requirements. The
|
2078
|
+
# `PackedPolicySize` response element indicates by percentage how close
|
2079
|
+
# the policies and tags for your request are to the upper size limit.
|
2020
2080
|
#
|
2021
2081
|
# </note>
|
2022
2082
|
#
|
@@ -2119,27 +2179,36 @@ module Aws::STS
|
|
2119
2179
|
# secret access key, and a security token. Typically, you use
|
2120
2180
|
# `GetSessionToken` if you want to use MFA to protect programmatic calls
|
2121
2181
|
# to specific Amazon Web Services API operations like Amazon EC2
|
2122
|
-
# `StopInstances`.
|
2123
|
-
#
|
2124
|
-
# MFA
|
2125
|
-
#
|
2126
|
-
#
|
2127
|
-
#
|
2128
|
-
#
|
2129
|
-
#
|
2182
|
+
# `StopInstances`.
|
2183
|
+
#
|
2184
|
+
# MFA-enabled IAM users must call `GetSessionToken` and submit an MFA
|
2185
|
+
# code that is associated with their MFA device. Using the temporary
|
2186
|
+
# security credentials that the call returns, IAM users can then make
|
2187
|
+
# programmatic calls to API operations that require MFA authentication.
|
2188
|
+
# An incorrect MFA code causes the API to return an access denied error.
|
2189
|
+
# For a comparison of `GetSessionToken` with the other API operations
|
2190
|
+
# that produce temporary credentials, see [Requesting Temporary Security
|
2130
2191
|
# Credentials][1] and [Comparing the Amazon Web Services STS API
|
2131
2192
|
# operations][2] in the *IAM User Guide*.
|
2132
2193
|
#
|
2194
|
+
# <note markdown="1"> No permissions are required for users to perform this operation. The
|
2195
|
+
# purpose of the `sts:GetSessionToken` operation is to authenticate the
|
2196
|
+
# user using MFA. You cannot use policies to control authentication
|
2197
|
+
# operations. For more information, see [Permissions for
|
2198
|
+
# GetSessionToken][3] in the *IAM User Guide*.
|
2199
|
+
#
|
2200
|
+
# </note>
|
2201
|
+
#
|
2133
2202
|
# **Session Duration**
|
2134
2203
|
#
|
2135
2204
|
# The `GetSessionToken` operation must be called by using the long-term
|
2136
|
-
# Amazon Web Services security credentials of
|
2137
|
-
#
|
2138
|
-
#
|
2139
|
-
#
|
2140
|
-
# (
|
2141
|
-
#
|
2142
|
-
#
|
2205
|
+
# Amazon Web Services security credentials of an IAM user. Credentials
|
2206
|
+
# that are created by IAM users are valid for the duration that you
|
2207
|
+
# specify. This duration can range from 900 seconds (15 minutes) up to a
|
2208
|
+
# maximum of 129,600 seconds (36 hours), with a default of 43,200
|
2209
|
+
# seconds (12 hours). Credentials based on account credentials can range
|
2210
|
+
# from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a
|
2211
|
+
# default of 1 hour.
|
2143
2212
|
#
|
2144
2213
|
# **Permissions**
|
2145
2214
|
#
|
@@ -2153,32 +2222,32 @@ module Aws::STS
|
|
2153
2222
|
# * You cannot call any STS API *except* `AssumeRole` or
|
2154
2223
|
# `GetCallerIdentity`.
|
2155
2224
|
#
|
2156
|
-
#
|
2157
|
-
#
|
2158
|
-
#
|
2159
|
-
#
|
2160
|
-
# with Amazon Web Services.
|
2225
|
+
# The credentials that `GetSessionToken` returns are based on
|
2226
|
+
# permissions associated with the IAM user whose credentials were used
|
2227
|
+
# to call the operation. The temporary credentials have the same
|
2228
|
+
# permissions as the IAM user.
|
2161
2229
|
#
|
2162
|
-
#
|
2230
|
+
# <note markdown="1"> Although it is possible to call `GetSessionToken` using the security
|
2231
|
+
# credentials of an Amazon Web Services account root user rather than an
|
2232
|
+
# IAM user, we do not recommend it. If `GetSessionToken` is called using
|
2233
|
+
# root user credentials, the temporary credentials have root user
|
2234
|
+
# permissions. For more information, see [Safeguard your root user
|
2235
|
+
# credentials and don't use them for everyday tasks][4] in the *IAM
|
2236
|
+
# User Guide*
|
2163
2237
|
#
|
2164
|
-
#
|
2165
|
-
# permissions associated with the user whose credentials were used to
|
2166
|
-
# call the operation. If `GetSessionToken` is called using Amazon Web
|
2167
|
-
# Services account root user credentials, the temporary credentials have
|
2168
|
-
# root user permissions. Similarly, if `GetSessionToken` is called using
|
2169
|
-
# the credentials of an IAM user, the temporary credentials have the
|
2170
|
-
# same permissions as the IAM user.
|
2238
|
+
# </note>
|
2171
2239
|
#
|
2172
2240
|
# For more information about using `GetSessionToken` to create temporary
|
2173
|
-
# credentials,
|
2174
|
-
# Environments][
|
2241
|
+
# credentials, see [Temporary Credentials for Users in Untrusted
|
2242
|
+
# Environments][5] in the *IAM User Guide*.
|
2175
2243
|
#
|
2176
2244
|
#
|
2177
2245
|
#
|
2178
2246
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html
|
2179
2247
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison
|
2180
|
-
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
2181
|
-
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/
|
2248
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getsessiontoken.html
|
2249
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials
|
2250
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken
|
2182
2251
|
#
|
2183
2252
|
# @option params [Integer] :duration_seconds
|
2184
2253
|
# The duration, in seconds, that the credentials should remain valid.
|
@@ -2275,7 +2344,7 @@ module Aws::STS
|
|
2275
2344
|
params: params,
|
2276
2345
|
config: config)
|
2277
2346
|
context[:gem_name] = 'aws-sdk-core'
|
2278
|
-
context[:gem_version] = '3.
|
2347
|
+
context[:gem_version] = '3.186.0'
|
2279
2348
|
Seahorse::Client::Request.new(handlers, context)
|
2280
2349
|
end
|
2281
2350
|
|