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.
444 445 446 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#add_group_member(params = {}) ⇒ Struct
Adds an existing user, group, or computer as a group member.
511 512 513 514 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 511 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.
595 596 597 598 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 595 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResult
Creates a new user.
682 683 684 685 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 682 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes a group.
731 732 733 734 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 731 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user.
779 780 781 782 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 779 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.
847 848 849 850 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 847 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.
922 923 924 925 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 922 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.
976 977 978 979 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 976 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.
1061 1062 1063 1064 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1061 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.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1131 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.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1221 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.
1291 1292 1293 1294 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1291 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.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1354 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.
1452 1453 1454 1455 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1452 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.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1552 def search_users(params = {}, = {}) req = build_request(:search_users, params) req.send_request() end |
#update_group(params = {}) ⇒ Struct
Updates group information.
1632 1633 1634 1635 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1632 def update_group(params = {}, = {}) req = build_request(:update_group, params) req.send_request() end |
#update_user(params = {}) ⇒ Struct
Updates user information.
1715 1716 1717 1718 |
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1715 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |