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
-
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a group within the specified identity store.
-
#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse
Creates a relationship between a member and a group.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user within the specified identity store.
-
#delete_group(params = {}) ⇒ Struct
Delete a group within an identity store given
GroupId
. -
#delete_group_membership(params = {}) ⇒ Struct
Delete a membership within a group given
MembershipId
. -
#delete_user(params = {}) ⇒ Struct
Deletes a user within an identity store given
UserId
. -
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Retrieves the group metadata and attributes from
GroupId
in an identity store. -
#describe_group_membership(params = {}) ⇒ Types::DescribeGroupMembershipResponse
Retrieves membership metadata and attributes from
MembershipId
in an identity store. -
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Retrieves the user metadata and attributes from the
UserId
in an identity store. -
#get_group_id(params = {}) ⇒ Types::GetGroupIdResponse
Retrieves
GroupId
in an identity store. -
#get_group_membership_id(params = {}) ⇒ Types::GetGroupMembershipIdResponse
Retrieves the
MembershipId
in an identity store. -
#get_user_id(params = {}) ⇒ Types::GetUserIdResponse
Retrieves the
UserId
in an identity store. -
#is_member_in_groups(params = {}) ⇒ Types::IsMemberInGroupsResponse
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
-
#list_group_memberships(params = {}) ⇒ Types::ListGroupMembershipsResponse
For the specified group in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. -
#list_group_memberships_for_member(params = {}) ⇒ Types::ListGroupMembershipsForMemberResponse
For the specified member in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. -
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists all groups in the identity store.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists all users in the identity store.
-
#update_group(params = {}) ⇒ Struct
For the specified group in the specified identity store, updates the group metadata and attributes.
-
#update_user(params = {}) ⇒ Struct
For the specified user in the specified identity store, updates the user metadata and attributes.
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.
395 396 397 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 395 def initialize(*args) super end |
Instance Method Details
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a group within the specified identity store.
437 438 439 440 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 437 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse
Creates a relationship between a member and a group. The following
identifiers must be specified: GroupId
, IdentityStoreId
, and
MemberId
.
481 482 483 484 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 481 def create_group_membership(params = {}, = {}) req = build_request(:create_group_membership, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user within the specified identity store.
606 607 608 609 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 606 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Delete a group within an identity store given GroupId
.
632 633 634 635 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 632 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_group_membership(params = {}) ⇒ Struct
Delete a membership within a group given MembershipId
.
658 659 660 661 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 658 def delete_group_membership(params = {}, = {}) req = build_request(:delete_group_membership, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user within an identity store given UserId
.
684 685 686 687 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 684 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Retrieves the group metadata and attributes from GroupId
in an
identity store.
741 742 743 744 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 741 def describe_group(params = {}, = {}) req = build_request(:describe_group, params) req.send_request() end |
#describe_group_membership(params = {}) ⇒ Types::DescribeGroupMembershipResponse
Retrieves membership metadata and attributes from MembershipId
in an
identity store.
790 791 792 793 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 790 def describe_group_membership(params = {}, = {}) req = build_request(:describe_group_membership, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Retrieves the user metadata and attributes from the UserId
in an
identity store.
888 889 890 891 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 888 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#get_group_id(params = {}) ⇒ Types::GetGroupIdResponse
Retrieves GroupId
in an identity store.
945 946 947 948 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 945 def get_group_id(params = {}, = {}) req = build_request(:get_group_id, params) req.send_request() end |
#get_group_membership_id(params = {}) ⇒ Types::GetGroupMembershipIdResponse
Retrieves the MembershipId
in an identity store.
997 998 999 1000 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 997 def get_group_membership_id(params = {}, = {}) req = build_request(:get_group_membership_id, params) req.send_request() end |
#get_user_id(params = {}) ⇒ Types::GetUserIdResponse
Retrieves the UserId
in an identity store.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1054 def get_user_id(params = {}, = {}) req = build_request(:get_user_id, params) req.send_request() end |
#is_member_in_groups(params = {}) ⇒ Types::IsMemberInGroupsResponse
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
1106 1107 1108 1109 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1106 def is_member_in_groups(params = {}, = {}) req = build_request(:is_member_in_groups, params) req.send_request() end |
#list_group_memberships(params = {}) ⇒ Types::ListGroupMembershipsResponse
For the specified group in the specified identity store, returns the
list of all GroupMembership
objects and returns results in paginated
form.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1173 def list_group_memberships(params = {}, = {}) req = build_request(:list_group_memberships, params) req.send_request() end |
#list_group_memberships_for_member(params = {}) ⇒ Types::ListGroupMembershipsForMemberResponse
For the specified member in the specified identity store, returns the
list of all GroupMembership
objects and returns results in paginated
form.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1245 1246 1247 1248 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1245 def list_group_memberships_for_member(params = {}, = {}) req = build_request(:list_group_memberships_for_member, params) req.send_request() end |
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists all groups in the identity store. Returns a paginated list of
complete Group
objects. Filtering for a Group
by the DisplayName
attribute is deprecated. Instead, use the GetGroupId
API action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1325 1326 1327 1328 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1325 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists all users in the identity store. Returns a paginated list of
complete User
objects. Filtering for a User
by the UserName
attribute is deprecated. Instead, use the GetUserId
API action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1435 1436 1437 1438 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1435 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#update_group(params = {}) ⇒ Struct
For the specified group in the specified identity store, updates the group metadata and attributes.
1472 1473 1474 1475 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1472 def update_group(params = {}, = {}) req = build_request(:update_group, params) req.send_request() end |
#update_user(params = {}) ⇒ Struct
For the specified user in the specified identity store, updates the user metadata and attributes.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1509 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |