class Aws::STS::Client
See {#initialize} for a full list of supported configuration options.
the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
For details on configuring region and credentials see
)
# …
credentials: credentials,
region: region_name,
client = Aws::STS::Client.new(
An API client for STS. To construct a client, you need to configure a ‘:region` and `:credentials`.
def assume_role(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
assume_role(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRole - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To assume a role -
Returns:
-
(Types::AssumeRoleResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:provided_contexts(Array) -- -
:source_identity(String) -- -
:token_code(String) -- -
:serial_number(String) -- -
:external_id(String) -- -
:transitive_tag_keys(Array) -- -
:tags(Array) -- -
:duration_seconds(Integer) -- -
:policy(String) -- -
:policy_arns(Array) -- -
:role_session_name(required, String) -- -
:role_arn(required, String) --
def assume_role(params = {}, options = {}) req = build_request(:assume_role, params) req.send_request(options) end
def assume_role_with_saml(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
assume_role_with_saml(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAML - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To assume a role using a SAML assertion -
Returns:
-
(Types::AssumeRoleWithSAMLResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:duration_seconds(Integer) -- -
:policy(String) -- -
:policy_arns(Array) -- -
:saml_assertion(required, String) -- -
:principal_arn(required, String) -- -
:role_arn(required, String) --
def assume_role_with_saml(params = {}, options = {}) req = build_request(:assume_role_with_saml, params) req.send_request(options) end
def assume_role_with_web_identity(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
assume_role_with_web_identity(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentity - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To assume a role as an OpenID Connect-federated user -
Returns:
-
(Types::AssumeRoleWithWebIdentityResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:duration_seconds(Integer) -- -
:policy(String) -- -
:policy_arns(Array) -- -
:provider_id(String) -- -
:web_identity_token(required, String) -- -
:role_session_name(required, String) -- -
:role_arn(required, String) --
def assume_role_with_web_identity(params = {}, options = {}) req = build_request(:assume_role_with_web_identity, params) req.send_request(options) end
def build_request(operation_name, params = {})
- Api: - private
Parameters:
-
params({}) --
def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-core' context[:gem_version] = '3.196.0' Seahorse::Client::Request.new(handlers, context) end
def decode_authorization_message(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
decode_authorization_message(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/DecodeAuthorizationMessage - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To decode information about an authorization status of a request -
Returns:
-
(Types::DecodeAuthorizationMessageResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:encoded_message(required, String) --
def decode_authorization_message(params = {}, options = {}) req = build_request(:decode_authorization_message, params) req.send_request(options) end
def errors_module
- Api: - private
def errors_module Errors end
def get_access_key_info(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
get_access_key_info(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetAccessKeyInfo - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::GetAccessKeyInfoResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:access_key_id(required, String) --
def get_access_key_info(params = {}, options = {}) req = build_request(:get_access_key_info, params) req.send_request(options) end
def get_caller_identity(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
get_caller_identity(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetCallerIdentity - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Example: To get details about a calling user federated with GetFederationToken -
Example: Example: To get details about a calling user federated with AssumeRole -
Example: Example: To get details about a calling IAM user -
Returns:
-
(Types::GetCallerIdentityResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
def get_caller_identity(params = {}, options = {}) req = build_request(:get_caller_identity, params) req.send_request(options) end
def get_federation_token(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
get_federation_token(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetFederationToken - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To get temporary credentials for a role by using GetFederationToken -
Returns:
-
(Types::GetFederationTokenResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:tags(Array) -- -
:duration_seconds(Integer) -- -
:policy_arns(Array) -- -
:policy(String) -- -
:name(required, String) --
def get_federation_token(params = {}, options = {}) req = build_request(:get_federation_token, params) req.send_request(options) end
def get_session_token(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
get_session_token(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To get temporary credentials for an IAM user or an AWS account -
Returns:
-
(Types::GetSessionTokenResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:token_code(String) -- -
:serial_number(String) -- -
:duration_seconds(Integer) --
def get_session_token(params = {}, options = {}) req = build_request(:get_session_token, params) req.send_request(options) end
def initialize(*args)
(**options)-
:ssl_verify_peer(Boolean) -- -
:ssl_timeout(Float) -- -
:ssl_ca_store(String) -- -
:ssl_ca_directory(String) -- -
:ssl_ca_bundle(String) -- -
:raise_response_errors(Boolean) -- -
:on_chunk_sent(Proc) -- -
:on_chunk_received(Proc) -- -
:http_wire_trace(Boolean) -- -
:http_read_timeout(Float) -- -
:http_proxy(URI::HTTP, String) -- -
:http_open_timeout(Float) -- -
:http_idle_timeout(Float) -- -
:http_continue_timeout(Float) -- -
:endpoint_provider(Aws::STS::EndpointProvider) -- -
:validate_params(Boolean) -- -
:use_fips_endpoint(Boolean) -- -
:use_dualstack_endpoint(Boolean) -- -
:token_provider(Aws::TokenProvider) -- -
:stub_responses(Boolean) -- -
:sts_regional_endpoints(String) -- -
:session_token(String) -- -
:secret_access_key(String) -- -
:sdk_ua_app_id(String) -- -
:retry_mode(String) -- -
:retry_max_delay(Integer) -- -
:retry_limit(Integer) -- -
:retry_jitter(Symbol) -- -
:retry_base_delay(Float) -- -
:retry_backoff(Proc) -- -
:request_min_compression_size_bytes(Integer) -- -
:profile(String) -- -
:max_attempts(Integer) -- -
:logger(Logger) -- -
:log_level(Symbol) -- -
:log_formatter(Aws::Log::Formatter) -- -
:ignore_configured_endpoint_urls(Boolean) -- -
:endpoint_discovery(Boolean) -- -
:endpoint_cache_poll_interval(Integer) -- -
:endpoint_cache_max_threads(Integer) -- -
:endpoint_cache_max_entries(Integer) -- -
:endpoint(String, URI::HTTPS, URI::HTTP) -- -
:disable_request_compression(Boolean) -- -
:disable_host_prefix_injection(Boolean) -- -
:defaults_mode(String) -- -
:correct_clock_skew(Boolean) -- -
:convert_params(Boolean) -- -
:client_side_monitoring_publisher(Aws::ClientSideMonitoring::Publisher) -- -
:client_side_monitoring_port(Integer) -- -
:client_side_monitoring_host(String) -- -
:client_side_monitoring_client_id(String) -- -
:client_side_monitoring(Boolean) -- -
:adaptive_retry_wait_to_fill(Boolean) -- -
:active_endpoint_cache(Boolean) -- -
:access_key_id(String) -- -
:region(required, String) -- -
:credentials(required, Aws::CredentialProvider) --
Other tags:
- See: https://www.awsarchitectureblog.com/2015/03/backoff.html -
Parameters:
-
options(Hash) --
Overloads:
-
initialize(options)
def initialize(*args) super end
def waiter_names
Other tags:
- Api: - private
def waiter_names [] end