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.
420 421 422 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a group within the specified identity store.
462 463 464 465 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 462 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
.
506 507 508 509 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 506 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.
631 632 633 634 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 631 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
.
657 658 659 660 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 657 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
.
683 684 685 686 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 683 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
.
709 710 711 712 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 709 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.
766 767 768 769 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 766 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.
815 816 817 818 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 815 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.
913 914 915 916 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 913 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.
970 971 972 973 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 970 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.
1022 1023 1024 1025 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1022 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.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1079 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.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1131 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.
1198 1199 1200 1201 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1198 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.
1270 1271 1272 1273 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1270 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.
1350 1351 1352 1353 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1350 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.
1460 1461 1462 1463 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1460 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.
1497 1498 1499 1500 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1497 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.
1534 1535 1536 1537 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1534 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |