Class: Aws::DirectoryServiceData::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DirectoryServiceData::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb
Overview
An API client for DirectoryServiceData. To construct a client, you need to configure a :region and :credentials.
client = Aws::DirectoryServiceData::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
-
#add_group_member(params = {}) ⇒ Struct
Adds an existing user, group, or computer as a group member.
-
#create_group(params = {}) ⇒ Types::CreateGroupResult
Creates a new group.
-
#create_user(params = {}) ⇒ Types::CreateUserResult
Creates a new user.
-
#delete_group(params = {}) ⇒ Struct
Deletes a group.
-
#delete_user(params = {}) ⇒ Struct
Deletes a user.
-
#describe_group(params = {}) ⇒ Types::DescribeGroupResult
Returns information about a specific group.
-
#describe_user(params = {}) ⇒ Types::DescribeUserResult
Returns information about a specific user.
-
#disable_user(params = {}) ⇒ Struct
Deactivates an active user account.
-
#list_group_members(params = {}) ⇒ Types::ListGroupMembersResult
Returns member information for the specified group.
-
#list_groups(params = {}) ⇒ Types::ListGroupsResult
Returns group information for the specified directory.
-
#list_groups_for_member(params = {}) ⇒ Types::ListGroupsForMemberResult
Returns group information for the specified member.
-
#list_users(params = {}) ⇒ Types::ListUsersResult
Returns user information for the specified directory.
-
#remove_group_member(params = {}) ⇒ Struct
Removes a member from a group.
-
#search_groups(params = {}) ⇒ Types::SearchGroupsResult
Searches the specified directory for a group.
-
#search_users(params = {}) ⇒ Types::SearchUsersResult
Searches the specified directory for a user.
-
#update_group(params = {}) ⇒ Struct
Updates group information.
-
#update_user(params = {}) ⇒ Struct
Updates user information.
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.
479 480 481 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#add_group_member(params = {}) ⇒ Struct
Adds an existing user, group, or computer as a group member.
546 547 548 549 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 546 def add_group_member(params = {}, = {}) req = build_request(:add_group_member, params) req.send_request() end |
#create_group(params = {}) ⇒ Types::CreateGroupResult
Creates a new group.
630 631 632 633 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 630 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResult
Creates a new user.
717 718 719 720 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 717 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes a group.
766 767 768 769 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 766 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user.
814 815 816 817 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 814 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#describe_group(params = {}) ⇒ Types::DescribeGroupResult
Returns information about a specific group.
882 883 884 885 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 882 def describe_group(params = {}, = {}) req = build_request(:describe_group, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResult
Returns information about a specific user.
957 958 959 960 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 957 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#disable_user(params = {}) ⇒ Struct
Deactivates an active user account. For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference.
1011 1012 1013 1014 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1011 def disable_user(params = {}, = {}) req = build_request(:disable_user, params) req.send_request() end |
#list_group_members(params = {}) ⇒ Types::ListGroupMembersResult
Returns member information for the specified group.
This operation supports pagination with the use of the NextToken
request and response parameters. If more results are available, the
ListGroupMembers.NextToken member contains a token that you pass in
the next call to ListGroupMembers. This retrieves the next set of
items.
You can also specify a maximum number of return results with the
MaxResults parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1096 def list_group_members(params = {}, = {}) req = build_request(:list_group_members, params) req.send_request() end |
#list_groups(params = {}) ⇒ Types::ListGroupsResult
Returns group information for the specified directory.
This operation supports pagination with the use of the NextToken
request and response parameters. If more results are available, the
ListGroups.NextToken member contains a token that you pass in the
next call to ListGroups. This retrieves the next set of items.
You can also specify a maximum number of return results with the
MaxResults parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1166 1167 1168 1169 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1166 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() end |
#list_groups_for_member(params = {}) ⇒ Types::ListGroupsForMemberResult
Returns group information for the specified member.
This operation supports pagination with the use of the NextToken
request and response parameters. If more results are available, the
ListGroupsForMember.NextToken member contains a token that you pass
in the next call to ListGroupsForMember. This retrieves the next set
of items.
You can also specify a maximum number of return results with the
MaxResults parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1256 1257 1258 1259 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1256 def list_groups_for_member(params = {}, = {}) req = build_request(:list_groups_for_member, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResult
Returns user information for the specified directory.
This operation supports pagination with the use of the NextToken
request and response parameters. If more results are available, the
ListUsers.NextToken member contains a token that you pass in the
next call to ListUsers. This retrieves the next set of items.
You can also specify a maximum number of return results with the
MaxResults parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1326 1327 1328 1329 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1326 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#remove_group_member(params = {}) ⇒ Struct
Removes a member from a group.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1389 def remove_group_member(params = {}, = {}) req = build_request(:remove_group_member, params) req.send_request() end |
#search_groups(params = {}) ⇒ Types::SearchGroupsResult
Searches the specified directory for a group. You can find groups that
match the SearchString parameter with the value of their attributes
included in the SearchString parameter.
This operation supports pagination with the use of the NextToken
request and response parameters. If more results are available, the
SearchGroups.NextToken member contains a token that you pass in the
next call to SearchGroups. This retrieves the next set of items.
You can also specify a maximum number of return results with the
MaxResults parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1487 1488 1489 1490 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1487 def search_groups(params = {}, = {}) req = build_request(:search_groups, params) req.send_request() end |
#search_users(params = {}) ⇒ Types::SearchUsersResult
Searches the specified directory for a user. You can find users that
match the SearchString parameter with the value of their attributes
included in the SearchString parameter.
This operation supports pagination with the use of the NextToken
request and response parameters. If more results are available, the
SearchUsers.NextToken member contains a token that you pass in the
next call to SearchUsers. This retrieves the next set of items.
You can also specify a maximum number of return results with the
MaxResults parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1587 1588 1589 1590 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1587 def search_users(params = {}, = {}) req = build_request(:search_users, params) req.send_request() end |
#update_group(params = {}) ⇒ Struct
Updates group information.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1667 def update_group(params = {}, = {}) req = build_request(:update_group, params) req.send_request() end |
#update_user(params = {}) ⇒ Struct
Updates user information.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1750 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |