@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IdentitystoreAsyncClient extends AwsClient
builder()
method.
The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.
This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.
IAM Identity Center uses the sso and identitystore API namespaces.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static IdentitystoreAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
IdentitystoreAsyncClient. |
static IdentitystoreAsyncClient |
create()
Create a
IdentitystoreAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateGroupResponse> |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group within the specified identity store.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group within the specified identity store.
|
default CompletableFuture<CreateGroupMembershipResponse> |
createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)
Creates a relationship between a member and a group.
|
default CompletableFuture<CreateGroupMembershipResponse> |
createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
Creates a relationship between a member and a group.
|
default CompletableFuture<CreateUserResponse> |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user within the specified identity store.
|
default CompletableFuture<CreateUserResponse> |
createUser(CreateUserRequest createUserRequest)
Creates a user within the specified identity store.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Delete a group within an identity store given
GroupId. |
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Delete a group within an identity store given
GroupId. |
default CompletableFuture<DeleteGroupMembershipResponse> |
deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)
Delete a membership within a group given
MembershipId. |
default CompletableFuture<DeleteGroupMembershipResponse> |
deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Delete a membership within a group given
MembershipId. |
default CompletableFuture<DeleteUserResponse> |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user within an identity store given
UserId. |
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user within an identity store given
UserId. |
default CompletableFuture<DescribeGroupResponse> |
describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
Retrieves the group metadata and attributes from
GroupId in an identity store. |
default CompletableFuture<DescribeGroupResponse> |
describeGroup(DescribeGroupRequest describeGroupRequest)
Retrieves the group metadata and attributes from
GroupId in an identity store. |
default CompletableFuture<DescribeGroupMembershipResponse> |
describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)
Retrieves membership metadata and attributes from
MembershipId in an identity store. |
default CompletableFuture<DescribeGroupMembershipResponse> |
describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
Retrieves membership metadata and attributes from
MembershipId in an identity store. |
default CompletableFuture<DescribeUserResponse> |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Retrieves the user metadata and attributes from the
UserId in an identity store. |
default CompletableFuture<DescribeUserResponse> |
describeUser(DescribeUserRequest describeUserRequest)
Retrieves the user metadata and attributes from the
UserId in an identity store. |
default CompletableFuture<GetGroupIdResponse> |
getGroupId(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest)
Retrieves
GroupId in an identity store. |
default CompletableFuture<GetGroupIdResponse> |
getGroupId(GetGroupIdRequest getGroupIdRequest)
Retrieves
GroupId in an identity store. |
default CompletableFuture<GetGroupMembershipIdResponse> |
getGroupMembershipId(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest)
Retrieves the
MembershipId in an identity store. |
default CompletableFuture<GetGroupMembershipIdResponse> |
getGroupMembershipId(GetGroupMembershipIdRequest getGroupMembershipIdRequest)
Retrieves the
MembershipId in an identity store. |
default CompletableFuture<GetUserIdResponse> |
getUserId(Consumer<GetUserIdRequest.Builder> getUserIdRequest)
Retrieves the
UserId in an identity store. |
default CompletableFuture<GetUserIdResponse> |
getUserId(GetUserIdRequest getUserIdRequest)
Retrieves the
UserId in an identity store. |
default CompletableFuture<IsMemberInGroupsResponse> |
isMemberInGroups(Consumer<IsMemberInGroupsRequest.Builder> isMemberInGroupsRequest)
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
|
default CompletableFuture<IsMemberInGroupsResponse> |
isMemberInGroups(IsMemberInGroupsRequest isMemberInGroupsRequest)
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
|
default CompletableFuture<ListGroupMembershipsResponse> |
listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default CompletableFuture<ListGroupMembershipsResponse> |
listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default CompletableFuture<ListGroupMembershipsForMemberResponse> |
listGroupMembershipsForMember(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default CompletableFuture<ListGroupMembershipsForMemberResponse> |
listGroupMembershipsForMember(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default ListGroupMembershipsForMemberPublisher |
listGroupMembershipsForMemberPaginator(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default ListGroupMembershipsForMemberPublisher |
listGroupMembershipsForMemberPaginator(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default ListGroupMembershipsPublisher |
listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default ListGroupMembershipsPublisher |
listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default CompletableFuture<ListGroupsResponse> |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Lists all groups in the identity store.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(ListGroupsRequest listGroupsRequest)
Lists all groups in the identity store.
|
default ListGroupsPublisher |
listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Lists all groups in the identity store.
|
default ListGroupsPublisher |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Lists all groups in the identity store.
|
default CompletableFuture<ListUsersResponse> |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists all users in the identity store.
|
default CompletableFuture<ListUsersResponse> |
listUsers(ListUsersRequest listUsersRequest)
Lists all users in the identity store.
|
default ListUsersPublisher |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists all users in the identity store.
|
default ListUsersPublisher |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists all users in the identity store.
|
default IdentitystoreServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<UpdateGroupResponse> |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
For the specified group in the specified identity store, updates the group metadata and attributes.
|
default CompletableFuture<UpdateGroupResponse> |
updateGroup(UpdateGroupRequest updateGroupRequest)
For the specified group in the specified identity store, updates the group metadata and attributes.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
For the specified user in the specified identity store, updates the user metadata and attributes.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(UpdateUserRequest updateUserRequest)
For the specified user in the specified identity store, updates the user metadata and attributes.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
Creates a group within the specified identity store.
createGroupRequest - Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group within the specified identity store.
This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest - A Consumer that will call methods on
CreateGroupRequest.Builder to create a
request.Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
Creates a relationship between a member and a group. The following identifiers must be specified:
GroupId, IdentityStoreId, and MemberId.
createGroupMembershipRequest - Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)
Creates a relationship between a member and a group. The following identifiers must be specified:
GroupId, IdentityStoreId, and MemberId.
This is a convenience which creates an instance of the CreateGroupMembershipRequest.Builder avoiding the
need to create one manually via CreateGroupMembershipRequest.builder()
createGroupMembershipRequest - A Consumer that will call methods on
CreateGroupMembershipRequest.Builder to create
a request.Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)
Creates a user within the specified identity store.
createUserRequest - Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user within the specified identity store.
This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on
CreateUserRequest.Builder to create a request.Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
Delete a group within an identity store given GroupId.
deleteGroupRequest - Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Delete a group within an identity store given GroupId.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest - A Consumer that will call methods on
DeleteGroupRequest.Builder to create a
request.Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Delete a membership within a group given MembershipId.
deleteGroupMembershipRequest - Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)
Delete a membership within a group given MembershipId.
This is a convenience which creates an instance of the DeleteGroupMembershipRequest.Builder avoiding the
need to create one manually via DeleteGroupMembershipRequest.builder()
deleteGroupMembershipRequest - A Consumer that will call methods on
DeleteGroupMembershipRequest.Builder to create
a request.Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user within an identity store given UserId.
deleteUserRequest - Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user within an identity store given UserId.
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on
DeleteUserRequest.Builder to create a request.Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest)
Retrieves the group metadata and attributes from GroupId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
describeGroupRequest - default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
Retrieves the group metadata and attributes from GroupId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the DescribeGroupRequest.Builder avoiding the need to
create one manually via DescribeGroupRequest.builder()
describeGroupRequest - A Consumer that will call methods on
DescribeGroupRequest.Builder to create a
request.default CompletableFuture<DescribeGroupMembershipResponse> describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
Retrieves membership metadata and attributes from MembershipId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
describeGroupMembershipRequest - default CompletableFuture<DescribeGroupMembershipResponse> describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)
Retrieves membership metadata and attributes from MembershipId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the DescribeGroupMembershipRequest.Builder avoiding
the need to create one manually via DescribeGroupMembershipRequest.builder()
describeGroupMembershipRequest - A Consumer that will call methods on
DescribeGroupMembershipRequest.Builder to
create a request.default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)
Retrieves the user metadata and attributes from the UserId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
describeUserRequest - default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Retrieves the user metadata and attributes from the UserId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on
DescribeUserRequest.Builder to create a
request.default CompletableFuture<GetGroupIdResponse> getGroupId(GetGroupIdRequest getGroupIdRequest)
Retrieves GroupId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
getGroupIdRequest - default CompletableFuture<GetGroupIdResponse> getGroupId(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest)
Retrieves GroupId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the GetGroupIdRequest.Builder avoiding the need to
create one manually via GetGroupIdRequest.builder()
getGroupIdRequest - A Consumer that will call methods on
GetGroupIdRequest.Builder to create a request.default CompletableFuture<GetGroupMembershipIdResponse> getGroupMembershipId(GetGroupMembershipIdRequest getGroupMembershipIdRequest)
Retrieves the MembershipId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
getGroupMembershipIdRequest - default CompletableFuture<GetGroupMembershipIdResponse> getGroupMembershipId(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest)
Retrieves the MembershipId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the GetGroupMembershipIdRequest.Builder avoiding the
need to create one manually via GetGroupMembershipIdRequest.builder()
getGroupMembershipIdRequest - A Consumer that will call methods on
GetGroupMembershipIdRequest.Builder to create
a request.default CompletableFuture<GetUserIdResponse> getUserId(GetUserIdRequest getUserIdRequest)
Retrieves the UserId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
getUserIdRequest - default CompletableFuture<GetUserIdResponse> getUserId(Consumer<GetUserIdRequest.Builder> getUserIdRequest)
Retrieves the UserId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the GetUserIdRequest.Builder avoiding the need to
create one manually via GetUserIdRequest.builder()
getUserIdRequest - A Consumer that will call methods on
GetUserIdRequest.Builder to create a request.default CompletableFuture<IsMemberInGroupsResponse> isMemberInGroups(IsMemberInGroupsRequest isMemberInGroupsRequest)
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
isMemberInGroupsRequest - default CompletableFuture<IsMemberInGroupsResponse> isMemberInGroups(Consumer<IsMemberInGroupsRequest.Builder> isMemberInGroupsRequest)
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the IsMemberInGroupsRequest.Builder avoiding the need
to create one manually via IsMemberInGroupsRequest.builder()
isMemberInGroupsRequest - A Consumer that will call methods on
IsMemberInGroupsRequest.Builder to create a
request.default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
listGroupMembershipsRequest - default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the ListGroupMembershipsRequest.Builder avoiding the
need to create one manually via ListGroupMembershipsRequest.builder()
listGroupMembershipsRequest - A Consumer that will call methods on
ListGroupMembershipsRequest.Builder to create
a request.default CompletableFuture<ListGroupMembershipsForMemberResponse> listGroupMembershipsForMember(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
listGroupMembershipsForMemberRequest - default CompletableFuture<ListGroupMembershipsForMemberResponse> listGroupMembershipsForMember(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the ListGroupMembershipsForMemberRequest.Builder
avoiding the need to create one manually via ListGroupMembershipsForMemberRequest.builder()
listGroupMembershipsForMemberRequest - A Consumer that will call methods on
ListGroupMembershipsForMemberRequest.Builder
to create a request.default ListGroupMembershipsForMemberPublisher listGroupMembershipsForMemberPaginator(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)
operation.
listGroupMembershipsForMemberRequest - default ListGroupMembershipsForMemberPublisher listGroupMembershipsForMemberPaginator(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)
operation.
This is a convenience which creates an instance of the ListGroupMembershipsForMemberRequest.Builder
avoiding the need to create one manually via ListGroupMembershipsForMemberRequest.builder()
listGroupMembershipsForMemberRequest - A Consumer that will call methods on
ListGroupMembershipsForMemberRequest.Builder
to create a request.default ListGroupMembershipsPublisher listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)
operation.
listGroupMembershipsRequest - default ListGroupMembershipsPublisher listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)
operation.
This is a convenience which creates an instance of the ListGroupMembershipsRequest.Builder avoiding the
need to create one manually via ListGroupMembershipsRequest.builder()
listGroupMembershipsRequest - A Consumer that will call methods on
ListGroupMembershipsRequest.Builder to create
a request.default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)
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.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
listGroupsRequest - default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
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.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on
ListGroupsRequest.Builder to create a request.default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)
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.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation.
listGroupsRequest - default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
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.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation.
This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on
ListGroupsRequest.Builder to create a request.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
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.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
listUsersRequest - default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
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.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on
ListUsersRequest.Builder to create a request.default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)
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.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.identitystore.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation.
listUsersRequest - default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
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.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.identitystore.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on
ListUsersRequest.Builder to create a request.default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)
For the specified group in the specified identity store, updates the group metadata and attributes.
updateGroupRequest - Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
For the specified group in the specified identity store, updates the group metadata and attributes.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest - A Consumer that will call methods on
UpdateGroupRequest.Builder to create a
request.Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)
For the specified user in the specified identity store, updates the user metadata and attributes.
updateUserRequest - Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
For the specified user in the specified identity store, updates the user metadata and attributes.
This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to
create one manually via UpdateUserRequest.builder()
updateUserRequest - A Consumer that will call methods on
UpdateUserRequest.Builder to create a request.Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
default IdentitystoreServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic IdentitystoreAsyncClient create()
IdentitystoreAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IdentitystoreAsyncClientBuilder builder()
IdentitystoreAsyncClient.Copyright © 2023. All rights reserved.