Class: Aws::IdentityStore::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IdentityStore::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb
Overview
An API client for IdentityStore. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IdentityStore::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
-
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Retrieves the group metadata and attributes from
GroupId
in an identity store. -
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Retrieves the user metadata and attributes from
UserId
in an identity store. -
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists the attribute name and value of the group that you specified in the search.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists the attribute name and value of the user that you specified in the search.
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.
358 359 360 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 358 def initialize(*args) super end |
Instance Method Details
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Retrieves the group metadata and attributes from GroupId
in an
identity store.
398 399 400 401 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 398 def describe_group(params = {}, = {}) req = build_request(:describe_group, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Retrieves the user metadata and attributes from UserId
in an
identity store.
437 438 439 440 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 437 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists the attribute name and value of the group that you specified in
the search. We only support DisplayName
as a valid filter attribute
path currently, and filter is required. This API returns minimum
attributes, including GroupId
and group DisplayName
in the
response.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
504 505 506 507 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 504 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists the attribute name and value of the user that you specified in
the search. We only support UserName
as a valid filter attribute
path currently, and filter is required. This API returns minimum
attributes, including UserId
and UserName
in the response.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
570 571 572 573 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 570 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |