@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IdentitystoreClient extends AwsClient
builder() method.
The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.
<note> <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and <code>identitystore</code> API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p> </note> <p>This reference guide describes the identity store operations that you can call programatically and includes detailed information about data types and errors.</p>
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static 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)
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(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 ListGroupMembershipsIterable |
listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default ListGroupMembershipsIterable |
listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
default 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)
Lists all groups in the identity store.
|
default ListGroupsIterable |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Lists all groups in the identity store.
|
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)
Lists all users in the identity store.
|
default ListUsersIterable |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists all users in the identity store.
|
default IdentitystoreServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
Creates a group within the specified identity store.
createGroupRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createGroupMembershipRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createGroupMembershipRequest - A Consumer that will call methods on CreateGroupMembershipRequest.Builder to create a
request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
Creates a user within the specified identity store.
createUserRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Delete a group within an identity store given GroupId.
deleteGroupRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGroupMembershipResponse deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Delete a membership within a group given MembershipId.
deleteGroupMembershipRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteGroupMembershipRequest - A Consumer that will call methods on DeleteGroupMembershipRequest.Builder to create a
request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Deletes a user within an identity store given UserId.
deleteUserRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeGroupRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the DescribeGroupRequest.Builder avoiding the need to
create one manually via DescribeGroupRequest.builder()
describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGroupMembershipResponse describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves membership metadata and attributes from MembershipId in an identity store.
describeGroupMembershipRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the DescribeGroupMembershipRequest.Builder avoiding
the need to create one manually via DescribeGroupMembershipRequest.builder()
describeGroupMembershipRequest - A Consumer that will call methods on DescribeGroupMembershipRequest.Builder to create a
request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeUserRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGroupIdResponse getGroupId(GetGroupIdRequest getGroupIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves GroupId in an identity store.
getGroupIdRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGroupIdResponse getGroupId(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves GroupId in an identity store.
This is a convenience which creates an instance of the GetGroupIdRequest.Builder avoiding the need to
create one manually via GetGroupIdRequest.builder()
getGroupIdRequest - A Consumer that will call methods on GetGroupIdRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGroupMembershipIdResponse getGroupMembershipId(GetGroupMembershipIdRequest getGroupMembershipIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the MembershipId in an identity store.
getGroupMembershipIdRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGroupMembershipIdResponse getGroupMembershipId(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the MembershipId in an identity store.
This is a convenience which creates an instance of the GetGroupMembershipIdRequest.Builder avoiding the
need to create one manually via GetGroupMembershipIdRequest.builder()
getGroupMembershipIdRequest - A Consumer that will call methods on GetGroupMembershipIdRequest.Builder to create a
request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUserIdResponse getUserId(GetUserIdRequest getUserIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the UserId in an identity store.
getUserIdRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUserIdResponse getUserId(Consumer<GetUserIdRequest.Builder> getUserIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the UserId in an identity store.
This is a convenience which creates an instance of the GetUserIdRequest.Builder avoiding the need to
create one manually via GetUserIdRequest.builder()
getUserIdRequest - A Consumer that will call methods on GetUserIdRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
isMemberInGroupsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the IsMemberInGroupsRequest.Builder avoiding the need
to create one manually via IsMemberInGroupsRequest.builder()
isMemberInGroupsRequest - A Consumer that will call methods on IsMemberInGroupsRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listGroupMembershipsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the ListGroupMembershipsRequest.Builder avoiding the
need to create one manually via ListGroupMembershipsRequest.builder()
listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a
request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembershipsIterable listGroupMembershipsPaginator(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.
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.
listGroupMembershipsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembershipsIterable listGroupMembershipsPaginator(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.
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()
listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a
request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listGroupMembershipsForMemberRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the ListGroupMembershipsForMemberRequest.Builder
avoiding the need to create one manually via ListGroupMembershipsForMemberRequest.builder()
listGroupMembershipsForMemberRequest - A Consumer that will call methods on ListGroupMembershipsForMemberRequest.Builder to
create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembershipsForMemberIterable listGroupMembershipsForMemberPaginator(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.
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.
listGroupMembershipsForMemberRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembershipsForMemberIterable listGroupMembershipsForMemberPaginator(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.
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()
listGroupMembershipsForMemberRequest - A Consumer that will call methods on ListGroupMembershipsForMemberRequest.Builder to
create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listGroupsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsIterable listGroupsPaginator(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.
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.
listGroupsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsIterable listGroupsPaginator(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.
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()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listUsersRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(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.
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.
listUsersRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(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.
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()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateGroupRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateGroupRequest.builder()
updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateUserRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateUserRequest.builder()
updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic IdentitystoreClient create()
IdentitystoreClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IdentitystoreClientBuilder builder()
IdentitystoreClient.static ServiceMetadata serviceMetadata()
default IdentitystoreServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.