class Aws::SSO::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::SSO::Client.new(
An API client for SSO. To construct a client, you need to configure a ‘:region` and `:credentials`.
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.187.1' Seahorse::Client::Request.new(handlers, context) end
def errors_module
- Api: - private
def errors_module Errors end
def get_role_credentials(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
get_role_credentials(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/GetRoleCredentials - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::GetRoleCredentialsResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:access_token(required, String) -- -
:account_id(required, String) -- -
:role_name(required, String) --
def get_role_credentials(params = {}, options = {}) req = build_request(:get_role_credentials, params) req.send_request(options) end
def initialize(*args)
(**options)-
:ssl_ca_directory(String) -- Full path of the -
:ssl_ca_bundle(String) -- Full path to the SSL -
:ssl_verify_peer(Boolean) -- When `true`, -
:http_wire_trace(Boolean) -- When `true`, -
:ssl_timeout(Float) -- Sets the SSL timeout -
:http_continue_timeout(Float) -- The number of -
:http_idle_timeout(Float) -- The number of -
:http_read_timeout(Float) -- The default -
:http_open_timeout(Float) -- The number of -
:http_proxy(URI::HTTP, String) -- A proxy to send -
:endpoint_provider(Aws::SSO::EndpointProvider) -- -
:validate_params(Boolean) -- -
:use_fips_endpoint(Boolean) -- -
:use_dualstack_endpoint(Boolean) -- -
:token_provider(Aws::TokenProvider) -- -
:stub_responses(Boolean) -- -
: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) -- -
: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 list_account_roles(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
list_account_roles(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/ListAccountRoles - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ListAccountRolesResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:account_id(required, String) -- -
:access_token(required, String) -- -
:max_results(Integer) -- -
:next_token(String) --
def list_account_roles(params = {}, options = {}) req = build_request(:list_account_roles, params) req.send_request(options) end
def list_accounts(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
list_accounts(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/ListAccounts - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ListAccountsResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:access_token(required, String) -- -
:max_results(Integer) -- -
:next_token(String) --
def list_accounts(params = {}, options = {}) req = build_request(:list_accounts, params) req.send_request(options) end
def logout(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
logout(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/Logout - AWS API Documentation
Other tags:
- Example: Request syntax with placeholder values -
Returns:
-
(Struct)- Returns an empty {Seahorse::Client::Response response}.
Options Hash:
(**params)-
:access_token(required, String) --
def logout(params = {}, options = {}) req = build_request(:logout, params) req.send_request(options) end
def waiter_names
Other tags:
- Api: - private
def waiter_names [] end