class Aws::SSO::Client

An API client for SSO. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::SSO::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See {#initialize} for a full list of supported configuration options.

Attributes

identifier[R]

@api private

Public Class Methods

errors_module() click to toggle source

@api private

# File lib/aws-sdk-sso/client.rb, line 688
def errors_module
  Errors
end
new(*args) click to toggle source

@overload initialize(options)

@param [Hash] options

@option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
  A list of plugins to apply to the client. Each plugin is either a
  class name or an instance of a plugin class.

@option options [required, Aws::CredentialProvider] :credentials
  Your AWS credentials. This can be an instance of any one of the
  following classes:

  * `Aws::Credentials` - Used for configuring static, non-refreshing
    credentials.

  * `Aws::SharedCredentials` - Used for loading static credentials from a
    shared file, such as `~/.aws/config`.

  * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.

  * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
    assume a role after providing credentials via the web.

  * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
    access token generated from `aws login`.

  * `Aws::ProcessCredentials` - Used for loading credentials from a
    process that outputs to stdout.

  * `Aws::InstanceProfileCredentials` - Used for loading credentials
    from an EC2 IMDS on an EC2 instance.

  * `Aws::ECSCredentials` - Used for loading credentials from
    instances running in ECS.

  * `Aws::CognitoIdentityCredentials` - Used for loading credentials
    from the Cognito Identity service.

  When `:credentials` are not configured directly, the following
  locations will be searched for credentials:

  * `Aws.config[:credentials]`
  * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
    `:account_id` options.
  * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
    ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
  * `~/.aws/credentials`
  * `~/.aws/config`
  * EC2/ECS IMDS instance profile - When used by default, the timeouts
    are very aggressive. Construct and pass an instance of
    `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
    enable retries and extended timeouts. Instance profile credential
    fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
    to true.

@option options [required, String] :region
  The AWS region to connect to.  The configured `:region` is
  used to determine the service `:endpoint`. When not passed,
  a default `:region` is searched for in the following locations:

  * `Aws.config[:region]`
  * `ENV['AWS_REGION']`
  * `ENV['AMAZON_REGION']`
  * `ENV['AWS_DEFAULT_REGION']`
  * `~/.aws/credentials`
  * `~/.aws/config`

@option options [String] :access_key_id

@option options [String] :account_id

@option options [Boolean] :active_endpoint_cache (false)
  When set to `true`, a thread polling for endpoints will be running in
  the background every 60 secs (default). Defaults to `false`.

@option options [Boolean] :adaptive_retry_wait_to_fill (true)
  Used only in `adaptive` retry mode.  When true, the request will sleep
  until there is sufficent client side capacity to retry the request.
  When false, the request will raise a `RetryCapacityNotAvailableError` and will
  not retry instead of sleeping.

@option options [Boolean] :client_side_monitoring (false)
  When `true`, client-side metrics will be collected for all API requests from
  this client.

@option options [String] :client_side_monitoring_client_id ("")
  Allows you to provide an identifier for this client which will be attached to
  all generated client side metrics. Defaults to an empty string.

@option options [String] :client_side_monitoring_host ("127.0.0.1")
  Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
  side monitoring agent is running on, where client metrics will be published via UDP.

@option options [Integer] :client_side_monitoring_port (31000)
  Required for publishing client metrics. The port that the client side monitoring
  agent is running on, where client metrics will be published via UDP.

@option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
  Allows you to provide a custom client-side monitoring publisher class. By default,
  will use the Client Side Monitoring Agent Publisher.

@option options [Boolean] :convert_params (true)
  When `true`, an attempt is made to coerce request parameters into
  the required types.

@option options [Boolean] :correct_clock_skew (true)
  Used only in `standard` and adaptive retry modes. Specifies whether to apply
  a clock skew correction and retry requests with skewed client clocks.

@option options [String] :defaults_mode ("legacy")
  See {Aws::DefaultsModeConfiguration} for a list of the
  accepted modes and the configuration defaults that are included.

@option options [Boolean] :disable_host_prefix_injection (false)
  Set to true to disable SDK automatically adding host prefix
  to default service endpoint when available.

@option options [Boolean] :disable_request_compression (false)
  When set to 'true' the request body will not be compressed
  for supported operations.

@option options [String, URI::HTTPS, URI::HTTP] :endpoint
  Normally you should not configure the `:endpoint` option
  directly. This is normally constructed from the `:region`
  option. Configuring `:endpoint` is normally reserved for
  connecting to test or custom endpoints. The endpoint should
  be a URI formatted like:

      'http://example.com'
      'https://example.com'
      'http://example.com:123'

@option options [Integer] :endpoint_cache_max_entries (1000)
  Used for the maximum size limit of the LRU cache storing endpoints data
  for endpoint discovery enabled operations. Defaults to 1000.

@option options [Integer] :endpoint_cache_max_threads (10)
  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

@option options [Integer] :endpoint_cache_poll_interval (60)
  When :endpoint_discovery and :active_endpoint_cache is enabled,
  Use this option to config the time interval in seconds for making
  requests fetching endpoints information. Defaults to 60 sec.

@option options [Boolean] :endpoint_discovery (false)
  When set to `true`, endpoint discovery will be enabled for operations when available.

@option options [Boolean] :ignore_configured_endpoint_urls
  Setting to true disables use of endpoint URLs provided via environment
  variables and the shared configuration file.

@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
  The log formatter.

@option options [Symbol] :log_level (:info)
  The log level to send messages to the `:logger` at.

@option options [Logger] :logger
  The Logger instance to send log messages to.  If this option
  is not set, logging will be disabled.

@option options [Integer] :max_attempts (3)
  An integer representing the maximum number attempts that will be made for
  a single request, including the initial attempt.  For example,
  setting this value to 5 will result in a request being retried up to
  4 times. Used in `standard` and `adaptive` retry modes.

@option options [String] :profile ("default")
  Used when loading credentials from the shared credentials file
  at HOME/.aws/credentials.  When not specified, 'default' is used.

@option options [Integer] :request_min_compression_size_bytes (10240)
  The minimum size in bytes that triggers compression for request
  bodies. The value must be non-negative integer value between 0
  and 10485780 bytes inclusive.

@option options [Proc] :retry_backoff
  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
  This option is only used in the `legacy` retry mode.

@option options [Float] :retry_base_delay (0.3)
  The base delay in seconds used by the default backoff function. This option
  is only used in the `legacy` retry mode.

@option options [Symbol] :retry_jitter (:none)
  A delay randomiser function used by the default backoff function.
  Some predefined functions can be referenced by name - :none, :equal, :full,
  otherwise a Proc that takes and returns a number. This option is only used
  in the `legacy` retry mode.

  @see https://www.awsarchitectureblog.com/2015/03/backoff.html

@option options [Integer] :retry_limit (3)
  The maximum number of times to retry failed requests.  Only
  ~ 500 level server errors and certain ~ 400 level client errors
  are retried.  Generally, these are throttling errors, data
  checksum errors, networking errors, timeout errors, auth errors,
  endpoint discovery, and errors from expired credentials.
  This option is only used in the `legacy` retry mode.

@option options [Integer] :retry_max_delay (0)
  The maximum number of seconds to delay between retries (0 for no limit)
  used by the default backoff function. This option is only used in the
  `legacy` retry mode.

@option options [String] :retry_mode ("legacy")
  Specifies which retry algorithm to use. Values are:

  * `legacy` - The pre-existing retry behavior.  This is default value if
    no retry mode is provided.

  * `standard` - A standardized set of retry rules across the AWS SDKs.
    This includes support for retry quotas, which limit the number of
    unsuccessful retries a client can make.

  * `adaptive` - An experimental retry mode that includes all the
    functionality of `standard` mode along with automatic client side
    throttling.  This is a provisional mode that may change behavior
    in the future.

@option options [String] :sdk_ua_app_id
  A unique and opaque application ID that is appended to the
  User-Agent header as app/sdk_ua_app_id. It should have a
  maximum length of 50. This variable is sourced from environment
  variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

@option options [String] :secret_access_key

@option options [String] :session_token

@option options [Array] :sigv4a_signing_region_set
  A list of regions that should be signed with SigV4a signing. When
  not passed, a default `:sigv4a_signing_region_set` is searched for
  in the following locations:

  * `Aws.config[:sigv4a_signing_region_set]`
  * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
  * `~/.aws/config`

@option options [Boolean] :stub_responses (false)
  Causes the client to return stubbed responses. By default
  fake responses are generated and returned. You can specify
  the response data to return or errors to raise by calling
  {ClientStubs#stub_responses}. See {ClientStubs} for more information.

  ** Please note ** When response stubbing is enabled, no HTTP
  requests are made, and retries are disabled.

@option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
  Allows you to provide a telemetry provider, which is used to
  emit telemetry data. By default, uses `NoOpTelemetryProvider` which
  will not record or emit any telemetry data. The SDK supports the
  following telemetry providers:

  * OpenTelemetry (OTel) - To use the OTel provider, install and require the
  `opentelemetry-sdk` gem and then, pass in an instance of a
  `Aws::Telemetry::OTelProvider` for telemetry provider.

@option options [Aws::TokenProvider] :token_provider
  A Bearer Token Provider. This can be an instance of any one of the
  following classes:

  * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
    tokens.

  * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
    access token generated from `aws login`.

  When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
  will be used to search for tokens configured for your profile in shared configuration files.

@option options [Boolean] :use_dualstack_endpoint
  When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
  will be used if available.

@option options [Boolean] :use_fips_endpoint
  When set to `true`, fips compatible endpoints will be used if available.
  When a `fips` region is used, the region is normalized and this config
  is set to `true`.

@option options [Boolean] :validate_params (true)
  When `true`, request parameters are validated before
  sending the request.

@option options [Aws::SSO::EndpointProvider] :endpoint_provider
  The endpoint provider used to resolve endpoints. Any object that responds to
  `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
  `Aws::SSO::EndpointParameters`.

@option options [Float] :http_continue_timeout (1)
  The number of seconds to wait for a 100-continue response before sending the
  request body.  This option has no effect unless the request has "Expect"
  header set to "100-continue".  Defaults to `nil` which  disables this
  behaviour.  This value can safely be set per request on the session.

@option options [Float] :http_idle_timeout (5)
  The number of seconds a connection is allowed to sit idle before it
  is considered stale.  Stale connections are closed and removed from the
  pool before making a request.

@option options [Float] :http_open_timeout (15)
  The default number of seconds to wait for response data.
  This value can safely be set per-request on the session.

@option options [URI::HTTP,String] :http_proxy
  A proxy to send requests through.  Formatted like 'http://proxy.com:123'.

@option options [Float] :http_read_timeout (60)
  The default number of seconds to wait for response data.
  This value can safely be set per-request on the session.

@option options [Boolean] :http_wire_trace (false)
  When `true`,  HTTP debug output will be sent to the `:logger`.

@option options [Proc] :on_chunk_received
  When a Proc object is provided, it will be used as callback when each chunk
  of the response body is received. It provides three arguments: the chunk,
  the number of bytes received, and the total number of
  bytes in the response (or nil if the server did not send a `content-length`).

@option options [Proc] :on_chunk_sent
  When a Proc object is provided, it will be used as callback when each chunk
  of the request body is sent. It provides three arguments: the chunk,
  the number of bytes read from the body, and the total number of
  bytes in the body.

@option options [Boolean] :raise_response_errors (true)
  When `true`, response errors are raised.

@option options [String] :ssl_ca_bundle
  Full path to the SSL certificate authority bundle file that should be used when
  verifying peer certificates.  If you do not pass `:ssl_ca_bundle` or
  `:ssl_ca_directory` the the system default will be used if available.

@option options [String] :ssl_ca_directory
  Full path of the directory that contains the unbundled SSL certificate
  authority files for verifying peer certificates.  If you do
  not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
  default will be used if available.

@option options [String] :ssl_ca_store
  Sets the X509::Store to verify peer certificate.

@option options [OpenSSL::X509::Certificate] :ssl_cert
  Sets a client certificate when creating http connections.

@option options [OpenSSL::PKey] :ssl_key
  Sets a client key when creating http connections.

@option options [Float] :ssl_timeout
  Sets the SSL timeout in seconds

@option options [Boolean] :ssl_verify_peer (true)
  When `true`, SSL peer certificates are verified when establishing a connection.
Calls superclass method Seahorse::Client::Base::new
# File lib/aws-sdk-sso/client.rb, line 444
def initialize(*args)
  super
end

Public Instance Methods

build_request(operation_name, params = {}) click to toggle source

@param params ({}) @api private

# File lib/aws-sdk-sso/client.rb, line 658
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::SSO')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-core'
  context[:gem_version] = '3.213.0'
  Seahorse::Client::Request.new(handlers, context)
end
get_role_credentials(params = {}, options = {}) click to toggle source

Returns the STS short-term credentials for a given role name that is assigned to the user.

@option params [required, String] :role_name

The friendly name of the role that is assigned to the user.

@option params [required, String] :account_id

The identifier for the AWS account that is assigned to the user.

@option params [required, String] :access_token

The token issued by the `CreateToken` API call. For more information,
see [CreateToken][1] in the *IAM Identity Center OIDC API Reference
Guide*.

[1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html

@return [Types::GetRoleCredentialsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetRoleCredentialsResponse#role_credentials #role_credentials} => Types::RoleCredentials

@example Request syntax with placeholder values

resp = client.get_role_credentials({
  role_name: "RoleNameType", # required
  account_id: "AccountIdType", # required
  access_token: "AccessTokenType", # required
})

@example Response structure

resp.role_credentials.access_key_id #=> String
resp.role_credentials.secret_access_key #=> String
resp.role_credentials.session_token #=> String
resp.role_credentials.expiration #=> Integer

@see docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/GetRoleCredentials AWS API Documentation

@overload get_role_credentials(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-sso/client.rb, line 491
def get_role_credentials(params = {}, options = {})
  req = build_request(:get_role_credentials, params)
  req.send_request(options)
end
list_account_roles(params = {}, options = {}) click to toggle source

Lists all roles that are assigned to the user for a given AWS account.

@option params [String] :next_token

The page token from the previous response output when you request
subsequent pages.

@option params [Integer] :max_results

The number of items that clients can request per page.

@option params [required, String] :access_token

The token issued by the `CreateToken` API call. For more information,
see [CreateToken][1] in the *IAM Identity Center OIDC API Reference
Guide*.

[1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html

@option params [required, String] :account_id

The identifier for the AWS account that is assigned to the user.

@return [Types::ListAccountRolesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListAccountRolesResponse#next_token #next_token} => String
* {Types::ListAccountRolesResponse#role_list #role_list} => Array&lt;Types::RoleInfo&gt;

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

resp = client.list_account_roles({
  next_token: "NextTokenType",
  max_results: 1,
  access_token: "AccessTokenType", # required
  account_id: "AccountIdType", # required
})

@example Response structure

resp.next_token #=> String
resp.role_list #=> Array
resp.role_list[0].role_name #=> String
resp.role_list[0].account_id #=> String

@see docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/ListAccountRoles AWS API Documentation

@overload list_account_roles(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-sso/client.rb, line 544
def list_account_roles(params = {}, options = {})
  req = build_request(:list_account_roles, params)
  req.send_request(options)
end
list_accounts(params = {}, options = {}) click to toggle source

Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see [Assign User Access] in the *IAM Identity Center User Guide*. This operation returns a paginated response.

[1]: docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers

@option params [String] :next_token

(Optional) When requesting subsequent pages, this is the page token
from the previous response output.

@option params [Integer] :max_results

This is the number of items clients can request per page.

@option params [required, String] :access_token

The token issued by the `CreateToken` API call. For more information,
see [CreateToken][1] in the *IAM Identity Center OIDC API Reference
Guide*.

[1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html

@return [Types::ListAccountsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListAccountsResponse#next_token #next_token} => String
* {Types::ListAccountsResponse#account_list #account_list} => Array&lt;Types::AccountInfo&gt;

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

resp = client.list_accounts({
  next_token: "NextTokenType",
  max_results: 1,
  access_token: "AccessTokenType", # required
})

@example Response structure

resp.next_token #=> String
resp.account_list #=> Array
resp.account_list[0].account_id #=> String
resp.account_list[0].account_name #=> String
resp.account_list[0].email_address #=> String

@see docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/ListAccounts AWS API Documentation

@overload list_accounts(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-sso/client.rb, line 601
def list_accounts(params = {}, options = {})
  req = build_request(:list_accounts, params)
  req.send_request(options)
end
logout(params = {}, options = {}) click to toggle source

Removes the locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

<note markdown=“1”> If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM Identity Center sign in session is used to obtain an IAM session, as specified in the corresponding IAM Identity Center permission set. More specifically, IAM Identity Center assumes an IAM role in the target account on behalf of the user, and the corresponding temporary AWS credentials are returned to the client.

After user logout, any existing IAM role sessions that were created by

using IAM Identity Center permission sets continue based on the duration configured in the permission set. For more information, see

User authentications][1

in the *IAM Identity Center User Guide*.

</note>

[1]: docs.aws.amazon.com/singlesignon/latest/userguide/authconcept.html

@option params [required, String] :access_token

The token issued by the `CreateToken` API call. For more information,
see [CreateToken][1] in the *IAM Identity Center OIDC API Reference
Guide*.

[1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.logout({
  access_token: "AccessTokenType", # required
})

@see docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/Logout AWS API Documentation

@overload logout(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-sso/client.rb, line 649
def logout(params = {}, options = {})
  req = build_request(:logout, params)
  req.send_request(options)
end
waiter_names() click to toggle source

@api private @deprecated

# File lib/aws-sdk-sso/client.rb, line 678
def waiter_names
  []
end