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
GroupIdin an identity store. -
#describe_group_membership(params = {}) ⇒ Types::DescribeGroupMembershipResponse
Retrieves membership metadata and attributes from
MembershipIdin an identity store. -
#describe_identity_store(params = {}) ⇒ Types::DescribeIdentityStoreResponse
Retrieves details about the specified identity store, including its Amazon Resource Name (ARN) and network configuration.
-
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Retrieves the user metadata and attributes from the
UserIdin an identity store. -
#get_group_id(params = {}) ⇒ Types::GetGroupIdResponse
Retrieves
GroupIdin an identity store. -
#get_group_membership_id(params = {}) ⇒ Types::GetGroupMembershipIdResponse
Retrieves the
MembershipIdin an identity store. -
#get_user_id(params = {}) ⇒ Types::GetUserIdResponse
Retrieves the
UserIdin 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
GroupMembershipobjects 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
GroupMembershipobjects and returns results in paginated form. -
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists all groups in the identity store.
-
#list_identity_stores(params = {}) ⇒ Types::ListIdentityStoresResponse
Lists the identity stores that you have access to.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists all users in the identity store.
-
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Updates the specified group metadata and attributes in the specified identity store.
-
#update_identity_store(params = {}) ⇒ Types::UpdateIdentityStoreResponse
Updates the configuration of the specified identity store, including its network configuration.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates the specified user metadata and attributes in the specified identity store.
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.
486 487 488 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a group within the specified identity store.
536 537 538 539 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 536 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.
590 591 592 593 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 590 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.
767 768 769 770 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 767 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.
809 810 811 812 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 809 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.
844 845 846 847 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 844 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.
886 887 888 889 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 886 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.
964 965 966 967 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 964 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.
1033 1034 1035 1036 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1033 def describe_group_membership(params = {}, = {}) req = build_request(:describe_group_membership, params) req.send_request() end |
#describe_identity_store(params = {}) ⇒ Types::DescribeIdentityStoreResponse
Retrieves details about the specified identity store, including its Amazon Resource Name (ARN) and network configuration.
1076 1077 1078 1079 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1076 def describe_identity_store(params = {}, = {}) req = build_request(:describe_identity_store, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Retrieves the user metadata and attributes from the UserId in an
identity store.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1221 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.
1285 1286 1287 1288 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1285 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.
1348 1349 1350 1351 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1348 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.
1412 1413 1414 1415 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1412 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.
1473 1474 1475 1476 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1473 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.
1554 1555 1556 1557 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1554 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.
1635 1636 1637 1638 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1635 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.
1725 1726 1727 1728 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1725 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() end |
#list_identity_stores(params = {}) ⇒ Types::ListIdentityStoresResponse
Lists the identity stores that you have access to. This operation
returns only the identity store ID and Amazon Resource Name (ARN) of
each identity store. To obtain additional information about an
identity store, call DescribeIdentityStore.
This operation returns results in paginated form. Use the NextToken
parameter to retrieve additional pages of results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1776 1777 1778 1779 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1776 def list_identity_stores(params = {}, = {}) req = build_request(:list_identity_stores, 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.
1916 1917 1918 1919 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1916 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Updates the specified group metadata and attributes in the specified identity store.
1988 1989 1990 1991 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1988 def update_group(params = {}, = {}) req = build_request(:update_group, params) req.send_request() end |
#update_identity_store(params = {}) ⇒ Types::UpdateIdentityStoreResponse
Updates the configuration of the specified identity store, including its network configuration.
2042 2043 2044 2045 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 2042 def update_identity_store(params = {}, = {}) req = build_request(:update_identity_store, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates the specified user metadata and attributes in the specified identity store.
2114 2115 2116 2117 |
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 2114 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |