Interface DirectoryServiceDataClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.
Amazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information about Directory Service Data operations and object types.
With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from your
Managed Microsoft AD without additional costs and without deploying dedicated management instances. You can also
perform built-in object management tasks across directories without direct network connectivity, which simplifies
provisioning and access management to achieve fully automated deployments. Directory Service Data supports user and
group write operations, such as CreateUser and CreateGroup, within the organizational unit
(OU) of your Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers
and ListGroups, on all users, groups, and group memberships within your Managed Microsoft AD and across
trusted realms. Directory Service Data supports adding and removing group members in your OU and the Amazon Web
Services Delegated Groups OU, so you can grant and deny access to specific roles and permissions. For more
information, see Manage users
and groups in the Directory Service Administration Guide.
Directory management operations and configuration changes made against the Directory Service API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay between management changes, such as adding a new directory trust and calling the Directory Service Data API for the newly created trusted realm.
Directory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data uses an available domain controller. As a result, you might notice eventual consistency while objects replicate from one domain controller to another domain controller. For more information, see What gets created in the Directory Service Administration Guide. Directory limits vary by Managed Microsoft AD edition:
-
Standard edition – Supports 8 transactions per second (TPS) for read operations and 4 TPS for write operations per directory. There's a concurrency limit of 10 concurrent requests.
-
Enterprise edition – Supports 16 transactions per second (TPS) for read operations and 8 TPS for write operations per directory. There's a concurrency limit of 10 concurrent requests.
-
Amazon Web Services Account - Supports a total of 100 TPS for Directory Service Data operations across all directories.
Directory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary Amazon Web Services Region. For more information, see Managed Microsoft AD and Primary vs additional Regions in the Directory Service Administration Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault AddGroupMemberResponseaddGroupMember(Consumer<AddGroupMemberRequest.Builder> addGroupMemberRequest) Adds an existing user, group, or computer as a group member.default AddGroupMemberResponseaddGroupMember(AddGroupMemberRequest addGroupMemberRequest) Adds an existing user, group, or computer as a group member.builder()Create a builder that can be used to configure and create aDirectoryServiceDataClient.static DirectoryServiceDataClientcreate()Create aDirectoryServiceDataClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateGroupResponsecreateGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) Creates a new group.default CreateGroupResponsecreateGroup(CreateGroupRequest createGroupRequest) Creates a new group.default CreateUserResponsecreateUser(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a new user.default CreateUserResponsecreateUser(CreateUserRequest createUserRequest) Creates a new user.default DeleteGroupResponsedeleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Deletes a group.default DeleteGroupResponsedeleteGroup(DeleteGroupRequest deleteGroupRequest) Deletes a group.default DeleteUserResponsedeleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user.default DeleteUserResponsedeleteUser(DeleteUserRequest deleteUserRequest) Deletes a user.default DescribeGroupResponsedescribeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Returns information about a specific group.default DescribeGroupResponsedescribeGroup(DescribeGroupRequest describeGroupRequest) Returns information about a specific group.default DescribeUserResponsedescribeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Returns information about a specific user.default DescribeUserResponsedescribeUser(DescribeUserRequest describeUserRequest) Returns information about a specific user.default DisableUserResponsedisableUser(Consumer<DisableUserRequest.Builder> disableUserRequest) Deactivates an active user account.default DisableUserResponsedisableUser(DisableUserRequest disableUserRequest) Deactivates an active user account.default ListGroupMembersResponselistGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) Returns member information for the specified group.default ListGroupMembersResponselistGroupMembers(ListGroupMembersRequest listGroupMembersRequest) Returns member information for the specified group.default ListGroupMembersIterablelistGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) This is a variant oflistGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest)operation.default ListGroupMembersIterablelistGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest) This is a variant oflistGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest)operation.default ListGroupsResponselistGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Returns group information for the specified directory.default ListGroupsResponselistGroups(ListGroupsRequest listGroupsRequest) Returns group information for the specified directory.default ListGroupsForMemberResponselistGroupsForMember(Consumer<ListGroupsForMemberRequest.Builder> listGroupsForMemberRequest) Returns group information for the specified member.default ListGroupsForMemberResponselistGroupsForMember(ListGroupsForMemberRequest listGroupsForMemberRequest) Returns group information for the specified member.default ListGroupsForMemberIterablelistGroupsForMemberPaginator(Consumer<ListGroupsForMemberRequest.Builder> listGroupsForMemberRequest) This is a variant oflistGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest)operation.default ListGroupsForMemberIterablelistGroupsForMemberPaginator(ListGroupsForMemberRequest listGroupsForMemberRequest) This is a variant oflistGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest)operation.default ListGroupsIterablelistGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsRequest)operation.default ListGroupsIterablelistGroupsPaginator(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsRequest)operation.default ListUsersResponselistUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns user information for the specified directory.default ListUsersResponselistUsers(ListUsersRequest listUsersRequest) Returns user information for the specified directory.default ListUsersIterablelistUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.directoryservicedata.model.ListUsersRequest)operation.default ListUsersIterablelistUsersPaginator(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.directoryservicedata.model.ListUsersRequest)operation.default RemoveGroupMemberResponseremoveGroupMember(Consumer<RemoveGroupMemberRequest.Builder> removeGroupMemberRequest) Removes a member from a group.default RemoveGroupMemberResponseremoveGroupMember(RemoveGroupMemberRequest removeGroupMemberRequest) Removes a member from a group.default SearchGroupsResponsesearchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) Searches the specified directory for a group.default SearchGroupsResponsesearchGroups(SearchGroupsRequest searchGroupsRequest) Searches the specified directory for a group.default SearchGroupsIterablesearchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) This is a variant ofsearchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest)operation.default SearchGroupsIterablesearchGroupsPaginator(SearchGroupsRequest searchGroupsRequest) This is a variant ofsearchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest)operation.default SearchUsersResponsesearchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest) Searches the specified directory for a user.default SearchUsersResponsesearchUsers(SearchUsersRequest searchUsersRequest) Searches the specified directory for a user.default SearchUsersIterablesearchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest) This is a variant ofsearchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest)operation.default SearchUsersIterablesearchUsersPaginator(SearchUsersRequest searchUsersRequest) This is a variant ofsearchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault UpdateGroupResponseupdateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Updates group information.default UpdateGroupResponseupdateGroup(UpdateGroupRequest updateGroupRequest) Updates group information.default UpdateUserResponseupdateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates user information.default UpdateUserResponseupdateUser(UpdateUserRequest updateUserRequest) Updates user information.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
addGroupMember
default AddGroupMemberResponse addGroupMember(AddGroupMemberRequest addGroupMemberRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Adds an existing user, group, or computer as a group member.
- Parameters:
addGroupMemberRequest-- Returns:
- Result of the AddGroupMember operation returned by the service.
- See Also:
-
addGroupMember
default AddGroupMemberResponse addGroupMember(Consumer<AddGroupMemberRequest.Builder> addGroupMemberRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Adds an existing user, group, or computer as a group member.
This is a convenience which creates an instance of the
AddGroupMemberRequest.Builderavoiding the need to create one manually viaAddGroupMemberRequest.builder()- Parameters:
addGroupMemberRequest- AConsumerthat will call methods onAddGroupMemberRequest.Builderto create a request.- Returns:
- Result of the AddGroupMember operation returned by the service.
- See Also:
-
createGroup
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Creates a new group.
- Parameters:
createGroupRequest-- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
createGroup
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Creates a new group.
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.
- See Also:
-
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Creates a new user.
- Parameters:
createUserRequest-- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Creates a new user.
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.
- See Also:
-
deleteGroup
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Deletes a group.
- Parameters:
deleteGroupRequest-- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
deleteGroup
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Deletes a group.
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.
- See Also:
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Deletes a user.
- Parameters:
deleteUserRequest-- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Deletes a user.
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.
- See Also:
-
describeGroup
default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns information about a specific group.
- Parameters:
describeGroupRequest-- Returns:
- Result of the DescribeGroup operation returned by the service.
- See Also:
-
describeGroup
default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns information about a specific group.
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.
- See Also:
-
describeUser
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns information about a specific user.
- Parameters:
describeUserRequest-- Returns:
- Result of the DescribeUser operation returned by the service.
- See Also:
-
describeUser
default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns information about a specific user.
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.
- See Also:
-
disableUser
default DisableUserResponse disableUser(DisableUserRequest disableUserRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Deactivates an active user account. For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference.
- Parameters:
disableUserRequest-- Returns:
- Result of the DisableUser operation returned by the service.
- See Also:
-
disableUser
default DisableUserResponse disableUser(Consumer<DisableUserRequest.Builder> disableUserRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Deactivates an active user account. For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference.
This is a convenience which creates an instance of the
DisableUserRequest.Builderavoiding the need to create one manually viaDisableUserRequest.builder()- Parameters:
disableUserRequest- AConsumerthat will call methods onDisableUserRequest.Builderto create a request.- Returns:
- Result of the DisableUser operation returned by the service.
- See Also:
-
listGroupMembers
default ListGroupMembersResponse listGroupMembers(ListGroupMembersRequest listGroupMembersRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns member information for the specified group.
This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theListGroupMembers.NextTokenmember contains a token that you pass in the next call toListGroupMembers. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.- Parameters:
listGroupMembersRequest-- Returns:
- Result of the ListGroupMembers operation returned by the service.
- See Also:
-
listGroupMembers
default ListGroupMembersResponse listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns member information for the specified group.
This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theListGroupMembers.NextTokenmember contains a token that you pass in the next call toListGroupMembers. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.
This is a convenience which creates an instance of the
ListGroupMembersRequest.Builderavoiding the need to create one manually viaListGroupMembersRequest.builder()- Parameters:
listGroupMembersRequest- AConsumerthat will call methods onListGroupMembersRequest.Builderto create a request.- Returns:
- Result of the ListGroupMembers operation returned by the service.
- See Also:
-
listGroupMembersPaginator
default ListGroupMembersIterable listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
listGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest)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.directoryservicedata.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupMembersIterable responses = client .listGroupMembersPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(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
listGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest)operation.- Parameters:
listGroupMembersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupMembersPaginator
default ListGroupMembersIterable listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
listGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest)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.directoryservicedata.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupMembersIterable responses = client .listGroupMembersPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(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
listGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest)operation.
This is a convenience which creates an instance of the
ListGroupMembersRequest.Builderavoiding the need to create one manually viaListGroupMembersRequest.builder()- Parameters:
listGroupMembersRequest- AConsumerthat will call methods onListGroupMembersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroups
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns group information for the specified directory.
This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theListGroups.NextTokenmember contains a token that you pass in the next call toListGroups. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.- Parameters:
listGroupsRequest-- Returns:
- Result of the ListGroups operation returned by the service.
- See Also:
-
listGroups
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns group information for the specified directory.
This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theListGroups.NextTokenmember contains a token that you pass in the next call toListGroups. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.
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.
- See Also:
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
listGroups(software.amazon.awssdk.services.directoryservicedata.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.directoryservicedata.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsIterable responses = client .listGroupsPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.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.directoryservicedata.model.ListGroupsRequest)operation.- Parameters:
listGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
listGroups(software.amazon.awssdk.services.directoryservicedata.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.directoryservicedata.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsIterable responses = client .listGroupsPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.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.directoryservicedata.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.
- See Also:
-
listGroupsForMember
default ListGroupsForMemberResponse listGroupsForMember(ListGroupsForMemberRequest listGroupsForMemberRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns group information for the specified member.
This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theListGroupsForMember.NextTokenmember contains a token that you pass in the next call toListGroupsForMember. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.- Parameters:
listGroupsForMemberRequest-- Returns:
- Result of the ListGroupsForMember operation returned by the service.
- See Also:
-
listGroupsForMember
default ListGroupsForMemberResponse listGroupsForMember(Consumer<ListGroupsForMemberRequest.Builder> listGroupsForMemberRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns group information for the specified member.
This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theListGroupsForMember.NextTokenmember contains a token that you pass in the next call toListGroupsForMember. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.
This is a convenience which creates an instance of the
ListGroupsForMemberRequest.Builderavoiding the need to create one manually viaListGroupsForMemberRequest.builder()- Parameters:
listGroupsForMemberRequest- AConsumerthat will call methods onListGroupsForMemberRequest.Builderto create a request.- Returns:
- Result of the ListGroupsForMember operation returned by the service.
- See Also:
-
listGroupsForMemberPaginator
default ListGroupsForMemberIterable listGroupsForMemberPaginator(ListGroupsForMemberRequest listGroupsForMemberRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
listGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest)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.directoryservicedata.paginators.ListGroupsForMemberIterable responses = client.listGroupsForMemberPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsForMemberIterable responses = client .listGroupsForMemberPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsForMemberIterable responses = client.listGroupsForMemberPaginator(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
listGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest)operation.- Parameters:
listGroupsForMemberRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupsForMemberPaginator
default ListGroupsForMemberIterable listGroupsForMemberPaginator(Consumer<ListGroupsForMemberRequest.Builder> listGroupsForMemberRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
listGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest)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.directoryservicedata.paginators.ListGroupsForMemberIterable responses = client.listGroupsForMemberPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsForMemberIterable responses = client .listGroupsForMemberPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsForMemberIterable responses = client.listGroupsForMemberPaginator(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
listGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest)operation.
This is a convenience which creates an instance of the
ListGroupsForMemberRequest.Builderavoiding the need to create one manually viaListGroupsForMemberRequest.builder()- Parameters:
listGroupsForMemberRequest- AConsumerthat will call methods onListGroupsForMemberRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUsers
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns user information for the specified directory.
This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theListUsers.NextTokenmember contains a token that you pass in the next call toListUsers. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.- Parameters:
listUsersRequest-- Returns:
- Result of the ListUsers operation returned by the service.
- See Also:
-
listUsers
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Returns user information for the specified directory.
This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theListUsers.NextTokenmember contains a token that you pass in the next call toListUsers. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.
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.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
listUsers(software.amazon.awssdk.services.directoryservicedata.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.directoryservicedata.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.ListUsersIterable responses = client .listUsersPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.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.directoryservicedata.model.ListUsersRequest)operation.- Parameters:
listUsersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
listUsers(software.amazon.awssdk.services.directoryservicedata.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.directoryservicedata.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.ListUsersIterable responses = client .listUsersPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.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.directoryservicedata.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.
- See Also:
-
removeGroupMember
default RemoveGroupMemberResponse removeGroupMember(RemoveGroupMemberRequest removeGroupMemberRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Removes a member from a group.
- Parameters:
removeGroupMemberRequest-- Returns:
- Result of the RemoveGroupMember operation returned by the service.
- See Also:
-
removeGroupMember
default RemoveGroupMemberResponse removeGroupMember(Consumer<RemoveGroupMemberRequest.Builder> removeGroupMemberRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Removes a member from a group.
This is a convenience which creates an instance of the
RemoveGroupMemberRequest.Builderavoiding the need to create one manually viaRemoveGroupMemberRequest.builder()- Parameters:
removeGroupMemberRequest- AConsumerthat will call methods onRemoveGroupMemberRequest.Builderto create a request.- Returns:
- Result of the RemoveGroupMember operation returned by the service.
- See Also:
-
searchGroups
default SearchGroupsResponse searchGroups(SearchGroupsRequest searchGroupsRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Searches the specified directory for a group. You can find groups that match the
SearchStringparameter with the value of their attributes included in theSearchStringparameter.This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theSearchGroups.NextTokenmember contains a token that you pass in the next call toSearchGroups. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.- Parameters:
searchGroupsRequest-- Returns:
- Result of the SearchGroups operation returned by the service.
- See Also:
-
searchGroups
default SearchGroupsResponse searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Searches the specified directory for a group. You can find groups that match the
SearchStringparameter with the value of their attributes included in theSearchStringparameter.This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theSearchGroups.NextTokenmember contains a token that you pass in the next call toSearchGroups. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.
This is a convenience which creates an instance of the
SearchGroupsRequest.Builderavoiding the need to create one manually viaSearchGroupsRequest.builder()- Parameters:
searchGroupsRequest- AConsumerthat will call methods onSearchGroupsRequest.Builderto create a request.- Returns:
- Result of the SearchGroups operation returned by the service.
- See Also:
-
searchGroupsPaginator
default SearchGroupsIterable searchGroupsPaginator(SearchGroupsRequest searchGroupsRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
searchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest)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.directoryservicedata.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.SearchGroupsIterable responses = client .searchGroupsPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(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
searchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest)operation.- Parameters:
searchGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchGroupsPaginator
default SearchGroupsIterable searchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
searchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest)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.directoryservicedata.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.SearchGroupsIterable responses = client .searchGroupsPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(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
searchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest)operation.
This is a convenience which creates an instance of the
SearchGroupsRequest.Builderavoiding the need to create one manually viaSearchGroupsRequest.builder()- Parameters:
searchGroupsRequest- AConsumerthat will call methods onSearchGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchUsers
default SearchUsersResponse searchUsers(SearchUsersRequest searchUsersRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Searches the specified directory for a user. You can find users that match the
SearchStringparameter with the value of their attributes included in theSearchStringparameter.This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theSearchUsers.NextTokenmember contains a token that you pass in the next call toSearchUsers. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.- Parameters:
searchUsersRequest-- Returns:
- Result of the SearchUsers operation returned by the service.
- See Also:
-
searchUsers
default SearchUsersResponse searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Searches the specified directory for a user. You can find users that match the
SearchStringparameter with the value of their attributes included in theSearchStringparameter.This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theSearchUsers.NextTokenmember contains a token that you pass in the next call toSearchUsers. This retrieves the next set of items.You can also specify a maximum number of return results with the
MaxResultsparameter.
This is a convenience which creates an instance of the
SearchUsersRequest.Builderavoiding the need to create one manually viaSearchUsersRequest.builder()- Parameters:
searchUsersRequest- AConsumerthat will call methods onSearchUsersRequest.Builderto create a request.- Returns:
- Result of the SearchUsers operation returned by the service.
- See Also:
-
searchUsersPaginator
default SearchUsersIterable searchUsersPaginator(SearchUsersRequest searchUsersRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
searchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest)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.directoryservicedata.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.SearchUsersIterable responses = client .searchUsersPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.SearchUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.paginators.SearchUsersIterable responses = client.searchUsersPaginator(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
searchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest)operation.- Parameters:
searchUsersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchUsersPaginator
default SearchUsersIterable searchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest) throws AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException This is a variant of
searchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest)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.directoryservicedata.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directoryservicedata.paginators.SearchUsersIterable responses = client .searchUsersPaginator(request); for (software.amazon.awssdk.services.directoryservicedata.model.SearchUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directoryservicedata.paginators.SearchUsersIterable responses = client.searchUsersPaginator(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
searchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest)operation.
This is a convenience which creates an instance of the
SearchUsersRequest.Builderavoiding the need to create one manually viaSearchUsersRequest.builder()- Parameters:
searchUsersRequest- AConsumerthat will call methods onSearchUsersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
updateGroup
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Updates group information.
- Parameters:
updateGroupRequest-- Returns:
- Result of the UpdateGroup operation returned by the service.
- See Also:
-
updateGroup
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Updates group information.
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.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Updates user information.
- Parameters:
updateUserRequest-- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, ValidationException, DirectoryUnavailableException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, DirectoryServiceDataException Updates user information.
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.
- See Also:
-
create
Create aDirectoryServiceDataClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aDirectoryServiceDataClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-