Class: Aws::SSO::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::SSO::Client

Includes:: ClientStubs

Defined in:: lib/aws-sdk-sso/client.rb

Overview

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.

Class Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#get_role_credentials(params = {}) ⇒ Types::GetRoleCredentialsResponse

Returns the STS short-term credentials for a given role name that is assigned to the user.
#list_account_roles(params = {}) ⇒ Types::ListAccountRolesResponse

Lists all roles that are assigned to the user for a given AWS account.
#list_accounts(params = {}) ⇒ Types::ListAccountsResponse

Lists all AWS accounts assigned to the user.
#logout(params = {}) ⇒ Struct

Removes the client- and server-side session that is associated with the user.

Class Method Summary collapse

.errors_module ⇒ Object private

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Object private
#initialize(options) ⇒ Client constructor

A new instance of Client.
#waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(options) ⇒ `Client`

Returns a new instance of Client.

Parameters:

options (Hash)

Options Hash (options):

:credentials (required, Aws::CredentialProvider) —
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::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- ‘Aws::SharedCredentials` - Used for loading credentials from a shared file, such as `~/.aws/config`.
- ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.
When ‘:credentials` are not configured directly, the following locations will be searched for credentials:
- ‘Aws.config`
- The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.
- ENV, ENV
- ‘~/.aws/credentials`
- ‘~/.aws/config`
- EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` to enable retries and extended timeouts.
:region (required, String) —
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`
- ‘ENV`
- ‘ENV`
- ‘ENV`
- ‘~/.aws/credentials`
- ‘~/.aws/config`
:access_key_id (String)
:active_endpoint_cache (Boolean) — default: false —

When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.
:adaptive_retry_wait_to_fill (Boolean) — default: 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.
:client_side_monitoring (Boolean) — default: false —

When ‘true`, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —

Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "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.
:client_side_monitoring_port (Integer) — default: 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.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —

When ‘true`, an attempt is made to coerce request parameters into the required types.
:correct_clock_skew (Boolean) — default: true —

Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.
:disable_host_prefix_injection (Boolean) — default: false —

Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:endpoint (String) —

The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.
:endpoint_cache_max_entries (Integer) — default: 1000 —

Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —

Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 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.
:endpoint_discovery (Boolean) — default: false —

When set to ‘true`, endpoint discovery will be enabled for operations when available.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

The log formatter.
:log_level (Symbol) — default: :info —

The log level to send messages to the ‘:logger` at.
:logger (Logger) —

The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:max_attempts (Integer) — default: 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.
:profile (String) — default: "default" —

Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.
:retry_backoff (Proc) —

A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.
:retry_base_delay (Float) — default: 0.3 —

The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_jitter (Symbol) — default: :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 www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 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.
:retry_max_delay (Integer) — default: 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.
:retry_mode (String) — default: "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.
:secret_access_key (String)
:session_token (String)
:stub_responses (Boolean) — default: 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.
:validate_params (Boolean) — default: true —

When ‘true`, request parameters are validated before sending the request.
:http_proxy (URI::HTTP, String) —

A proxy to send requests through. Formatted like ‘proxy.com:123’.
:http_open_timeout (Float) — default: 15 —

The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.
:http_read_timeout (Integer) — default: 60 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_idle_timeout (Float) — default: 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.
:http_continue_timeout (Float) — default: 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.
:http_wire_trace (Boolean) — default: false —

When ‘true`, HTTP debug output will be sent to the `:logger`.
:ssl_verify_peer (Boolean) — default: true —

When ‘true`, SSL peer certificates are verified when establishing a connection.
:ssl_ca_bundle (String) —

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.
:ssl_ca_directory (String) —

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.



309
310
311

# File 'lib/aws-sdk-sso/client.rb', line 309

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



522
523
524

# File 'lib/aws-sdk-sso/client.rb', line 522

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



525
526
527

# File 'lib/aws-sdk-sso/client.rb', line 525

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-sso/client.rb', line 500

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-sso'
  context[:gem_version] = '1.5.1'
  Seahorse::Client::Request.new(handlers, context)
end

#get_role_credentials(params = {}) ⇒ `Types::GetRoleCredentialsResponse`

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

Examples:

Request syntax with placeholder values


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

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

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:role_name (required, String) —

The friendly name of the role that is assigned to the user.
:account_id (required, String) —

The identifier for the AWS account that is assigned to the user.
:access_token (required, String) —

The token issued by the ‘CreateToken` API call. For more information, see [CreateToken] in the *AWS SSO OIDC API Reference Guide*.

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

Returns:

(Types::GetRoleCredentialsResponse) —
Returns a response object which responds to the following methods:
- #role_credentials => Types::RoleCredentials

See Also:

AWS API Documentation

# File 'lib/aws-sdk-sso/client.rb', line 355

def get_role_credentials(params = {}, options = {})
  req = build_request(:get_role_credentials, params)
  req.send_request(options)
end

#list_account_roles(params = {}) ⇒ `Types::ListAccountRolesResponse`

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:next_token (String) —

The page token from the previous response output when you request subsequent pages.
:max_results (Integer) —

The number of items that clients can request per page.
:access_token (required, String) —

The token issued by the ‘CreateToken` API call. For more information, see [CreateToken] in the *AWS SSO OIDC API Reference Guide*.

[1]: docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html
:account_id (required, String) —

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

Returns:

(Types::ListAccountRolesResponse) —
Returns a response object which responds to the following methods:
- #next_token => String
- #role_list => Array<Types::RoleInfo>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-sso/client.rb', line 407

def list_account_roles(params = {}, options = {})
  req = build_request(:list_account_roles, params)
  req.send_request(options)
end

#list_accounts(params = {}) ⇒ `Types::ListAccountsResponse`

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 *AWS SSO User Guide*. This operation returns a paginated response.

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

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

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:next_token (String) — default: Optional —

When requesting subsequent pages, this is the page token from the previous response output.
:max_results (Integer) —

This is the number of items clients can request per page.
:access_token (required, String) —

The token issued by the ‘CreateToken` API call. For more information, see [CreateToken] in the *AWS SSO OIDC API Reference Guide*.

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

Returns:

(Types::ListAccountsResponse) —
Returns a response object which responds to the following methods:
- #next_token => String
- #account_list => Array<Types::AccountInfo>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-sso/client.rb', line 463

def list_accounts(params = {}, options = {})
  req = build_request(:list_accounts, params)
  req.send_request(options)
end

#logout(params = {}) ⇒ `Struct`

Removes the client- and server-side session that is associated with the user.

Examples:

Request syntax with placeholder values


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

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

The token issued by the ‘CreateToken` API call. For more information, see [CreateToken] in the *AWS SSO OIDC API Reference Guide*.

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-sso/client.rb', line 491

def logout(params = {}, options = {})
  req = build_request(:logout, params)
  req.send_request(options)
end

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



515
516
517

# File 'lib/aws-sdk-sso/client.rb', line 515

def waiter_names
  []
end

Class: Aws::SSO::Client

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

#get_role_credentials(params = {}) ⇒ Types::GetRoleCredentialsResponse

#list_account_roles(params = {}) ⇒ Types::ListAccountRolesResponse

#list_accounts(params = {}) ⇒ Types::ListAccountsResponse

#logout(params = {}) ⇒ Struct

#waiter_names ⇒ Object

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#build_request(operation_name, params = {}) ⇒ `Object`

#get_role_credentials(params = {}) ⇒ `Types::GetRoleCredentialsResponse`

#list_account_roles(params = {}) ⇒ `Types::ListAccountRolesResponse`

#list_accounts(params = {}) ⇒ `Types::ListAccountsResponse`

#logout(params = {}) ⇒ `Struct`

#waiter_names ⇒ `Object`