Interface IdentitystoreClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.
This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.
IAM Identity Center uses the sso
and identitystore
API namespaces.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic IdentitystoreClientBuilder
builder()
Create a builder that can be used to configure and create aIdentitystoreClient
.static IdentitystoreClient
create()
Create aIdentitystoreClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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 givenGroupId
.default DeleteGroupResponse
deleteGroup
(DeleteGroupRequest deleteGroupRequest) Delete a group within an identity store givenGroupId
.default DeleteGroupMembershipResponse
deleteGroupMembership
(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest) Delete a membership within a group givenMembershipId
.default DeleteGroupMembershipResponse
deleteGroupMembership
(DeleteGroupMembershipRequest deleteGroupMembershipRequest) Delete a membership within a group givenMembershipId
.default DeleteUserResponse
deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user within an identity store givenUserId
.default DeleteUserResponse
deleteUser
(DeleteUserRequest deleteUserRequest) Deletes a user within an identity store givenUserId
.default DescribeGroupResponse
describeGroup
(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Retrieves the group metadata and attributes fromGroupId
in an identity store.default DescribeGroupResponse
describeGroup
(DescribeGroupRequest describeGroupRequest) Retrieves the group metadata and attributes fromGroupId
in an identity store.default DescribeGroupMembershipResponse
describeGroupMembership
(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest) Retrieves membership metadata and attributes fromMembershipId
in an identity store.default DescribeGroupMembershipResponse
describeGroupMembership
(DescribeGroupMembershipRequest describeGroupMembershipRequest) Retrieves membership metadata and attributes fromMembershipId
in an identity store.default DescribeUserResponse
describeUser
(Consumer<DescribeUserRequest.Builder> describeUserRequest) Retrieves the user metadata and attributes from theUserId
in an identity store.default DescribeUserResponse
describeUser
(DescribeUserRequest describeUserRequest) Retrieves the user metadata and attributes from theUserId
in an identity store.default GetGroupIdResponse
getGroupId
(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest) RetrievesGroupId
in an identity store.default GetGroupIdResponse
getGroupId
(GetGroupIdRequest getGroupIdRequest) RetrievesGroupId
in an identity store.default GetGroupMembershipIdResponse
getGroupMembershipId
(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest) Retrieves theMembershipId
in an identity store.default GetGroupMembershipIdResponse
getGroupMembershipId
(GetGroupMembershipIdRequest getGroupMembershipIdRequest) Retrieves theMembershipId
in an identity store.default GetUserIdResponse
getUserId
(Consumer<GetUserIdRequest.Builder> getUserIdRequest) Retrieves theUserId
in an identity store.default GetUserIdResponse
getUserId
(GetUserIdRequest getUserIdRequest) Retrieves theUserId
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 allGroupMembership
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 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 ListGroupMembershipsIterable
listGroupMembershipsPaginator
(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) This is a variant oflistGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)
operation.default ListGroupMembershipsIterable
listGroupMembershipsPaginator
(ListGroupMembershipsRequest listGroupMembershipsRequest) This is a variant oflistGroupMemberships(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 oflistGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest)
operation.default ListGroupsIterable
listGroupsPaginator
(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(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 oflistUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest)
operation.default ListUsersIterable
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., ClientOverrideConfigurationstatic ServiceMetadata
default UpdateGroupResponse
updateGroup
(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) For the specified group in the specified identity store, updates the group metadata and attributes.default UpdateGroupResponse
updateGroup
(UpdateGroupRequest updateGroupRequest) For the specified group in the specified identity store, updates the group metadata and attributes.default UpdateUserResponse
updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) For the specified user in the specified identity store, updates the user metadata and attributes.default 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
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:
-
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 viaCreateGroupRequest.builder()
- Parameters:
createGroupRequest
- AConsumer
that will call methods onCreateGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
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
, andMemberId
.- Parameters:
createGroupMembershipRequest
-- Returns:
- Result of the CreateGroupMembership operation returned by the service.
- See Also:
-
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
, 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:
- Result of the CreateGroupMembership operation returned by the service.
- See Also:
-
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:
-
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 viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteGroupMembershipRequest.builder()
- Parameters:
deleteGroupMembershipRequest
- AConsumer
that will call methods onDeleteGroupMembershipRequest.Builder
to create a request.- Returns:
- Result of the DeleteGroupMembership operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
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 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:
- Result of the DescribeGroup operation returned by the service.
- See Also:
-
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 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:
- Result of the DescribeGroup operation returned by the service.
- See Also:
-
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 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:
- Result of the DescribeGroupMembership operation returned by the service.
- See Also:
-
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 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:
- Result of the DescribeGroupMembership operation returned by the service.
- See Also:
-
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 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:
- Result of the DescribeUser operation returned by the service.
- See Also:
-
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 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:
- Result of the DescribeUser operation returned by the service.
- See Also:
-
getGroupId
default GetGroupIdResponse getGroupId(GetGroupIdRequest getGroupIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException 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:
- Result of the GetGroupId operation returned by the service.
- See Also:
-
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 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:
- Result of the GetGroupId operation returned by the service.
- See Also:
-
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 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:
- Result of the GetGroupMembershipId operation returned by the service.
- See Also:
-
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 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:
- Result of the GetGroupMembershipId operation returned by the service.
- See Also:
-
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 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:
- Result of the GetUserId operation returned by the service.
- See Also:
-
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 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:
- Result of the GetUserId operation returned by the service.
- See Also:
-
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 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:
- Result of the IsMemberInGroups operation returned by the service.
- See Also:
-
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 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:
- Result of the IsMemberInGroups operation returned by the service.
- See Also:
-
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 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:
- Result of the ListGroupMemberships operation returned by the service.
- See Also:
-
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 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:
- Result of the ListGroupMemberships operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListGroupMembershipsRequest.builder()
- Parameters:
listGroupMembershipsRequest
- AConsumer
that will call methods onListGroupMembershipsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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 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:
- Result of the ListGroupMembershipsForMember operation returned by the service.
- See Also:
-
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 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:
- Result of the ListGroupMembershipsForMember operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListGroupMembershipsForMemberRequest.builder()
- Parameters:
listGroupMembershipsForMemberRequest
- AConsumer
that will call methods onListGroupMembershipsForMemberRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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 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:
- Result of the ListGroups operation returned by the service.
- See Also:
-
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 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:
- Result of the ListGroups operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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 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:
- Result of the ListUsers operation returned by the service.
- See Also:
-
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 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:
- Result of the ListUsers operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
updateGroup
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException For the specified group in the specified identity store, updates the group metadata and attributes.
- Parameters:
updateGroupRequest
-- Returns:
- Result of the UpdateGroup operation returned by the service.
- See Also:
-
updateGroup
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException 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:
- Result of the UpdateGroup operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException For the specified user in the specified identity store, updates the user metadata and attributes.
- Parameters:
updateUserRequest
-- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException 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:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
create
Create aIdentitystoreClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIdentitystoreClient
. -
serviceMetadata
-
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
-