Class: Aws::SSO::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SSO::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-core/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
348 349 350 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sso/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#get_role_credentials(params = {}) ⇒ Types::GetRoleCredentialsResponse
Returns the STS short-term credentials for a given role name that is assigned to the user.
394 395 396 397 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sso/client.rb', line 394 def get_role_credentials(params = {}, = {}) req = build_request(:get_role_credentials, params) req.send_request() 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.
446 447 448 449 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sso/client.rb', line 446 def list_account_roles(params = {}, = {}) req = build_request(:list_account_roles, params) req.send_request() 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
502 503 504 505 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sso/client.rb', line 502 def list_accounts(params = {}, = {}) req = build_request(:list_accounts, params) req.send_request() end |
#logout(params = {}) ⇒ Struct
Removes the client- and server-side session that is associated with the user.
530 531 532 533 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sso/client.rb', line 530 def logout(params = {}, = {}) req = build_request(:logout, params) req.send_request() end |