Interface IdentitystoreAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aIdentitystoreAsyncClient
.static IdentitystoreAsyncClient
create()
Create aIdentitystoreAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.createGroupMembership
(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest) Creates a relationship between a member and a group.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 givenGroupId
.default CompletableFuture
<DeleteGroupResponse> deleteGroup
(DeleteGroupRequest deleteGroupRequest) Delete a group within an identity store givenGroupId
.deleteGroupMembership
(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest) Delete a membership within a group givenMembershipId
.deleteGroupMembership
(DeleteGroupMembershipRequest deleteGroupMembershipRequest) Delete a membership within a group givenMembershipId
.default CompletableFuture
<DeleteUserResponse> deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user within an identity store givenUserId
.default CompletableFuture
<DeleteUserResponse> deleteUser
(DeleteUserRequest deleteUserRequest) Deletes a user within an identity store givenUserId
.default CompletableFuture
<DescribeGroupResponse> describeGroup
(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Retrieves the group metadata and attributes fromGroupId
in an identity store.default CompletableFuture
<DescribeGroupResponse> describeGroup
(DescribeGroupRequest describeGroupRequest) Retrieves the group metadata and attributes fromGroupId
in an identity store.describeGroupMembership
(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest) Retrieves membership metadata and attributes fromMembershipId
in an identity store.describeGroupMembership
(DescribeGroupMembershipRequest describeGroupMembershipRequest) Retrieves membership metadata and attributes fromMembershipId
in an identity store.default CompletableFuture
<DescribeUserResponse> describeUser
(Consumer<DescribeUserRequest.Builder> describeUserRequest) Retrieves the user metadata and attributes from theUserId
in an identity store.default CompletableFuture
<DescribeUserResponse> describeUser
(DescribeUserRequest describeUserRequest) Retrieves the user metadata and attributes from theUserId
in an identity store.default CompletableFuture
<GetGroupIdResponse> getGroupId
(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest) RetrievesGroupId
in an identity store.default CompletableFuture
<GetGroupIdResponse> getGroupId
(GetGroupIdRequest getGroupIdRequest) RetrievesGroupId
in an identity store.getGroupMembershipId
(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest) Retrieves theMembershipId
in an identity store.getGroupMembershipId
(GetGroupMembershipIdRequest getGroupMembershipIdRequest) Retrieves theMembershipId
in an identity store.default CompletableFuture
<GetUserIdResponse> getUserId
(Consumer<GetUserIdRequest.Builder> getUserIdRequest) Retrieves theUserId
in an identity store.default CompletableFuture
<GetUserIdResponse> getUserId
(GetUserIdRequest getUserIdRequest) Retrieves theUserId
in an identity store.isMemberInGroups
(Consumer<IsMemberInGroupsRequest.Builder> isMemberInGroupsRequest) Checks the user's membership in all requested groups and returns if the member exists in all queried groups.isMemberInGroups
(IsMemberInGroupsRequest isMemberInGroupsRequest) Checks the user's membership in all requested groups and returns if the member exists in all queried groups.listGroupMemberships
(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) For the specified group in the specified identity store, returns the list of allGroupMembership
objects and returns results in paginated form.listGroupMemberships
(ListGroupMembershipsRequest listGroupMembershipsRequest) For the specified group in the specified identity store, returns the list of allGroupMembership
objects and returns results in paginated form.listGroupMembershipsForMember
(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest) For the specified member in the specified identity store, returns the list of allGroupMembership
objects and returns results in paginated form.listGroupMembershipsForMember
(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest) For the specified member in the specified identity store, returns the list of allGroupMembership
objects and returns results in paginated form.listGroupMembershipsForMemberPaginator
(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest) This is a variant oflistGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)
operation.listGroupMembershipsForMemberPaginator
(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest) This is a variant oflistGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)
operation.default ListGroupMembershipsPublisher
listGroupMembershipsPaginator
(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) This is a variant oflistGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)
operation.default ListGroupMembershipsPublisher
listGroupMembershipsPaginator
(ListGroupMembershipsRequest listGroupMembershipsRequest) This is a variant oflistGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)
operation.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) This is a variant oflistGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest)
operation.default ListGroupsPublisher
listGroupsPaginator
(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest)
operation.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) This is a variant oflistUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest)
operation.default ListUsersPublisher
listUsersPaginator
(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault 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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createGroup
Creates a group within the specified identity store.
- Parameters:
createGroupRequest
-- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroup
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 viaCreateGroupRequest.builder()
- Parameters:
createGroupRequest
- AConsumer
that will call methods onCreateGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroupMembership
default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest) Creates a relationship between a member and a group. The following identifiers must be specified:
GroupId
,IdentityStoreId
, andMemberId
.- Parameters:
createGroupMembershipRequest
-- Returns:
- A Java Future containing the result of the CreateGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroupMembership
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
, andMemberId
.
This is a convenience which creates an instance of the
CreateGroupMembershipRequest.Builder
avoiding the need to create one manually viaCreateGroupMembershipRequest.builder()
- Parameters:
createGroupMembershipRequest
- AConsumer
that will call methods onCreateGroupMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
Creates a user within the specified identity store.
- Parameters:
createUserRequest
-- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
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 viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroup
Delete a group within an identity store given
GroupId
.- Parameters:
deleteGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroup
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 viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroupMembership
default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest) Delete a membership within a group given
MembershipId
.- Parameters:
deleteGroupMembershipRequest
-- Returns:
- A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroupMembership
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 viaDeleteGroupMembershipRequest.builder()
- Parameters:
deleteGroupMembershipRequest
- AConsumer
that will call methods onDeleteGroupMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
Deletes a user within an identity store given
UserId
.- Parameters:
deleteUserRequest
-- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
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 viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroup
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.
- Parameters:
describeGroupRequest
-- Returns:
- A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroup
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 viaDescribeGroupRequest.builder()
- Parameters:
describeGroupRequest
- AConsumer
that will call methods onDescribeGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroupMembership
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.
- Parameters:
describeGroupMembershipRequest
-- Returns:
- A Java Future containing the result of the DescribeGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroupMembership
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 viaDescribeGroupMembershipRequest.builder()
- Parameters:
describeGroupMembershipRequest
- AConsumer
that will call methods onDescribeGroupMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
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.
- Parameters:
describeUserRequest
-- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
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 viaDescribeUserRequest.builder()
- Parameters:
describeUserRequest
- AConsumer
that will call methods onDescribeUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroupId
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.
- Parameters:
getGroupIdRequest
-- Returns:
- A Java Future containing the result of the GetGroupId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroupId
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 viaGetGroupIdRequest.builder()
- Parameters:
getGroupIdRequest
- AConsumer
that will call methods onGetGroupIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGroupId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroupMembershipId
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.
- Parameters:
getGroupMembershipIdRequest
-- Returns:
- A Java Future containing the result of the GetGroupMembershipId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroupMembershipId
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 viaGetGroupMembershipIdRequest.builder()
- Parameters:
getGroupMembershipIdRequest
- AConsumer
that will call methods onGetGroupMembershipIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGroupMembershipId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getUserId
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.
- Parameters:
getUserIdRequest
-- Returns:
- A Java Future containing the result of the GetUserId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getUserId
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 viaGetUserIdRequest.builder()
- Parameters:
getUserIdRequest
- AConsumer
that will call methods onGetUserIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetUserId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
isMemberInGroups
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.
- Parameters:
isMemberInGroupsRequest
-- Returns:
- A Java Future containing the result of the IsMemberInGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
isMemberInGroups
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 viaIsMemberInGroupsRequest.builder()
- Parameters:
isMemberInGroupsRequest
- AConsumer
that will call methods onIsMemberInGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the IsMemberInGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMemberships
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.
- Parameters:
listGroupMembershipsRequest
-- Returns:
- A Java Future containing the result of the ListGroupMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMemberships
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 viaListGroupMembershipsRequest.builder()
- Parameters:
listGroupMembershipsRequest
- AConsumer
that will call methods onListGroupMembershipsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroupMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembershipsForMember
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.
- Parameters:
listGroupMembershipsForMemberRequest
-- Returns:
- A Java Future containing the result of the ListGroupMembershipsForMember operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembershipsForMember
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 viaListGroupMembershipsForMemberRequest.builder()
- Parameters:
listGroupMembershipsForMemberRequest
- AConsumer
that will call methods onListGroupMembershipsForMemberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroupMembershipsForMember operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembershipsForMemberPaginator
default ListGroupMembershipsForMemberPublisher listGroupMembershipsForMemberPaginator(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listGroupMembershipsForMemberRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembershipsForMemberPaginator
default ListGroupMembershipsForMemberPublisher listGroupMembershipsForMemberPaginator(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListGroupMembershipsForMemberRequest.builder()
- Parameters:
listGroupMembershipsForMemberRequest
- AConsumer
that will call methods onListGroupMembershipsForMemberRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembershipsPaginator
default ListGroupMembershipsPublisher listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listGroupMembershipsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembershipsPaginator
default ListGroupMembershipsPublisher listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListGroupMembershipsRequest.builder()
- Parameters:
listGroupMembershipsRequest
- AConsumer
that will call methods onListGroupMembershipsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroups
Lists all groups in the identity store. Returns a paginated list of complete
Group
objects. Filtering for aGroup
by theDisplayName
attribute is deprecated. Instead, use theGetGroupId
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.
- Parameters:
listGroupsRequest
-- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroups
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 aGroup
by theDisplayName
attribute is deprecated. Instead, use theGetGroupId
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 viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsPaginator
default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
Lists all users in the identity store. Returns a paginated list of complete
User
objects. Filtering for aUser
by theUserName
attribute is deprecated. Instead, use theGetUserId
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.
- Parameters:
listUsersRequest
-- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
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 aUser
by theUserName
attribute is deprecated. Instead, use theGetUserId
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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listUsersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGroup
For the specified group in the specified identity store, updates the group metadata and attributes.
- Parameters:
updateGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGroup
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 viaUpdateGroupRequest.builder()
- Parameters:
updateGroupRequest
- AConsumer
that will call methods onUpdateGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
For the specified user in the specified identity store, updates the user metadata and attributes.
- Parameters:
updateUserRequest
-- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
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 viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Indicates that a requested resource is not found.
- ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException This request cannot be completed for one of the following reasons:
-
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.
-
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException The request failed because it contains a syntax error.
- ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IdentitystoreException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aIdentitystoreAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIdentitystoreAsyncClient
.
-