Interface IdentitystoreClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface IdentitystoreClient extends AwsClient
Service client for accessing IdentityStore. This can be created using the staticbuilder()method.The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.
This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.
IAM Identity Center uses the
ssoandidentitystoreAPI namespaces.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static IdentitystoreClientBuilderbuilder()Create a builder that can be used to configure and create aIdentitystoreClient.static IdentitystoreClientcreate()Create aIdentitystoreClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateGroupResponsecreateGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)Creates a group within the specified identity store.default CreateGroupResponsecreateGroup(CreateGroupRequest createGroupRequest)Creates a group within the specified identity store.default CreateGroupMembershipResponsecreateGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)Creates a relationship between a member and a group.default CreateGroupMembershipResponsecreateGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)Creates a relationship between a member and a group.default CreateUserResponsecreateUser(Consumer<CreateUserRequest.Builder> createUserRequest)Creates a user within the specified identity store.default CreateUserResponsecreateUser(CreateUserRequest createUserRequest)Creates a user within the specified identity store.default DeleteGroupResponsedeleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)Delete a group within an identity store givenGroupId.default DeleteGroupResponsedeleteGroup(DeleteGroupRequest deleteGroupRequest)Delete a group within an identity store givenGroupId.default DeleteGroupMembershipResponsedeleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)Delete a membership within a group givenMembershipId.default DeleteGroupMembershipResponsedeleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)Delete a membership within a group givenMembershipId.default DeleteUserResponsedeleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)Deletes a user within an identity store givenUserId.default DeleteUserResponsedeleteUser(DeleteUserRequest deleteUserRequest)Deletes a user within an identity store givenUserId.default DescribeGroupResponsedescribeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)Retrieves the group metadata and attributes fromGroupIdin an identity store.default DescribeGroupResponsedescribeGroup(DescribeGroupRequest describeGroupRequest)Retrieves the group metadata and attributes fromGroupIdin an identity store.default DescribeGroupMembershipResponsedescribeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)Retrieves membership metadata and attributes fromMembershipIdin an identity store.default DescribeGroupMembershipResponsedescribeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)Retrieves membership metadata and attributes fromMembershipIdin an identity store.default DescribeUserResponsedescribeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)Retrieves the user metadata and attributes from theUserIdin an identity store.default DescribeUserResponsedescribeUser(DescribeUserRequest describeUserRequest)Retrieves the user metadata and attributes from theUserIdin an identity store.default GetGroupIdResponsegetGroupId(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest)RetrievesGroupIdin an identity store.default GetGroupIdResponsegetGroupId(GetGroupIdRequest getGroupIdRequest)RetrievesGroupIdin an identity store.default GetGroupMembershipIdResponsegetGroupMembershipId(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest)Retrieves theMembershipIdin an identity store.default GetGroupMembershipIdResponsegetGroupMembershipId(GetGroupMembershipIdRequest getGroupMembershipIdRequest)Retrieves theMembershipIdin an identity store.default GetUserIdResponsegetUserId(Consumer<GetUserIdRequest.Builder> getUserIdRequest)Retrieves theUserIdin an identity store.default GetUserIdResponsegetUserId(GetUserIdRequest getUserIdRequest)Retrieves theUserIdin an identity store.default IsMemberInGroupsResponseisMemberInGroups(Consumer<IsMemberInGroupsRequest.Builder> isMemberInGroupsRequest)Checks the user's membership in all requested groups and returns if the member exists in all queried groups.default IsMemberInGroupsResponseisMemberInGroups(IsMemberInGroupsRequest isMemberInGroupsRequest)Checks the user's membership in all requested groups and returns if the member exists in all queried groups.default ListGroupMembershipsResponselistGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)For the specified group in the specified identity store, returns the list of allGroupMembershipobjects and returns results in paginated form.default ListGroupMembershipsResponselistGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)For the specified group in the specified identity store, returns the list of allGroupMembershipobjects and returns results in paginated form.default ListGroupMembershipsForMemberResponselistGroupMembershipsForMember(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)For the specified member in the specified identity store, returns the list of allGroupMembershipobjects and returns results in paginated form.default ListGroupMembershipsForMemberResponselistGroupMembershipsForMember(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)For the specified member in the specified identity store, returns the list of allGroupMembershipobjects and returns results in paginated form.default ListGroupMembershipsForMemberIterablelistGroupMembershipsForMemberPaginator(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)For the specified member in the specified identity store, returns the list of allGroupMembershipobjects and returns results in paginated form.default ListGroupMembershipsForMemberIterablelistGroupMembershipsForMemberPaginator(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)For the specified member in the specified identity store, returns the list of allGroupMembershipobjects and returns results in paginated form.default ListGroupMembershipsIterablelistGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)For the specified group in the specified identity store, returns the list of allGroupMembershipobjects and returns results in paginated form.default ListGroupMembershipsIterablelistGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest)For the specified group in the specified identity store, returns the list of allGroupMembershipobjects and returns results in paginated form.default ListGroupsResponselistGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)Lists all groups in the identity store.default ListGroupsResponselistGroups(ListGroupsRequest listGroupsRequest)Lists all groups in the identity store.default ListGroupsIterablelistGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)Lists all groups in the identity store.default ListGroupsIterablelistGroupsPaginator(ListGroupsRequest listGroupsRequest)Lists all groups in the identity store.default ListUsersResponselistUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)Lists all users in the identity store.default ListUsersResponselistUsers(ListUsersRequest listUsersRequest)Lists all users in the identity store.default ListUsersIterablelistUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)Lists all users in the identity store.default ListUsersIterablelistUsersPaginator(ListUsersRequest listUsersRequest)Lists all users in the identity store.default IdentitystoreServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default UpdateGroupResponseupdateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)For the specified group in the specified identity store, updates the group metadata and attributes.default UpdateGroupResponseupdateGroup(UpdateGroupRequest updateGroupRequest)For the specified group in the specified identity store, updates the group metadata and attributes.default UpdateUserResponseupdateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)For the specified user in the specified identity store, updates the user metadata and attributes.default UpdateUserResponseupdateUser(UpdateUserRequest updateUserRequest)For the specified user in the specified identity store, updates the user metadata and attributes.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createGroup
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
Creates a group within the specified identity store.
- Parameters:
createGroupRequest-- Returns:
- Result of the CreateGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createGroup
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
Creates a group within the specified identity store.
This is a convenience which creates an instance of the
CreateGroupRequest.Builderavoiding the need to create one manually viaCreateGroupRequest.builder()- Parameters:
createGroupRequest- AConsumerthat will call methods onCreateGroupRequest.Builderto create a request.- Returns:
- Result of the CreateGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createGroupMembership
default CreateGroupMembershipResponse createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
Creates a relationship between a member and a group. The following identifiers must be specified:
GroupId,IdentityStoreId, andMemberId.- Parameters:
createGroupMembershipRequest-- Returns:
- Result of the CreateGroupMembership operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createGroupMembership
default CreateGroupMembershipResponse createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
Creates a relationship between a member and a group. The following identifiers must be specified:
GroupId,IdentityStoreId, andMemberId.
This is a convenience which creates an instance of the
CreateGroupMembershipRequest.Builderavoiding the need to create one manually viaCreateGroupMembershipRequest.builder()- Parameters:
createGroupMembershipRequest- AConsumerthat will call methods onCreateGroupMembershipRequest.Builderto create a request.- Returns:
- Result of the CreateGroupMembership operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
Creates a user within the specified identity store.
- Parameters:
createUserRequest-- Returns:
- Result of the CreateUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
Creates a user within the specified identity store.
This is a convenience which creates an instance of the
CreateUserRequest.Builderavoiding the need to create one manually viaCreateUserRequest.builder()- Parameters:
createUserRequest- AConsumerthat will call methods onCreateUserRequest.Builderto create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Delete a group within an identity store given
GroupId.- Parameters:
deleteGroupRequest-- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Delete a group within an identity store given
GroupId.
This is a convenience which creates an instance of the
DeleteGroupRequest.Builderavoiding the need to create one manually viaDeleteGroupRequest.builder()- Parameters:
deleteGroupRequest- AConsumerthat will call methods onDeleteGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroupMembership
default DeleteGroupMembershipResponse deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Delete a membership within a group given
MembershipId.- Parameters:
deleteGroupMembershipRequest-- Returns:
- Result of the DeleteGroupMembership operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroupMembership
default DeleteGroupMembershipResponse deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Delete a membership within a group given
MembershipId.
This is a convenience which creates an instance of the
DeleteGroupMembershipRequest.Builderavoiding the need to create one manually viaDeleteGroupMembershipRequest.builder()- Parameters:
deleteGroupMembershipRequest- AConsumerthat will call methods onDeleteGroupMembershipRequest.Builderto create a request.- Returns:
- Result of the DeleteGroupMembership operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Deletes a user within an identity store given
UserId.- Parameters:
deleteUserRequest-- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Deletes a user within an identity store given
UserId.
This is a convenience which creates an instance of the
DeleteUserRequest.Builderavoiding the need to create one manually viaDeleteUserRequest.builder()- Parameters:
deleteUserRequest- AConsumerthat will call methods onDeleteUserRequest.Builderto create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroup
default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the group metadata and attributes from
GroupIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
describeGroupRequest-- Returns:
- Result of the DescribeGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroup
default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the group metadata and attributes from
GroupIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
DescribeGroupRequest.Builderavoiding the need to create one manually viaDescribeGroupRequest.builder()- Parameters:
describeGroupRequest- AConsumerthat will call methods onDescribeGroupRequest.Builderto create a request.- Returns:
- Result of the DescribeGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroupMembership
default DescribeGroupMembershipResponse describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves membership metadata and attributes from
MembershipIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
describeGroupMembershipRequest-- Returns:
- Result of the DescribeGroupMembership operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroupMembership
default DescribeGroupMembershipResponse describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves membership metadata and attributes from
MembershipIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
DescribeGroupMembershipRequest.Builderavoiding the need to create one manually viaDescribeGroupMembershipRequest.builder()- Parameters:
describeGroupMembershipRequest- AConsumerthat will call methods onDescribeGroupMembershipRequest.Builderto create a request.- Returns:
- Result of the DescribeGroupMembership operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUser
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the user metadata and attributes from the
UserIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
describeUserRequest-- Returns:
- Result of the DescribeUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUser
default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the user metadata and attributes from the
UserIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
DescribeUserRequest.Builderavoiding the need to create one manually viaDescribeUserRequest.builder()- Parameters:
describeUserRequest- AConsumerthat will call methods onDescribeUserRequest.Builderto create a request.- Returns:
- Result of the DescribeUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getGroupId
default GetGroupIdResponse getGroupId(GetGroupIdRequest getGroupIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves
GroupIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
getGroupIdRequest-- Returns:
- Result of the GetGroupId operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getGroupId
default GetGroupIdResponse getGroupId(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves
GroupIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
GetGroupIdRequest.Builderavoiding the need to create one manually viaGetGroupIdRequest.builder()- Parameters:
getGroupIdRequest- AConsumerthat will call methods onGetGroupIdRequest.Builderto create a request.- Returns:
- Result of the GetGroupId operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getGroupMembershipId
default GetGroupMembershipIdResponse getGroupMembershipId(GetGroupMembershipIdRequest getGroupMembershipIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the
MembershipIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
getGroupMembershipIdRequest-- Returns:
- Result of the GetGroupMembershipId operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getGroupMembershipId
default GetGroupMembershipIdResponse getGroupMembershipId(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the
MembershipIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
GetGroupMembershipIdRequest.Builderavoiding the need to create one manually viaGetGroupMembershipIdRequest.builder()- Parameters:
getGroupMembershipIdRequest- AConsumerthat will call methods onGetGroupMembershipIdRequest.Builderto create a request.- Returns:
- Result of the GetGroupMembershipId operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getUserId
default GetUserIdResponse getUserId(GetUserIdRequest getUserIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the
UserIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
getUserIdRequest-- Returns:
- Result of the GetUserId operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getUserId
default GetUserIdResponse getUserId(Consumer<GetUserIdRequest.Builder> getUserIdRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Retrieves the
UserIdin an identity store.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
GetUserIdRequest.Builderavoiding the need to create one manually viaGetUserIdRequest.builder()- Parameters:
getUserIdRequest- AConsumerthat will call methods onGetUserIdRequest.Builderto create a request.- Returns:
- Result of the GetUserId operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
isMemberInGroups
default IsMemberInGroupsResponse isMemberInGroups(IsMemberInGroupsRequest isMemberInGroupsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
isMemberInGroupsRequest-- Returns:
- Result of the IsMemberInGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
isMemberInGroups
default IsMemberInGroupsResponse isMemberInGroups(Consumer<IsMemberInGroupsRequest.Builder> isMemberInGroupsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
IsMemberInGroupsRequest.Builderavoiding the need to create one manually viaIsMemberInGroupsRequest.builder()- Parameters:
isMemberInGroupsRequest- AConsumerthat will call methods onIsMemberInGroupsRequest.Builderto create a request.- Returns:
- Result of the IsMemberInGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMemberships
default ListGroupMembershipsResponse listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
For the specified group in the specified identity store, returns the list of all
GroupMembershipobjects and returns results in paginated form.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
listGroupMembershipsRequest-- Returns:
- Result of the ListGroupMemberships operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMemberships
default ListGroupMembershipsResponse listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
For the specified group in the specified identity store, returns the list of all
GroupMembershipobjects and returns results in paginated form.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
ListGroupMembershipsRequest.Builderavoiding the need to create one manually viaListGroupMembershipsRequest.builder()- Parameters:
listGroupMembershipsRequest- AConsumerthat will call methods onListGroupMembershipsRequest.Builderto create a request.- Returns:
- Result of the ListGroupMemberships operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembershipsPaginator
default 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
GroupMembershipobjects and returns results in paginated form.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)operation. The return type is a custom 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
2) Using For loopsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client .listGroupMembershipsPaginator(request); for (software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)operation.- Parameters:
listGroupMembershipsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembershipsPaginator
default 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
GroupMembershipobjects and returns results in paginated form.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)operation. The return type is a custom 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
2) Using For loopsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client .listGroupMembershipsPaginator(request); for (software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest)operation.This is a convenience which creates an instance of the
ListGroupMembershipsRequest.Builderavoiding the need to create one manually viaListGroupMembershipsRequest.builder()- Parameters:
listGroupMembershipsRequest- AConsumerthat will call methods onListGroupMembershipsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembershipsForMember
default ListGroupMembershipsForMemberResponse listGroupMembershipsForMember(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
For the specified member in the specified identity store, returns the list of all
GroupMembershipobjects and returns results in paginated form.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
listGroupMembershipsForMemberRequest-- Returns:
- Result of the ListGroupMembershipsForMember operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembershipsForMember
default ListGroupMembershipsForMemberResponse listGroupMembershipsForMember(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
For the specified member in the specified identity store, returns the list of all
GroupMembershipobjects and returns results in paginated form.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
ListGroupMembershipsForMemberRequest.Builderavoiding the need to create one manually viaListGroupMembershipsForMemberRequest.builder()- Parameters:
listGroupMembershipsForMemberRequest- AConsumerthat will call methods onListGroupMembershipsForMemberRequest.Builderto create a request.- Returns:
- Result of the ListGroupMembershipsForMember operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembershipsForMemberPaginator
default 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
GroupMembershipobjects and returns results in paginated form.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)operation. The return type is a custom 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
2) Using For loopsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client .listGroupMembershipsForMemberPaginator(request); for (software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)operation.- Parameters:
listGroupMembershipsForMemberRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembershipsForMemberPaginator
default 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
GroupMembershipobjects and returns results in paginated form.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)operation. The return type is a custom 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
2) Using For loopsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client .listGroupMembershipsForMemberPaginator(request); for (software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberIterable responses = client.listGroupMembershipsForMemberPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest)operation.This is a convenience which creates an instance of the
ListGroupMembershipsForMemberRequest.Builderavoiding the need to create one manually viaListGroupMembershipsForMemberRequest.builder()- Parameters:
listGroupMembershipsForMemberRequest- AConsumerthat will call methods onListGroupMembershipsForMemberRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Lists all groups in the identity store. Returns a paginated list of complete
Groupobjects. Filtering for aGroupby theDisplayNameattribute is deprecated. Instead, use theGetGroupIdAPI action.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
listGroupsRequest-- Returns:
- Result of the ListGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Lists all groups in the identity store. Returns a paginated list of complete
Groupobjects. Filtering for aGroupby theDisplayNameattribute is deprecated. Instead, use theGetGroupIdAPI action.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- Result of the ListGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default 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
Groupobjects. Filtering for aGroupby theDisplayNameattribute is deprecated. Instead, use theGetGroupIdAPI action.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest)operation. The return type is a custom 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
2) Using For loopsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest)operation.- Parameters:
listGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default 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
Groupobjects. Filtering for aGroupby theDisplayNameattribute is deprecated. Instead, use theGetGroupIdAPI action.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest)operation. The return type is a custom 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
2) Using For loopsoftware.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest)operation.This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsers
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Lists all users in the identity store. Returns a paginated list of complete
Userobjects. Filtering for aUserby theUserNameattribute is deprecated. Instead, use theGetUserIdAPI action.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
- Parameters:
listUsersRequest-- Returns:
- Result of the ListUsers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsers
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IdentitystoreException
Lists all users in the identity store. Returns a paginated list of complete
Userobjects. Filtering for aUserby theUserNameattribute is deprecated. Instead, use theGetUserIdAPI action.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- Result of the ListUsers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersPaginator
default 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
Userobjects. Filtering for aUserby theUserNameattribute is deprecated. Instead, use theGetUserIdAPI action.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest)operation. The return type is a custom 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
2) Using For loopsoftware.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.identitystore.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest)operation.- Parameters:
listUsersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersPaginator
default 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
Userobjects. Filtering for aUserby theUserNameattribute is deprecated. Instead, use theGetUserIdAPI action.If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
This is a variant of
listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest)operation. The return type is a custom 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
2) Using For loopsoftware.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.identitystore.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest)operation.This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGroup
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
For the specified group in the specified identity store, updates the group metadata and attributes.
- Parameters:
updateGroupRequest-- Returns:
- Result of the UpdateGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGroup
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
For the specified group in the specified identity store, updates the group metadata and attributes.
This is a convenience which creates an instance of the
UpdateGroupRequest.Builderavoiding the need to create one manually viaUpdateGroupRequest.builder()- Parameters:
updateGroupRequest- AConsumerthat will call methods onUpdateGroupRequest.Builderto create a request.- Returns:
- Result of the UpdateGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
For the specified user in the specified identity store, updates the user metadata and attributes.
- Parameters:
updateUserRequest-- Returns:
- Result of the UpdateUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IdentitystoreException
For the specified user in the specified identity store, updates the user metadata and attributes.
This is a convenience which creates an instance of the
UpdateUserRequest.Builderavoiding the need to create one manually viaUpdateUserRequest.builder()- Parameters:
updateUserRequest- AConsumerthat will call methods onUpdateUserRequest.Builderto create a request.- Returns:
- Result of the UpdateUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static IdentitystoreClient create()
Create aIdentitystoreClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static IdentitystoreClientBuilder builder()
Create a builder that can be used to configure and create aIdentitystoreClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default IdentitystoreServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-