Interface IdentitystoreClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface IdentitystoreClient
extends AwsClient

Service client for accessing IdentityStore. This can be created using the static builder() method.

The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.

This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.

IAM Identity Center uses the sso, sso-directory, and identitystore API namespaces. The sso-directory and identitystore namespaces authorize access to data in the Identity Store. Make sure your policies with IAM actions from these two namespaces are consistent to avoid conflicting authorization to the same data.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static IdentitystoreClientBuilder	builder()	Create a builder that can be used to configure and create a IdentitystoreClient.
static IdentitystoreClient	create()	Create a IdentitystoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateGroupResponse	createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)	Creates a group within the specified identity store.
default CreateGroupResponse	createGroup(CreateGroupRequest createGroupRequest)	Creates a group within the specified identity store.
default CreateGroupMembershipResponse	createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)	Creates a relationship between a member and a group.
default CreateGroupMembershipResponse	createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)	Creates a relationship between a member and a group.
default CreateUserResponse	createUser(Consumer<CreateUserRequest.Builder> createUserRequest)	Creates a user within the specified identity store.
default CreateUserResponse	createUser(CreateUserRequest createUserRequest)	Creates a user within the specified identity store.
default DeleteGroupResponse	deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)	Delete a group within an identity store given GroupId.
default DeleteGroupResponse	deleteGroup(DeleteGroupRequest deleteGroupRequest)	Delete a group within an identity store given GroupId.
default DeleteGroupMembershipResponse	deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)	Delete a membership within a group given MembershipId.
default DeleteGroupMembershipResponse	deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)	Delete a membership within a group given MembershipId.
default DeleteUserResponse	deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)	Deletes a user within an identity store given UserId.
default DeleteUserResponse	deleteUser(DeleteUserRequest deleteUserRequest)	Deletes a user within an identity store given UserId.
default DescribeGroupResponse	describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)	Retrieves the group metadata and attributes from GroupId in an identity store.
default DescribeGroupResponse	describeGroup(DescribeGroupRequest describeGroupRequest)	Retrieves the group metadata and attributes from GroupId in an identity store.
default DescribeGroupMembershipResponse	describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)	Retrieves membership metadata and attributes from MembershipId in an identity store.
default DescribeGroupMembershipResponse	describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)	Retrieves membership metadata and attributes from MembershipId in an identity store.
default DescribeUserResponse	describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)	Retrieves the user metadata and attributes from the UserId in an identity store.
default DescribeUserResponse	describeUser(DescribeUserRequest describeUserRequest)	Retrieves the user metadata and attributes from the UserId in an identity store.
default GetGroupIdResponse	getGroupId(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest)	Retrieves GroupId in an identity store.
default GetGroupIdResponse	getGroupId(GetGroupIdRequest getGroupIdRequest)	Retrieves GroupId in an identity store.
default GetGroupMembershipIdResponse	getGroupMembershipId(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest)	Retrieves the MembershipId in an identity store.
default GetGroupMembershipIdResponse	getGroupMembershipId(GetGroupMembershipIdRequest getGroupMembershipIdRequest)	Retrieves the MembershipId in an identity store.
default GetUserIdResponse	getUserId(Consumer<GetUserIdRequest.Builder> getUserIdRequest)	Retrieves the UserId in an identity store.
default GetUserIdResponse	getUserId(GetUserIdRequest getUserIdRequest)	Retrieves the UserId in an identity store.
default IsMemberInGroupsResponse	isMemberInGroups(Consumer<IsMemberInGroupsRequest.Builder> isMemberInGroupsRequest)	Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
default IsMemberInGroupsResponse	isMemberInGroups(IsMemberInGroupsRequest isMemberInGroupsRequest)	Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
default ListGroupMembershipsResponse	listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)	For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
default ListGroupMembershipsResponse	listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)	For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
default ListGroupMembershipsForMemberResponse	listGroupMembershipsForMember(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)	For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
default ListGroupMembershipsForMemberResponse	listGroupMembershipsForMember(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)	For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
default ListGroupMembershipsForMemberIterable	listGroupMembershipsForMemberPaginator(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)	This is a variant of listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest) operation.
default ListGroupMembershipsForMemberIterable	listGroupMembershipsForMemberPaginator(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)	This is a variant of listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest) operation.
default ListGroupMembershipsIterable	listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)	This is a variant of listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest) operation.
default ListGroupMembershipsIterable	listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest)	This is a variant of listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest) operation.
default ListGroupsResponse	listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)	Lists all groups in the identity store.
default ListGroupsResponse	listGroups(ListGroupsRequest listGroupsRequest)	Lists all groups in the identity store.
default ListGroupsIterable	listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)	This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation.
default ListGroupsIterable	listGroupsPaginator(ListGroupsRequest listGroupsRequest)	This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation.
default ListUsersResponse	listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)	Lists all users in the identity store.
default ListUsersResponse	listUsers(ListUsersRequest listUsersRequest)	Lists all users in the identity store.
default ListUsersIterable	listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)	This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation.
default ListUsersIterable	listUsersPaginator(ListUsersRequest listUsersRequest)	This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation.
default IdentitystoreServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdateGroupResponse	updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)	Updates the specified group metadata and attributes in the specified identity store.
default UpdateGroupResponse	updateGroup(UpdateGroupRequest updateGroupRequest)	Updates the specified group metadata and attributes in the specified identity store.
default UpdateUserResponse	updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)	Updates the specified user metadata and attributes in the specified identity store.
default UpdateUserResponse	updateUser(UpdateUserRequest updateUserRequest)	Updates the specified user metadata and attributes in the specified identity store.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createGroup

default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Creates a group within the specified identity store.

Parameters:

createGroupRequest -

Returns:

Result of the CreateGroup operation returned by the service.

See Also:

• AWS API Documentation

createGroup

default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Creates a group within the specified identity store.

This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to create one manually via CreateGroupRequest.builder()

Parameters:

createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.

Returns:

Result of the CreateGroup operation returned by the service.

See Also:

• AWS API Documentation

createGroupMembership

default CreateGroupMembershipResponse createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
                                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

Parameters:

createGroupMembershipRequest -

Returns:

Result of the CreateGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

createGroupMembership

default CreateGroupMembershipResponse createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)
                                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

This is a convenience which creates an instance of the CreateGroupMembershipRequest.Builder avoiding the need to create one manually via CreateGroupMembershipRequest.builder()

Parameters:

createGroupMembershipRequest - A Consumer that will call methods on CreateGroupMembershipRequest.Builder to create a request.

Returns:

Result of the CreateGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

createUser

default CreateUserResponse createUser(CreateUserRequest createUserRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Creates a user within the specified identity store.

Parameters:

createUserRequest -

Returns:

Result of the CreateUser operation returned by the service.

See Also:

• AWS API Documentation

createUser

default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Creates a user within the specified identity store.

This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to create one manually via CreateUserRequest.builder()

Parameters:

createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.

Returns:

Result of the CreateUser operation returned by the service.

See Also:

• AWS API Documentation

deleteGroup

default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Delete a group within an identity store given GroupId.

Parameters:

deleteGroupRequest -

Returns:

Result of the DeleteGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteGroup

default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Delete a group within an identity store given GroupId.

This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to create one manually via DeleteGroupRequest.builder()

Parameters:

deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.

Returns:

Result of the DeleteGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteGroupMembership

default DeleteGroupMembershipResponse deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
                                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Delete a membership within a group given MembershipId.

Parameters:

deleteGroupMembershipRequest -

Returns:

Result of the DeleteGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

deleteGroupMembership

default DeleteGroupMembershipResponse deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)
                                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Delete a membership within a group given MembershipId.

This is a convenience which creates an instance of the DeleteGroupMembershipRequest.Builder avoiding the need to create one manually via DeleteGroupMembershipRequest.builder()

Parameters:

deleteGroupMembershipRequest - A Consumer that will call methods on DeleteGroupMembershipRequest.Builder to create a request.

Returns:

Result of the DeleteGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Deletes a user within an identity store given UserId.

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

See Also:

• AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Deletes a user within an identity store given UserId.

This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to create one manually via DeleteUserRequest.builder()

Parameters:

deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.

Returns:

Result of the DeleteUser operation returned by the service.

See Also:

• AWS API Documentation

describeGroup

default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest)
                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves the group metadata and attributes from GroupId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

describeGroupRequest -

Returns:

Result of the DescribeGroup operation returned by the service.

See Also:

• AWS API Documentation

describeGroup

default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves the group metadata and attributes from GroupId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the DescribeGroupRequest.Builder avoiding the need to create one manually via DescribeGroupRequest.builder()

Parameters:

describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.

Returns:

Result of the DescribeGroup operation returned by the service.

See Also:

• AWS API Documentation

describeGroupMembership

default DescribeGroupMembershipResponse describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
                                                         throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves membership metadata and attributes from MembershipId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

describeGroupMembershipRequest -

Returns:

Result of the DescribeGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

describeGroupMembership

default DescribeGroupMembershipResponse describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)
                                                         throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves membership metadata and attributes from MembershipId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the DescribeGroupMembershipRequest.Builder avoiding the need to create one manually via DescribeGroupMembershipRequest.builder()

Parameters:

describeGroupMembershipRequest - A Consumer that will call methods on DescribeGroupMembershipRequest.Builder to create a request.

Returns:

Result of the DescribeGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

describeUser

default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest)
                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves the user metadata and attributes from the UserId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

describeUserRequest -

Returns:

Result of the DescribeUser operation returned by the service.

See Also:

• AWS API Documentation

describeUser

default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves the user metadata and attributes from the UserId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to create one manually via DescribeUserRequest.builder()

Parameters:

describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.

Returns:

Result of the DescribeUser operation returned by the service.

See Also:

• AWS API Documentation

getGroupId

default GetGroupIdResponse getGroupId(GetGroupIdRequest getGroupIdRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves GroupId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

getGroupIdRequest -

Returns:

Result of the GetGroupId operation returned by the service.

See Also:

• AWS API Documentation

getGroupId

default GetGroupIdResponse getGroupId(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves GroupId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the GetGroupIdRequest.Builder avoiding the need to create one manually via GetGroupIdRequest.builder()

Parameters:

getGroupIdRequest - A Consumer that will call methods on GetGroupIdRequest.Builder to create a request.

Returns:

Result of the GetGroupId operation returned by the service.

See Also:

• AWS API Documentation

getGroupMembershipId

default GetGroupMembershipIdResponse getGroupMembershipId(GetGroupMembershipIdRequest getGroupMembershipIdRequest)
                                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves the MembershipId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

getGroupMembershipIdRequest -

Returns:

Result of the GetGroupMembershipId operation returned by the service.

See Also:

• AWS API Documentation

getGroupMembershipId

default GetGroupMembershipIdResponse getGroupMembershipId(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest)
                                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves the MembershipId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the GetGroupMembershipIdRequest.Builder avoiding the need to create one manually via GetGroupMembershipIdRequest.builder()

Parameters:

getGroupMembershipIdRequest - A Consumer that will call methods on GetGroupMembershipIdRequest.Builder to create a request.

Returns:

Result of the GetGroupMembershipId operation returned by the service.

See Also:

• AWS API Documentation

getUserId

default GetUserIdResponse getUserId(GetUserIdRequest getUserIdRequest)
                             throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves the UserId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

getUserIdRequest -

Returns:

Result of the GetUserId operation returned by the service.

See Also:

• AWS API Documentation

getUserId

default GetUserIdResponse getUserId(Consumer<GetUserIdRequest.Builder> getUserIdRequest)
                             throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Retrieves the UserId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the GetUserIdRequest.Builder avoiding the need to create one manually via GetUserIdRequest.builder()

Parameters:

getUserIdRequest - A Consumer that will call methods on GetUserIdRequest.Builder to create a request.

Returns:

Result of the GetUserId operation returned by the service.

See Also:

• AWS API Documentation

isMemberInGroups

default IsMemberInGroupsResponse isMemberInGroups(IsMemberInGroupsRequest isMemberInGroupsRequest)
                                           throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

isMemberInGroupsRequest -

Returns:

Result of the IsMemberInGroups operation returned by the service.

See Also:

• AWS API Documentation

isMemberInGroups

default IsMemberInGroupsResponse isMemberInGroups(Consumer<IsMemberInGroupsRequest.Builder> isMemberInGroupsRequest)
                                           throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the IsMemberInGroupsRequest.Builder avoiding the need to create one manually via IsMemberInGroupsRequest.builder()

Parameters:

isMemberInGroupsRequest - A Consumer that will call methods on IsMemberInGroupsRequest.Builder to create a request.

Returns:

Result of the IsMemberInGroups operation returned by the service.

See Also:

• AWS API Documentation

listGroupMemberships

default ListGroupMembershipsResponse listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
                                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

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 access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

listGroupMembershipsRequest -

Returns:

Result of the ListGroupMemberships operation returned by the service.

See Also:

• AWS API Documentation

listGroupMemberships

default ListGroupMembershipsResponse listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
                                                   throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

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 access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the ListGroupMembershipsRequest.Builder avoiding the need to create one manually via ListGroupMembershipsRequest.builder()

Parameters:

listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a request.

Returns:

Result of the ListGroupMemberships operation returned by the service.

See Also:

• AWS API Documentation

listGroupMembershipsPaginator

default ListGroupMembershipsIterable listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest)
                                                            throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

This is a variant of listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client
             .listGroupMembershipsPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGroupMembershipsPaginator

default ListGroupMembershipsIterable listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
                                                            throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

This is a variant of listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client
             .listGroupMembershipsPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest) operation.

This is a convenience which creates an instance of the ListGroupMembershipsRequest.Builder avoiding the need to create one manually via ListGroupMembershipsRequest.builder()

Parameters:

listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGroupMembershipsForMember

default ListGroupMembershipsForMemberResponse listGroupMembershipsForMember(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)
                                                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

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 access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

listGroupMembershipsForMemberRequest -

Returns:

Result of the ListGroupMembershipsForMember operation returned by the service.

See Also:

• AWS API Documentation

listGroupMembershipsForMember

default ListGroupMembershipsForMemberResponse listGroupMembershipsForMember(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)
                                                                     throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

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 access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the ListGroupMembershipsForMemberRequest.Builder avoiding the need to create one manually via ListGroupMembershipsForMemberRequest.builder()

Parameters:

listGroupMembershipsForMemberRequest - A Consumer that will call methods on ListGroupMembershipsForMemberRequest.Builder to create a request.

Returns:

Result of the ListGroupMembershipsForMember operation returned by the service.

See Also:

• AWS API Documentation

listGroupMembershipsForMemberPaginator

default ListGroupMembershipsForMemberIterable listGroupMembershipsForMemberPaginator(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)
                                                                              throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

This is a variant of listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client
             .listGroupMembershipsForMemberPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGroupMembershipsForMemberPaginator

default ListGroupMembershipsForMemberIterable listGroupMembershipsForMemberPaginator(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)
                                                                              throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

This is a variant of listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client
             .listGroupMembershipsForMemberPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest) operation.

This is a convenience which creates an instance of the ListGroupMembershipsForMemberRequest.Builder avoiding the need to create one manually via ListGroupMembershipsForMemberRequest.builder()

Parameters:

listGroupMembershipsForMemberRequest - A Consumer that will call methods on ListGroupMembershipsForMemberRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGroups

default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

listGroupsRequest -

Returns:

Result of the ListGroups operation returned by the service.

See Also:

• AWS API Documentation

listGroups

default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to create one manually via ListGroupsRequest.builder()

Parameters:

listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.

Returns:

Result of the ListGroups operation returned by the service.

See Also:

• AWS API Documentation

listGroupsPaginator

default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest)
                                        throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGroupsPaginator

default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
                                        throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation.

This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to create one manually via ListGroupsRequest.builder()

Parameters:

listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listUsers

default ListUsersResponse listUsers(ListUsersRequest listUsersRequest)
                             throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

See Also:

• AWS API Documentation

listUsers

default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
                             throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

Result of the ListUsers operation returned by the service.

See Also:

• AWS API Documentation

listUsersPaginator

default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest)
                                      throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listUsersPaginator

default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
                                      throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
IdentitystoreException

This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation.

This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

updateGroup

default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Updates the specified group metadata and attributes in the specified identity store.

Parameters:

updateGroupRequest -

Returns:

Result of the UpdateGroup operation returned by the service.

See Also:

• AWS API Documentation

updateGroup

default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Updates the specified group metadata and attributes in the specified identity store.

This is a convenience which creates an instance of the UpdateGroupRequest.Builder avoiding the need to create one manually via UpdateGroupRequest.builder()

Parameters:

updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.

Returns:

Result of the UpdateGroup operation returned by the service.

See Also:

• AWS API Documentation

updateUser

default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Updates the specified user metadata and attributes in the specified identity store.

Parameters:

updateUserRequest -

Returns:

Result of the UpdateUser operation returned by the service.

See Also:

• AWS API Documentation

updateUser

default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IdentitystoreException

Updates the specified user metadata and attributes in the specified identity store.

This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to create one manually via UpdateUserRequest.builder()

Parameters:

updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.

Returns:

Result of the UpdateUser operation returned by the service.

See Also:

• AWS API Documentation

create

static IdentitystoreClient create()

Create a IdentitystoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static IdentitystoreClientBuilder builder()

Create a builder that can be used to configure and create a IdentitystoreClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default IdentitystoreServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration