Interface WorkDocsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
The Amazon WorkDocs API is designed for the following use cases:
-
File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.
-
Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.
-
eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.
All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.
The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:
-
READ (Get*)
-
WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)
-
LIST (Describe*)
-
DELETE*, CANCEL
For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionabortDocumentVersionUpload
(Consumer<AbortDocumentVersionUploadRequest.Builder> abortDocumentVersionUploadRequest) Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload.abortDocumentVersionUpload
(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest) Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload.default ActivateUserResponse
activateUser
(Consumer<ActivateUserRequest.Builder> activateUserRequest) Activates the specified user.default ActivateUserResponse
activateUser
(ActivateUserRequest activateUserRequest) Activates the specified user.default AddResourcePermissionsResponse
addResourcePermissions
(Consumer<AddResourcePermissionsRequest.Builder> addResourcePermissionsRequest) Creates a set of permissions for the specified folder or document.default AddResourcePermissionsResponse
addResourcePermissions
(AddResourcePermissionsRequest addResourcePermissionsRequest) Creates a set of permissions for the specified folder or document.static WorkDocsClientBuilder
builder()
Create a builder that can be used to configure and create aWorkDocsClient
.static WorkDocsClient
create()
Create aWorkDocsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateCommentResponse
createComment
(Consumer<CreateCommentRequest.Builder> createCommentRequest) Adds a new comment to the specified document version.default CreateCommentResponse
createComment
(CreateCommentRequest createCommentRequest) Adds a new comment to the specified document version.default CreateCustomMetadataResponse
createCustomMetadata
(Consumer<CreateCustomMetadataRequest.Builder> createCustomMetadataRequest) Adds one or more custom properties to the specified resource (a folder, document, or version).default CreateCustomMetadataResponse
createCustomMetadata
(CreateCustomMetadataRequest createCustomMetadataRequest) Adds one or more custom properties to the specified resource (a folder, document, or version).default CreateFolderResponse
createFolder
(Consumer<CreateFolderRequest.Builder> createFolderRequest) Creates a folder with the specified name and parent folder.default CreateFolderResponse
createFolder
(CreateFolderRequest createFolderRequest) Creates a folder with the specified name and parent folder.default CreateLabelsResponse
createLabels
(Consumer<CreateLabelsRequest.Builder> createLabelsRequest) Adds the specified list of labels to the given resource (a document or folder)default CreateLabelsResponse
createLabels
(CreateLabelsRequest createLabelsRequest) Adds the specified list of labels to the given resource (a document or folder)createNotificationSubscription
(Consumer<CreateNotificationSubscriptionRequest.Builder> createNotificationSubscriptionRequest) Configure Amazon WorkDocs to use Amazon SNS notifications.createNotificationSubscription
(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest) Configure Amazon WorkDocs to use Amazon SNS notifications.default CreateUserResponse
createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a user in a Simple AD or Microsoft AD directory.default CreateUserResponse
createUser
(CreateUserRequest createUserRequest) Creates a user in a Simple AD or Microsoft AD directory.default DeactivateUserResponse
deactivateUser
(Consumer<DeactivateUserRequest.Builder> deactivateUserRequest) Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.default DeactivateUserResponse
deactivateUser
(DeactivateUserRequest deactivateUserRequest) Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.default DeleteCommentResponse
deleteComment
(Consumer<DeleteCommentRequest.Builder> deleteCommentRequest) Deletes the specified comment from the document version.default DeleteCommentResponse
deleteComment
(DeleteCommentRequest deleteCommentRequest) Deletes the specified comment from the document version.default DeleteCustomMetadataResponse
deleteCustomMetadata
(Consumer<DeleteCustomMetadataRequest.Builder> deleteCustomMetadataRequest) Deletes custom metadata from the specified resource.default DeleteCustomMetadataResponse
deleteCustomMetadata
(DeleteCustomMetadataRequest deleteCustomMetadataRequest) Deletes custom metadata from the specified resource.default DeleteDocumentResponse
deleteDocument
(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest) Permanently deletes the specified document and its associated metadata.default DeleteDocumentResponse
deleteDocument
(DeleteDocumentRequest deleteDocumentRequest) Permanently deletes the specified document and its associated metadata.default DeleteDocumentVersionResponse
deleteDocumentVersion
(Consumer<DeleteDocumentVersionRequest.Builder> deleteDocumentVersionRequest) Deletes a specific version of a document.default DeleteDocumentVersionResponse
deleteDocumentVersion
(DeleteDocumentVersionRequest deleteDocumentVersionRequest) Deletes a specific version of a document.default DeleteFolderResponse
deleteFolder
(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest) Permanently deletes the specified folder and its contents.default DeleteFolderResponse
deleteFolder
(DeleteFolderRequest deleteFolderRequest) Permanently deletes the specified folder and its contents.default DeleteFolderContentsResponse
deleteFolderContents
(Consumer<DeleteFolderContentsRequest.Builder> deleteFolderContentsRequest) Deletes the contents of the specified folder.default DeleteFolderContentsResponse
deleteFolderContents
(DeleteFolderContentsRequest deleteFolderContentsRequest) Deletes the contents of the specified folder.default DeleteLabelsResponse
deleteLabels
(Consumer<DeleteLabelsRequest.Builder> deleteLabelsRequest) Deletes the specified list of labels from a resource.default DeleteLabelsResponse
deleteLabels
(DeleteLabelsRequest deleteLabelsRequest) Deletes the specified list of labels from a resource.deleteNotificationSubscription
(Consumer<DeleteNotificationSubscriptionRequest.Builder> deleteNotificationSubscriptionRequest) Deletes the specified subscription from the specified organization.deleteNotificationSubscription
(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest) Deletes the specified subscription from the specified organization.default DeleteUserResponse
deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes the specified user from a Simple AD or Microsoft AD directory.default DeleteUserResponse
deleteUser
(DeleteUserRequest deleteUserRequest) Deletes the specified user from a Simple AD or Microsoft AD directory.default DescribeActivitiesResponse
describeActivities
(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest) Describes the user activities in a specified time period.default DescribeActivitiesResponse
describeActivities
(DescribeActivitiesRequest describeActivitiesRequest) Describes the user activities in a specified time period.default DescribeActivitiesIterable
describeActivitiesPaginator
(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest) This is a variant ofdescribeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest)
operation.default DescribeActivitiesIterable
describeActivitiesPaginator
(DescribeActivitiesRequest describeActivitiesRequest) This is a variant ofdescribeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest)
operation.default DescribeCommentsResponse
describeComments
(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest) List all the comments for the specified document version.default DescribeCommentsResponse
describeComments
(DescribeCommentsRequest describeCommentsRequest) List all the comments for the specified document version.default DescribeCommentsIterable
describeCommentsPaginator
(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest) This is a variant ofdescribeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest)
operation.default DescribeCommentsIterable
describeCommentsPaginator
(DescribeCommentsRequest describeCommentsRequest) This is a variant ofdescribeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest)
operation.default DescribeDocumentVersionsResponse
describeDocumentVersions
(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest) Retrieves the document versions for the specified document.default DescribeDocumentVersionsResponse
describeDocumentVersions
(DescribeDocumentVersionsRequest describeDocumentVersionsRequest) Retrieves the document versions for the specified document.default DescribeDocumentVersionsIterable
describeDocumentVersionsPaginator
(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest) This is a variant ofdescribeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation.default DescribeDocumentVersionsIterable
describeDocumentVersionsPaginator
(DescribeDocumentVersionsRequest describeDocumentVersionsRequest) This is a variant ofdescribeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation.default DescribeFolderContentsResponse
describeFolderContents
(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest) Describes the contents of the specified folder, including its documents and subfolders.default DescribeFolderContentsResponse
describeFolderContents
(DescribeFolderContentsRequest describeFolderContentsRequest) Describes the contents of the specified folder, including its documents and subfolders.default DescribeFolderContentsIterable
describeFolderContentsPaginator
(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest) This is a variant ofdescribeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation.default DescribeFolderContentsIterable
describeFolderContentsPaginator
(DescribeFolderContentsRequest describeFolderContentsRequest) This is a variant ofdescribeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation.default DescribeGroupsResponse
describeGroups
(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest) Describes the groups specified by the query.default DescribeGroupsResponse
describeGroups
(DescribeGroupsRequest describeGroupsRequest) Describes the groups specified by the query.default DescribeGroupsIterable
describeGroupsPaginator
(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest) This is a variant ofdescribeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest)
operation.default DescribeGroupsIterable
describeGroupsPaginator
(DescribeGroupsRequest describeGroupsRequest) This is a variant ofdescribeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest)
operation.describeNotificationSubscriptions
(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest) Lists the specified notification subscriptions.describeNotificationSubscriptions
(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest) Lists the specified notification subscriptions.describeNotificationSubscriptionsPaginator
(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest) This is a variant ofdescribeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest)
operation.describeNotificationSubscriptionsPaginator
(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest) This is a variant ofdescribeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest)
operation.describeResourcePermissions
(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest) Describes the permissions of a specified resource.describeResourcePermissions
(DescribeResourcePermissionsRequest describeResourcePermissionsRequest) Describes the permissions of a specified resource.describeResourcePermissionsPaginator
(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest) This is a variant ofdescribeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest)
operation.describeResourcePermissionsPaginator
(DescribeResourcePermissionsRequest describeResourcePermissionsRequest) This is a variant ofdescribeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest)
operation.default DescribeRootFoldersResponse
describeRootFolders
(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest) Describes the current user's special folders; theRootFolder
and theRecycleBin
.default DescribeRootFoldersResponse
describeRootFolders
(DescribeRootFoldersRequest describeRootFoldersRequest) Describes the current user's special folders; theRootFolder
and theRecycleBin
.default DescribeRootFoldersIterable
describeRootFoldersPaginator
(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest) This is a variant ofdescribeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest)
operation.default DescribeRootFoldersIterable
describeRootFoldersPaginator
(DescribeRootFoldersRequest describeRootFoldersRequest) This is a variant ofdescribeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest)
operation.default DescribeUsersResponse
describeUsers
(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) Describes the specified users.default DescribeUsersResponse
describeUsers
(DescribeUsersRequest describeUsersRequest) Describes the specified users.default DescribeUsersIterable
describeUsersPaginator
(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) This is a variant ofdescribeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation.default DescribeUsersIterable
describeUsersPaginator
(DescribeUsersRequest describeUsersRequest) This is a variant ofdescribeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation.default GetCurrentUserResponse
getCurrentUser
(Consumer<GetCurrentUserRequest.Builder> getCurrentUserRequest) Retrieves details of the current user for whom the authentication token was generated.default GetCurrentUserResponse
getCurrentUser
(GetCurrentUserRequest getCurrentUserRequest) Retrieves details of the current user for whom the authentication token was generated.default GetDocumentResponse
getDocument
(Consumer<GetDocumentRequest.Builder> getDocumentRequest) Retrieves details of a document.default GetDocumentResponse
getDocument
(GetDocumentRequest getDocumentRequest) Retrieves details of a document.default GetDocumentPathResponse
getDocumentPath
(Consumer<GetDocumentPathRequest.Builder> getDocumentPathRequest) Retrieves the path information (the hierarchy from the root folder) for the requested document.default GetDocumentPathResponse
getDocumentPath
(GetDocumentPathRequest getDocumentPathRequest) Retrieves the path information (the hierarchy from the root folder) for the requested document.default GetDocumentVersionResponse
getDocumentVersion
(Consumer<GetDocumentVersionRequest.Builder> getDocumentVersionRequest) Retrieves version metadata for the specified document.default GetDocumentVersionResponse
getDocumentVersion
(GetDocumentVersionRequest getDocumentVersionRequest) Retrieves version metadata for the specified document.default GetFolderResponse
getFolder
(Consumer<GetFolderRequest.Builder> getFolderRequest) Retrieves the metadata of the specified folder.default GetFolderResponse
getFolder
(GetFolderRequest getFolderRequest) Retrieves the metadata of the specified folder.default GetFolderPathResponse
getFolderPath
(Consumer<GetFolderPathRequest.Builder> getFolderPathRequest) Retrieves the path information (the hierarchy from the root folder) for the specified folder.default GetFolderPathResponse
getFolderPath
(GetFolderPathRequest getFolderPathRequest) Retrieves the path information (the hierarchy from the root folder) for the specified folder.default GetResourcesResponse
getResources
(Consumer<GetResourcesRequest.Builder> getResourcesRequest) Retrieves a collection of resources, including folders and documents.default GetResourcesResponse
getResources
(GetResourcesRequest getResourcesRequest) Retrieves a collection of resources, including folders and documents.initiateDocumentVersionUpload
(Consumer<InitiateDocumentVersionUploadRequest.Builder> initiateDocumentVersionUploadRequest) Creates a new document object and version object.initiateDocumentVersionUpload
(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest) Creates a new document object and version object.removeAllResourcePermissions
(Consumer<RemoveAllResourcePermissionsRequest.Builder> removeAllResourcePermissionsRequest) Removes all the permissions from the specified resource.removeAllResourcePermissions
(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest) Removes all the permissions from the specified resource.default RemoveResourcePermissionResponse
removeResourcePermission
(Consumer<RemoveResourcePermissionRequest.Builder> removeResourcePermissionRequest) Removes the permission for the specified principal from the specified resource.default RemoveResourcePermissionResponse
removeResourcePermission
(RemoveResourcePermissionRequest removeResourcePermissionRequest) Removes the permission for the specified principal from the specified resource.default RestoreDocumentVersionsResponse
restoreDocumentVersions
(Consumer<RestoreDocumentVersionsRequest.Builder> restoreDocumentVersionsRequest) Recovers a deleted version of an Amazon WorkDocs document.default RestoreDocumentVersionsResponse
restoreDocumentVersions
(RestoreDocumentVersionsRequest restoreDocumentVersionsRequest) Recovers a deleted version of an Amazon WorkDocs document.default SearchResourcesResponse
searchResources
(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest) Searches metadata and the content of folders, documents, document versions, and comments.default SearchResourcesResponse
searchResources
(SearchResourcesRequest searchResourcesRequest) Searches metadata and the content of folders, documents, document versions, and comments.default SearchResourcesIterable
searchResourcesPaginator
(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest) This is a variant ofsearchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest)
operation.default SearchResourcesIterable
searchResourcesPaginator
(SearchResourcesRequest searchResourcesRequest) This is a variant ofsearchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default UpdateDocumentResponse
updateDocument
(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest) Updates the specified attributes of a document.default UpdateDocumentResponse
updateDocument
(UpdateDocumentRequest updateDocumentRequest) Updates the specified attributes of a document.default UpdateDocumentVersionResponse
updateDocumentVersion
(Consumer<UpdateDocumentVersionRequest.Builder> updateDocumentVersionRequest) Changes the status of the document version to ACTIVE.default UpdateDocumentVersionResponse
updateDocumentVersion
(UpdateDocumentVersionRequest updateDocumentVersionRequest) Changes the status of the document version to ACTIVE.default UpdateFolderResponse
updateFolder
(Consumer<UpdateFolderRequest.Builder> updateFolderRequest) Updates the specified attributes of the specified folder.default UpdateFolderResponse
updateFolder
(UpdateFolderRequest updateFolderRequest) Updates the specified attributes of the specified folder.default UpdateUserResponse
updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.default UpdateUserResponse
updateUser
(UpdateUserRequest updateUserRequest) Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
abortDocumentVersionUpload
default AbortDocumentVersionUploadResponse abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ConcurrentModificationException, AwsServiceException, SdkClientException, WorkDocsException Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.
- Parameters:
abortDocumentVersionUploadRequest
-- Returns:
- Result of the AbortDocumentVersionUpload operation returned by the service.
- See Also:
-
abortDocumentVersionUpload
default AbortDocumentVersionUploadResponse abortDocumentVersionUpload(Consumer<AbortDocumentVersionUploadRequest.Builder> abortDocumentVersionUploadRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ConcurrentModificationException, AwsServiceException, SdkClientException, WorkDocsException Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.
This is a convenience which creates an instance of the
AbortDocumentVersionUploadRequest.Builder
avoiding the need to create one manually viaAbortDocumentVersionUploadRequest.builder()
- Parameters:
abortDocumentVersionUploadRequest
- AConsumer
that will call methods onAbortDocumentVersionUploadRequest.Builder
to create a request.- Returns:
- Result of the AbortDocumentVersionUpload operation returned by the service.
- See Also:
-
activateUser
default ActivateUserResponse activateUser(ActivateUserRequest activateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Activates the specified user. Only active users can access Amazon WorkDocs.
- Parameters:
activateUserRequest
-- Returns:
- Result of the ActivateUser operation returned by the service.
- See Also:
-
activateUser
default ActivateUserResponse activateUser(Consumer<ActivateUserRequest.Builder> activateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Activates the specified user. Only active users can access Amazon WorkDocs.
This is a convenience which creates an instance of the
ActivateUserRequest.Builder
avoiding the need to create one manually viaActivateUserRequest.builder()
- Parameters:
activateUserRequest
- AConsumer
that will call methods onActivateUserRequest.Builder
to create a request.- Returns:
- Result of the ActivateUser operation returned by the service.
- See Also:
-
addResourcePermissions
default AddResourcePermissionsResponse addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
- Parameters:
addResourcePermissionsRequest
-- Returns:
- Result of the AddResourcePermissions operation returned by the service.
- See Also:
-
addResourcePermissions
default AddResourcePermissionsResponse addResourcePermissions(Consumer<AddResourcePermissionsRequest.Builder> addResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
This is a convenience which creates an instance of the
AddResourcePermissionsRequest.Builder
avoiding the need to create one manually viaAddResourcePermissionsRequest.builder()
- Parameters:
addResourcePermissionsRequest
- AConsumer
that will call methods onAddResourcePermissionsRequest.Builder
to create a request.- Returns:
- Result of the AddResourcePermissions operation returned by the service.
- See Also:
-
createComment
default CreateCommentResponse createComment(CreateCommentRequest createCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, InvalidCommentOperationException, AwsServiceException, SdkClientException, WorkDocsException Adds a new comment to the specified document version.
- Parameters:
createCommentRequest
-- Returns:
- Result of the CreateComment operation returned by the service.
- See Also:
-
createComment
default CreateCommentResponse createComment(Consumer<CreateCommentRequest.Builder> createCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, InvalidCommentOperationException, AwsServiceException, SdkClientException, WorkDocsException Adds a new comment to the specified document version.
This is a convenience which creates an instance of the
CreateCommentRequest.Builder
avoiding the need to create one manually viaCreateCommentRequest.builder()
- Parameters:
createCommentRequest
- AConsumer
that will call methods onCreateCommentRequest.Builder
to create a request.- Returns:
- Result of the CreateComment operation returned by the service.
- See Also:
-
createCustomMetadata
default CreateCustomMetadataResponse createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, CustomMetadataLimitExceededException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Adds one or more custom properties to the specified resource (a folder, document, or version).
- Parameters:
createCustomMetadataRequest
-- Returns:
- Result of the CreateCustomMetadata operation returned by the service.
- See Also:
-
createCustomMetadata
default CreateCustomMetadataResponse createCustomMetadata(Consumer<CreateCustomMetadataRequest.Builder> createCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, CustomMetadataLimitExceededException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Adds one or more custom properties to the specified resource (a folder, document, or version).
This is a convenience which creates an instance of the
CreateCustomMetadataRequest.Builder
avoiding the need to create one manually viaCreateCustomMetadataRequest.builder()
- Parameters:
createCustomMetadataRequest
- AConsumer
that will call methods onCreateCustomMetadataRequest.Builder
to create a request.- Returns:
- Result of the CreateCustomMetadata operation returned by the service.
- See Also:
-
createFolder
default CreateFolderResponse createFolder(CreateFolderRequest createFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Creates a folder with the specified name and parent folder.
- Parameters:
createFolderRequest
-- Returns:
- Result of the CreateFolder operation returned by the service.
- See Also:
-
createFolder
default CreateFolderResponse createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Creates a folder with the specified name and parent folder.
This is a convenience which creates an instance of the
CreateFolderRequest.Builder
avoiding the need to create one manually viaCreateFolderRequest.builder()
- Parameters:
createFolderRequest
- AConsumer
that will call methods onCreateFolderRequest.Builder
to create a request.- Returns:
- Result of the CreateFolder operation returned by the service.
- See Also:
-
createLabels
default CreateLabelsResponse createLabels(CreateLabelsRequest createLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, TooManyLabelsException, AwsServiceException, SdkClientException, WorkDocsException Adds the specified list of labels to the given resource (a document or folder)
- Parameters:
createLabelsRequest
-- Returns:
- Result of the CreateLabels operation returned by the service.
- See Also:
-
createLabels
default CreateLabelsResponse createLabels(Consumer<CreateLabelsRequest.Builder> createLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, TooManyLabelsException, AwsServiceException, SdkClientException, WorkDocsException Adds the specified list of labels to the given resource (a document or folder)
This is a convenience which creates an instance of the
CreateLabelsRequest.Builder
avoiding the need to create one manually viaCreateLabelsRequest.builder()
- Parameters:
createLabelsRequest
- AConsumer
that will call methods onCreateLabelsRequest.Builder
to create a request.- Returns:
- Result of the CreateLabels operation returned by the service.
- See Also:
-
createNotificationSubscription
default CreateNotificationSubscriptionResponse createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, TooManySubscriptionsException, ServiceUnavailableException, InvalidArgumentException, AwsServiceException, SdkClientException, WorkDocsException Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.
For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.
- Parameters:
createNotificationSubscriptionRequest
-- Returns:
- Result of the CreateNotificationSubscription operation returned by the service.
- See Also:
-
createNotificationSubscription
default CreateNotificationSubscriptionResponse createNotificationSubscription(Consumer<CreateNotificationSubscriptionRequest.Builder> createNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, TooManySubscriptionsException, ServiceUnavailableException, InvalidArgumentException, AwsServiceException, SdkClientException, WorkDocsException Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.
For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.
This is a convenience which creates an instance of the
CreateNotificationSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateNotificationSubscriptionRequest.builder()
- Parameters:
createNotificationSubscriptionRequest
- AConsumer
that will call methods onCreateNotificationSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the CreateNotificationSubscription operation returned by the service.
- See Also:
-
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws EntityAlreadyExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.
- Parameters:
createUserRequest
-- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws EntityAlreadyExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.
This is a convenience which creates an instance of the
CreateUserRequest.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
deactivateUser
default DeactivateUserResponse deactivateUser(DeactivateUserRequest deactivateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
- Parameters:
deactivateUserRequest
-- Returns:
- Result of the DeactivateUser operation returned by the service.
- See Also:
-
deactivateUser
default DeactivateUserResponse deactivateUser(Consumer<DeactivateUserRequest.Builder> deactivateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
This is a convenience which creates an instance of the
DeactivateUserRequest.Builder
avoiding the need to create one manually viaDeactivateUserRequest.builder()
- Parameters:
deactivateUserRequest
- AConsumer
that will call methods onDeactivateUserRequest.Builder
to create a request.- Returns:
- Result of the DeactivateUser operation returned by the service.
- See Also:
-
deleteComment
default DeleteCommentResponse deleteComment(DeleteCommentRequest deleteCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, AwsServiceException, SdkClientException, WorkDocsException Deletes the specified comment from the document version.
- Parameters:
deleteCommentRequest
-- Returns:
- Result of the DeleteComment operation returned by the service.
- See Also:
-
deleteComment
default DeleteCommentResponse deleteComment(Consumer<DeleteCommentRequest.Builder> deleteCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, AwsServiceException, SdkClientException, WorkDocsException Deletes the specified comment from the document version.
This is a convenience which creates an instance of the
DeleteCommentRequest.Builder
avoiding the need to create one manually viaDeleteCommentRequest.builder()
- Parameters:
deleteCommentRequest
- AConsumer
that will call methods onDeleteCommentRequest.Builder
to create a request.- Returns:
- Result of the DeleteComment operation returned by the service.
- See Also:
-
deleteCustomMetadata
default DeleteCustomMetadataResponse deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Deletes custom metadata from the specified resource.
- Parameters:
deleteCustomMetadataRequest
-- Returns:
- Result of the DeleteCustomMetadata operation returned by the service.
- See Also:
-
deleteCustomMetadata
default DeleteCustomMetadataResponse deleteCustomMetadata(Consumer<DeleteCustomMetadataRequest.Builder> deleteCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Deletes custom metadata from the specified resource.
This is a convenience which creates an instance of the
DeleteCustomMetadataRequest.Builder
avoiding the need to create one manually viaDeleteCustomMetadataRequest.builder()
- Parameters:
deleteCustomMetadataRequest
- AConsumer
that will call methods onDeleteCustomMetadataRequest.Builder
to create a request.- Returns:
- Result of the DeleteCustomMetadata operation returned by the service.
- See Also:
-
deleteDocument
default DeleteDocumentResponse deleteDocument(DeleteDocumentRequest deleteDocumentRequest) throws EntityNotExistsException, LimitExceededException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Permanently deletes the specified document and its associated metadata.
- Parameters:
deleteDocumentRequest
-- Returns:
- Result of the DeleteDocument operation returned by the service.
- See Also:
-
deleteDocument
default DeleteDocumentResponse deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest) throws EntityNotExistsException, LimitExceededException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Permanently deletes the specified document and its associated metadata.
This is a convenience which creates an instance of the
DeleteDocumentRequest.Builder
avoiding the need to create one manually viaDeleteDocumentRequest.builder()
- Parameters:
deleteDocumentRequest
- AConsumer
that will call methods onDeleteDocumentRequest.Builder
to create a request.- Returns:
- Result of the DeleteDocument operation returned by the service.
- See Also:
-
deleteDocumentVersion
default DeleteDocumentVersionResponse deleteDocumentVersion(DeleteDocumentVersionRequest deleteDocumentVersionRequest) throws EntityNotExistsException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedResourceAccessException, FailedDependencyException, InvalidOperationException, UnauthorizedOperationException, AwsServiceException, SdkClientException, WorkDocsException Deletes a specific version of a document.
- Parameters:
deleteDocumentVersionRequest
-- Returns:
- Result of the DeleteDocumentVersion operation returned by the service.
- See Also:
-
deleteDocumentVersion
default DeleteDocumentVersionResponse deleteDocumentVersion(Consumer<DeleteDocumentVersionRequest.Builder> deleteDocumentVersionRequest) throws EntityNotExistsException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedResourceAccessException, FailedDependencyException, InvalidOperationException, UnauthorizedOperationException, AwsServiceException, SdkClientException, WorkDocsException Deletes a specific version of a document.
This is a convenience which creates an instance of the
DeleteDocumentVersionRequest.Builder
avoiding the need to create one manually viaDeleteDocumentVersionRequest.builder()
- Parameters:
deleteDocumentVersionRequest
- AConsumer
that will call methods onDeleteDocumentVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteDocumentVersion operation returned by the service.
- See Also:
-
deleteFolder
default DeleteFolderResponse deleteFolder(DeleteFolderRequest deleteFolderRequest) throws EntityNotExistsException, LimitExceededException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Permanently deletes the specified folder and its contents.
- Parameters:
deleteFolderRequest
-- Returns:
- Result of the DeleteFolder operation returned by the service.
- See Also:
-
deleteFolder
default DeleteFolderResponse deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest) throws EntityNotExistsException, LimitExceededException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Permanently deletes the specified folder and its contents.
This is a convenience which creates an instance of the
DeleteFolderRequest.Builder
avoiding the need to create one manually viaDeleteFolderRequest.builder()
- Parameters:
deleteFolderRequest
- AConsumer
that will call methods onDeleteFolderRequest.Builder
to create a request.- Returns:
- Result of the DeleteFolder operation returned by the service.
- See Also:
-
deleteFolderContents
default DeleteFolderContentsResponse deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest) throws EntityNotExistsException, ProhibitedStateException, ConflictingOperationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Deletes the contents of the specified folder.
- Parameters:
deleteFolderContentsRequest
-- Returns:
- Result of the DeleteFolderContents operation returned by the service.
- See Also:
-
deleteFolderContents
default DeleteFolderContentsResponse deleteFolderContents(Consumer<DeleteFolderContentsRequest.Builder> deleteFolderContentsRequest) throws EntityNotExistsException, ProhibitedStateException, ConflictingOperationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Deletes the contents of the specified folder.
This is a convenience which creates an instance of the
DeleteFolderContentsRequest.Builder
avoiding the need to create one manually viaDeleteFolderContentsRequest.builder()
- Parameters:
deleteFolderContentsRequest
- AConsumer
that will call methods onDeleteFolderContentsRequest.Builder
to create a request.- Returns:
- Result of the DeleteFolderContents operation returned by the service.
- See Also:
-
deleteLabels
default DeleteLabelsResponse deleteLabels(DeleteLabelsRequest deleteLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Deletes the specified list of labels from a resource.
- Parameters:
deleteLabelsRequest
-- Returns:
- Result of the DeleteLabels operation returned by the service.
- See Also:
-
deleteLabels
default DeleteLabelsResponse deleteLabels(Consumer<DeleteLabelsRequest.Builder> deleteLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Deletes the specified list of labels from a resource.
This is a convenience which creates an instance of the
DeleteLabelsRequest.Builder
avoiding the need to create one manually viaDeleteLabelsRequest.builder()
- Parameters:
deleteLabelsRequest
- AConsumer
that will call methods onDeleteLabelsRequest.Builder
to create a request.- Returns:
- Result of the DeleteLabels operation returned by the service.
- See Also:
-
deleteNotificationSubscription
default DeleteNotificationSubscriptionResponse deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Deletes the specified subscription from the specified organization.
- Parameters:
deleteNotificationSubscriptionRequest
-- Returns:
- Result of the DeleteNotificationSubscription operation returned by the service.
- See Also:
-
deleteNotificationSubscription
default DeleteNotificationSubscriptionResponse deleteNotificationSubscription(Consumer<DeleteNotificationSubscriptionRequest.Builder> deleteNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Deletes the specified subscription from the specified organization.
This is a convenience which creates an instance of the
DeleteNotificationSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteNotificationSubscriptionRequest.builder()
- Parameters:
deleteNotificationSubscriptionRequest
- AConsumer
that will call methods onDeleteNotificationSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the DeleteNotificationSubscription operation returned by the service.
- See Also:
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Deletes the specified user from a Simple AD or Microsoft AD directory.
Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.
- Parameters:
deleteUserRequest
-- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Deletes the specified user from a Simple AD or Microsoft AD directory.
Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.
This is a convenience which creates an instance of the
DeleteUserRequest.Builder
avoiding the need to create one manually viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
describeActivities
default DescribeActivitiesResponse describeActivities(DescribeActivitiesRequest describeActivitiesRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Describes the user activities in a specified time period.
- Parameters:
describeActivitiesRequest
-- Returns:
- Result of the DescribeActivities operation returned by the service.
- See Also:
-
describeActivities
default DescribeActivitiesResponse describeActivities(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Describes the user activities in a specified time period.
This is a convenience which creates an instance of the
DescribeActivitiesRequest.Builder
avoiding the need to create one manually viaDescribeActivitiesRequest.builder()
- Parameters:
describeActivitiesRequest
- AConsumer
that will call methods onDescribeActivitiesRequest.Builder
to create a request.- Returns:
- Result of the DescribeActivities operation returned by the service.
- See Also:
-
describeActivitiesPaginator
default DescribeActivitiesIterable describeActivitiesPaginator(DescribeActivitiesRequest describeActivitiesRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeActivitiesIterable responses = client.describeActivitiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeActivitiesIterable responses = client .describeActivitiesPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeActivitiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeActivitiesIterable responses = client.describeActivitiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest)
operation.- Parameters:
describeActivitiesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeActivitiesPaginator
default DescribeActivitiesIterable describeActivitiesPaginator(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeActivitiesIterable responses = client.describeActivitiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeActivitiesIterable responses = client .describeActivitiesPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeActivitiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeActivitiesIterable responses = client.describeActivitiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest)
operation.
This is a convenience which creates an instance of the
DescribeActivitiesRequest.Builder
avoiding the need to create one manually viaDescribeActivitiesRequest.builder()
- Parameters:
describeActivitiesRequest
- AConsumer
that will call methods onDescribeActivitiesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeComments
default DescribeCommentsResponse describeComments(DescribeCommentsRequest describeCommentsRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException List all the comments for the specified document version.
- Parameters:
describeCommentsRequest
-- Returns:
- Result of the DescribeComments operation returned by the service.
- See Also:
-
describeComments
default DescribeCommentsResponse describeComments(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException List all the comments for the specified document version.
This is a convenience which creates an instance of the
DescribeCommentsRequest.Builder
avoiding the need to create one manually viaDescribeCommentsRequest.builder()
- Parameters:
describeCommentsRequest
- AConsumer
that will call methods onDescribeCommentsRequest.Builder
to create a request.- Returns:
- Result of the DescribeComments operation returned by the service.
- See Also:
-
describeCommentsPaginator
default DescribeCommentsIterable describeCommentsPaginator(DescribeCommentsRequest describeCommentsRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeCommentsIterable responses = client.describeCommentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeCommentsIterable responses = client .describeCommentsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeCommentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeCommentsIterable responses = client.describeCommentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest)
operation.- Parameters:
describeCommentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCommentsPaginator
default DescribeCommentsIterable describeCommentsPaginator(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeCommentsIterable responses = client.describeCommentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeCommentsIterable responses = client .describeCommentsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeCommentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeCommentsIterable responses = client.describeCommentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest)
operation.
This is a convenience which creates an instance of the
DescribeCommentsRequest.Builder
avoiding the need to create one manually viaDescribeCommentsRequest.builder()
- Parameters:
describeCommentsRequest
- AConsumer
that will call methods onDescribeCommentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDocumentVersions
default DescribeDocumentVersionsResponse describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, InvalidPasswordException, AwsServiceException, SdkClientException, WorkDocsException Retrieves the document versions for the specified document.
By default, only active versions are returned.
- Parameters:
describeDocumentVersionsRequest
-- Returns:
- Result of the DescribeDocumentVersions operation returned by the service.
- See Also:
-
describeDocumentVersions
default DescribeDocumentVersionsResponse describeDocumentVersions(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, InvalidPasswordException, AwsServiceException, SdkClientException, WorkDocsException Retrieves the document versions for the specified document.
By default, only active versions are returned.
This is a convenience which creates an instance of the
DescribeDocumentVersionsRequest.Builder
avoiding the need to create one manually viaDescribeDocumentVersionsRequest.builder()
- Parameters:
describeDocumentVersionsRequest
- AConsumer
that will call methods onDescribeDocumentVersionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDocumentVersions operation returned by the service.
- See Also:
-
describeDocumentVersionsPaginator
default DescribeDocumentVersionsIterable describeDocumentVersionsPaginator(DescribeDocumentVersionsRequest describeDocumentVersionsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, InvalidPasswordException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsIterable responses = client.describeDocumentVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsIterable responses = client .describeDocumentVersionsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsIterable responses = client.describeDocumentVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation.- Parameters:
describeDocumentVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDocumentVersionsPaginator
default DescribeDocumentVersionsIterable describeDocumentVersionsPaginator(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, InvalidPasswordException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsIterable responses = client.describeDocumentVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsIterable responses = client .describeDocumentVersionsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsIterable responses = client.describeDocumentVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDocumentVersionsRequest.Builder
avoiding the need to create one manually viaDescribeDocumentVersionsRequest.builder()
- Parameters:
describeDocumentVersionsRequest
- AConsumer
that will call methods onDescribeDocumentVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeFolderContents
default DescribeFolderContentsResponse describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest) throws EntityNotExistsException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Describes the contents of the specified folder, including its documents and subfolders.
By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.
- Parameters:
describeFolderContentsRequest
-- Returns:
- Result of the DescribeFolderContents operation returned by the service.
- See Also:
-
describeFolderContents
default DescribeFolderContentsResponse describeFolderContents(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest) throws EntityNotExistsException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Describes the contents of the specified folder, including its documents and subfolders.
By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.
This is a convenience which creates an instance of the
DescribeFolderContentsRequest.Builder
avoiding the need to create one manually viaDescribeFolderContentsRequest.builder()
- Parameters:
describeFolderContentsRequest
- AConsumer
that will call methods onDescribeFolderContentsRequest.Builder
to create a request.- Returns:
- Result of the DescribeFolderContents operation returned by the service.
- See Also:
-
describeFolderContentsPaginator
default DescribeFolderContentsIterable describeFolderContentsPaginator(DescribeFolderContentsRequest describeFolderContentsRequest) throws EntityNotExistsException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsIterable responses = client.describeFolderContentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsIterable responses = client .describeFolderContentsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsIterable responses = client.describeFolderContentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation.- Parameters:
describeFolderContentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeFolderContentsPaginator
default DescribeFolderContentsIterable describeFolderContentsPaginator(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest) throws EntityNotExistsException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsIterable responses = client.describeFolderContentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsIterable responses = client .describeFolderContentsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsIterable responses = client.describeFolderContentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation.
This is a convenience which creates an instance of the
DescribeFolderContentsRequest.Builder
avoiding the need to create one manually viaDescribeFolderContentsRequest.builder()
- Parameters:
describeFolderContentsRequest
- AConsumer
that will call methods onDescribeFolderContentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGroups
default DescribeGroupsResponse describeGroups(DescribeGroupsRequest describeGroupsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
- Parameters:
describeGroupsRequest
-- Returns:
- Result of the DescribeGroups operation returned by the service.
- See Also:
-
describeGroups
default DescribeGroupsResponse describeGroups(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
This is a convenience which creates an instance of the
DescribeGroupsRequest.Builder
avoiding the need to create one manually viaDescribeGroupsRequest.builder()
- Parameters:
describeGroupsRequest
- AConsumer
that will call methods onDescribeGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeGroups operation returned by the service.
- See Also:
-
describeGroupsPaginator
default DescribeGroupsIterable describeGroupsPaginator(DescribeGroupsRequest describeGroupsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeGroupsIterable responses = client.describeGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeGroupsIterable responses = client .describeGroupsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeGroupsIterable responses = client.describeGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest)
operation.- Parameters:
describeGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGroupsPaginator
default DescribeGroupsIterable describeGroupsPaginator(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeGroupsIterable responses = client.describeGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeGroupsIterable responses = client .describeGroupsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeGroupsIterable responses = client.describeGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeGroupsRequest.Builder
avoiding the need to create one manually viaDescribeGroupsRequest.builder()
- Parameters:
describeGroupsRequest
- AConsumer
that will call methods onDescribeGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeNotificationSubscriptions
default DescribeNotificationSubscriptionsResponse describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Lists the specified notification subscriptions.
- Parameters:
describeNotificationSubscriptionsRequest
-- Returns:
- Result of the DescribeNotificationSubscriptions operation returned by the service.
- See Also:
-
describeNotificationSubscriptions
default DescribeNotificationSubscriptionsResponse describeNotificationSubscriptions(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Lists the specified notification subscriptions.
This is a convenience which creates an instance of the
DescribeNotificationSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeNotificationSubscriptionsRequest.builder()
- Parameters:
describeNotificationSubscriptionsRequest
- AConsumer
that will call methods onDescribeNotificationSubscriptionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeNotificationSubscriptions operation returned by the service.
- See Also:
-
describeNotificationSubscriptionsPaginator
default DescribeNotificationSubscriptionsIterable describeNotificationSubscriptionsPaginator(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeNotificationSubscriptionsIterable responses = client.describeNotificationSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeNotificationSubscriptionsIterable responses = client .describeNotificationSubscriptionsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeNotificationSubscriptionsIterable responses = client.describeNotificationSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest)
operation.- Parameters:
describeNotificationSubscriptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeNotificationSubscriptionsPaginator
default DescribeNotificationSubscriptionsIterable describeNotificationSubscriptionsPaginator(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeNotificationSubscriptionsIterable responses = client.describeNotificationSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeNotificationSubscriptionsIterable responses = client .describeNotificationSubscriptionsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeNotificationSubscriptionsIterable responses = client.describeNotificationSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeNotificationSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeNotificationSubscriptionsRequest.builder()
- Parameters:
describeNotificationSubscriptionsRequest
- AConsumer
that will call methods onDescribeNotificationSubscriptionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeResourcePermissions
default DescribeResourcePermissionsResponse describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest) throws InvalidArgumentException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Describes the permissions of a specified resource.
- Parameters:
describeResourcePermissionsRequest
-- Returns:
- Result of the DescribeResourcePermissions operation returned by the service.
- See Also:
-
describeResourcePermissions
default DescribeResourcePermissionsResponse describeResourcePermissions(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest) throws InvalidArgumentException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Describes the permissions of a specified resource.
This is a convenience which creates an instance of the
DescribeResourcePermissionsRequest.Builder
avoiding the need to create one manually viaDescribeResourcePermissionsRequest.builder()
- Parameters:
describeResourcePermissionsRequest
- AConsumer
that will call methods onDescribeResourcePermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeResourcePermissions operation returned by the service.
- See Also:
-
describeResourcePermissionsPaginator
default DescribeResourcePermissionsIterable describeResourcePermissionsPaginator(DescribeResourcePermissionsRequest describeResourcePermissionsRequest) throws InvalidArgumentException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeResourcePermissionsIterable responses = client.describeResourcePermissionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeResourcePermissionsIterable responses = client .describeResourcePermissionsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeResourcePermissionsIterable responses = client.describeResourcePermissionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest)
operation.- Parameters:
describeResourcePermissionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeResourcePermissionsPaginator
default DescribeResourcePermissionsIterable describeResourcePermissionsPaginator(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest) throws InvalidArgumentException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeResourcePermissionsIterable responses = client.describeResourcePermissionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeResourcePermissionsIterable responses = client .describeResourcePermissionsPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeResourcePermissionsIterable responses = client.describeResourcePermissionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeResourcePermissionsRequest.Builder
avoiding the need to create one manually viaDescribeResourcePermissionsRequest.builder()
- Parameters:
describeResourcePermissionsRequest
- AConsumer
that will call methods onDescribeResourcePermissionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRootFolders
default DescribeRootFoldersResponse describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Describes the current user's special folders; the
RootFolder
and theRecycleBin
.RootFolder
is the root of user's files and folders andRecycleBin
is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
- Parameters:
describeRootFoldersRequest
-- Returns:
- Result of the DescribeRootFolders operation returned by the service.
- See Also:
-
describeRootFolders
default DescribeRootFoldersResponse describeRootFolders(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Describes the current user's special folders; the
RootFolder
and theRecycleBin
.RootFolder
is the root of user's files and folders andRecycleBin
is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
This is a convenience which creates an instance of the
DescribeRootFoldersRequest.Builder
avoiding the need to create one manually viaDescribeRootFoldersRequest.builder()
- Parameters:
describeRootFoldersRequest
- AConsumer
that will call methods onDescribeRootFoldersRequest.Builder
to create a request.- Returns:
- Result of the DescribeRootFolders operation returned by the service.
- See Also:
-
describeRootFoldersPaginator
default DescribeRootFoldersIterable describeRootFoldersPaginator(DescribeRootFoldersRequest describeRootFoldersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeRootFoldersIterable responses = client.describeRootFoldersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeRootFoldersIterable responses = client .describeRootFoldersPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeRootFoldersIterable responses = client.describeRootFoldersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest)
operation.- Parameters:
describeRootFoldersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRootFoldersPaginator
default DescribeRootFoldersIterable describeRootFoldersPaginator(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeRootFoldersIterable responses = client.describeRootFoldersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeRootFoldersIterable responses = client .describeRootFoldersPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeRootFoldersIterable responses = client.describeRootFoldersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest)
operation.
This is a convenience which creates an instance of the
DescribeRootFoldersRequest.Builder
avoiding the need to create one manually viaDescribeRootFoldersRequest.builder()
- Parameters:
describeRootFoldersRequest
- AConsumer
that will call methods onDescribeRootFoldersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUsers
default DescribeUsersResponse describeUsers(DescribeUsersRequest describeUsersRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, InvalidArgumentException, RequestedEntityTooLargeException, AwsServiceException, SdkClientException, WorkDocsException Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.
- Parameters:
describeUsersRequest
-- Returns:
- Result of the DescribeUsers operation returned by the service.
- See Also:
-
describeUsers
default DescribeUsersResponse describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, InvalidArgumentException, RequestedEntityTooLargeException, AwsServiceException, SdkClientException, WorkDocsException Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.
This is a convenience which creates an instance of the
DescribeUsersRequest.Builder
avoiding the need to create one manually viaDescribeUsersRequest.builder()
- Parameters:
describeUsersRequest
- AConsumer
that will call methods onDescribeUsersRequest.Builder
to create a request.- Returns:
- Result of the DescribeUsers operation returned by the service.
- See Also:
-
describeUsersPaginator
default DescribeUsersIterable describeUsersPaginator(DescribeUsersRequest describeUsersRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, InvalidArgumentException, RequestedEntityTooLargeException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation.- Parameters:
describeUsersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUsersPaginator
default DescribeUsersIterable describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, InvalidArgumentException, RequestedEntityTooLargeException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); for (software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation.
This is a convenience which creates an instance of the
DescribeUsersRequest.Builder
avoiding the need to create one manually viaDescribeUsersRequest.builder()
- Parameters:
describeUsersRequest
- AConsumer
that will call methods onDescribeUsersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getCurrentUser
default GetCurrentUserResponse getCurrentUser(GetCurrentUserRequest getCurrentUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.
This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
- Parameters:
getCurrentUserRequest
-- Returns:
- Result of the GetCurrentUser operation returned by the service.
- See Also:
-
getCurrentUser
default GetCurrentUserResponse getCurrentUser(Consumer<GetCurrentUserRequest.Builder> getCurrentUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.
This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
This is a convenience which creates an instance of the
GetCurrentUserRequest.Builder
avoiding the need to create one manually viaGetCurrentUserRequest.builder()
- Parameters:
getCurrentUserRequest
- AConsumer
that will call methods onGetCurrentUserRequest.Builder
to create a request.- Returns:
- Result of the GetCurrentUser operation returned by the service.
- See Also:
-
getDocument
default GetDocumentResponse getDocument(GetDocumentRequest getDocumentRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, InvalidPasswordException, AwsServiceException, SdkClientException, WorkDocsException Retrieves details of a document.
- Parameters:
getDocumentRequest
-- Returns:
- Result of the GetDocument operation returned by the service.
- See Also:
-
getDocument
default GetDocumentResponse getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, InvalidPasswordException, AwsServiceException, SdkClientException, WorkDocsException Retrieves details of a document.
This is a convenience which creates an instance of the
GetDocumentRequest.Builder
avoiding the need to create one manually viaGetDocumentRequest.builder()
- Parameters:
getDocumentRequest
- AConsumer
that will call methods onGetDocumentRequest.Builder
to create a request.- Returns:
- Result of the GetDocument operation returned by the service.
- See Also:
-
getDocumentPath
default GetDocumentPathResponse getDocumentPath(GetDocumentPathRequest getDocumentPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Retrieves the path information (the hierarchy from the root folder) for the requested document.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.
- Parameters:
getDocumentPathRequest
-- Returns:
- Result of the GetDocumentPath operation returned by the service.
- See Also:
-
getDocumentPath
default GetDocumentPathResponse getDocumentPath(Consumer<GetDocumentPathRequest.Builder> getDocumentPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Retrieves the path information (the hierarchy from the root folder) for the requested document.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.
This is a convenience which creates an instance of the
GetDocumentPathRequest.Builder
avoiding the need to create one manually viaGetDocumentPathRequest.builder()
- Parameters:
getDocumentPathRequest
- AConsumer
that will call methods onGetDocumentPathRequest.Builder
to create a request.- Returns:
- Result of the GetDocumentPath operation returned by the service.
- See Also:
-
getDocumentVersion
default GetDocumentVersionResponse getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, InvalidPasswordException, AwsServiceException, SdkClientException, WorkDocsException Retrieves version metadata for the specified document.
- Parameters:
getDocumentVersionRequest
-- Returns:
- Result of the GetDocumentVersion operation returned by the service.
- See Also:
-
getDocumentVersion
default GetDocumentVersionResponse getDocumentVersion(Consumer<GetDocumentVersionRequest.Builder> getDocumentVersionRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, InvalidPasswordException, AwsServiceException, SdkClientException, WorkDocsException Retrieves version metadata for the specified document.
This is a convenience which creates an instance of the
GetDocumentVersionRequest.Builder
avoiding the need to create one manually viaGetDocumentVersionRequest.builder()
- Parameters:
getDocumentVersionRequest
- AConsumer
that will call methods onGetDocumentVersionRequest.Builder
to create a request.- Returns:
- Result of the GetDocumentVersion operation returned by the service.
- See Also:
-
getFolder
default GetFolderResponse getFolder(GetFolderRequest getFolderRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Retrieves the metadata of the specified folder.
- Parameters:
getFolderRequest
-- Returns:
- Result of the GetFolder operation returned by the service.
- See Also:
-
getFolder
default GetFolderResponse getFolder(Consumer<GetFolderRequest.Builder> getFolderRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, AwsServiceException, SdkClientException, WorkDocsException Retrieves the metadata of the specified folder.
This is a convenience which creates an instance of the
GetFolderRequest.Builder
avoiding the need to create one manually viaGetFolderRequest.builder()
- Parameters:
getFolderRequest
- AConsumer
that will call methods onGetFolderRequest.Builder
to create a request.- Returns:
- Result of the GetFolder operation returned by the service.
- See Also:
-
getFolderPath
default GetFolderPathResponse getFolderPath(GetFolderPathRequest getFolderPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Retrieves the path information (the hierarchy from the root folder) for the specified folder.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.
- Parameters:
getFolderPathRequest
-- Returns:
- Result of the GetFolderPath operation returned by the service.
- See Also:
-
getFolderPath
default GetFolderPathResponse getFolderPath(Consumer<GetFolderPathRequest.Builder> getFolderPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Retrieves the path information (the hierarchy from the root folder) for the specified folder.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.
This is a convenience which creates an instance of the
GetFolderPathRequest.Builder
avoiding the need to create one manually viaGetFolderPathRequest.builder()
- Parameters:
getFolderPathRequest
- AConsumer
that will call methods onGetFolderPathRequest.Builder
to create a request.- Returns:
- Result of the GetFolderPath operation returned by the service.
- See Also:
-
getResources
default GetResourcesResponse getResources(GetResourcesRequest getResourcesRequest) throws UnauthorizedResourceAccessException, UnauthorizedOperationException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Retrieves a collection of resources, including folders and documents. The only
CollectionType
supported isSHARED_WITH_ME
.- Parameters:
getResourcesRequest
-- Returns:
- Result of the GetResources operation returned by the service.
- See Also:
-
getResources
default GetResourcesResponse getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest) throws UnauthorizedResourceAccessException, UnauthorizedOperationException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Retrieves a collection of resources, including folders and documents. The only
CollectionType
supported isSHARED_WITH_ME
.
This is a convenience which creates an instance of the
GetResourcesRequest.Builder
avoiding the need to create one manually viaGetResourcesRequest.builder()
- Parameters:
getResourcesRequest
- AConsumer
that will call methods onGetResourcesRequest.Builder
to create a request.- Returns:
- Result of the GetResources operation returned by the service.
- See Also:
-
initiateDocumentVersionUpload
default InitiateDocumentVersionUploadResponse initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest) throws EntityNotExistsException, EntityAlreadyExistsException, StorageLimitExceededException, StorageLimitWillExceedException, LimitExceededException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DraftUploadOutOfSyncException, ResourceAlreadyCheckedOutException, InvalidPasswordException, InvalidArgumentException, AwsServiceException, SdkClientException, WorkDocsException Creates a new document object and version object.
The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.
To cancel the document upload, call AbortDocumentVersionUpload.
- Parameters:
initiateDocumentVersionUploadRequest
-- Returns:
- Result of the InitiateDocumentVersionUpload operation returned by the service.
- See Also:
-
initiateDocumentVersionUpload
default InitiateDocumentVersionUploadResponse initiateDocumentVersionUpload(Consumer<InitiateDocumentVersionUploadRequest.Builder> initiateDocumentVersionUploadRequest) throws EntityNotExistsException, EntityAlreadyExistsException, StorageLimitExceededException, StorageLimitWillExceedException, LimitExceededException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DraftUploadOutOfSyncException, ResourceAlreadyCheckedOutException, InvalidPasswordException, InvalidArgumentException, AwsServiceException, SdkClientException, WorkDocsException Creates a new document object and version object.
The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.
To cancel the document upload, call AbortDocumentVersionUpload.
This is a convenience which creates an instance of the
InitiateDocumentVersionUploadRequest.Builder
avoiding the need to create one manually viaInitiateDocumentVersionUploadRequest.builder()
- Parameters:
initiateDocumentVersionUploadRequest
- AConsumer
that will call methods onInitiateDocumentVersionUploadRequest.Builder
to create a request.- Returns:
- Result of the InitiateDocumentVersionUpload operation returned by the service.
- See Also:
-
removeAllResourcePermissions
default RemoveAllResourcePermissionsResponse removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Removes all the permissions from the specified resource.
- Parameters:
removeAllResourcePermissionsRequest
-- Returns:
- Result of the RemoveAllResourcePermissions operation returned by the service.
- See Also:
-
removeAllResourcePermissions
default RemoveAllResourcePermissionsResponse removeAllResourcePermissions(Consumer<RemoveAllResourcePermissionsRequest.Builder> removeAllResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Removes all the permissions from the specified resource.
This is a convenience which creates an instance of the
RemoveAllResourcePermissionsRequest.Builder
avoiding the need to create one manually viaRemoveAllResourcePermissionsRequest.builder()
- Parameters:
removeAllResourcePermissionsRequest
- AConsumer
that will call methods onRemoveAllResourcePermissionsRequest.Builder
to create a request.- Returns:
- Result of the RemoveAllResourcePermissions operation returned by the service.
- See Also:
-
removeResourcePermission
default RemoveResourcePermissionResponse removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Removes the permission for the specified principal from the specified resource.
- Parameters:
removeResourcePermissionRequest
-- Returns:
- Result of the RemoveResourcePermission operation returned by the service.
- See Also:
-
removeResourcePermission
default RemoveResourcePermissionResponse removeResourcePermission(Consumer<RemoveResourcePermissionRequest.Builder> removeResourcePermissionRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Removes the permission for the specified principal from the specified resource.
This is a convenience which creates an instance of the
RemoveResourcePermissionRequest.Builder
avoiding the need to create one manually viaRemoveResourcePermissionRequest.builder()
- Parameters:
removeResourcePermissionRequest
- AConsumer
that will call methods onRemoveResourcePermissionRequest.Builder
to create a request.- Returns:
- Result of the RemoveResourcePermission operation returned by the service.
- See Also:
-
restoreDocumentVersions
default RestoreDocumentVersionsResponse restoreDocumentVersions(RestoreDocumentVersionsRequest restoreDocumentVersionsRequest) throws EntityNotExistsException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedResourceAccessException, FailedDependencyException, InvalidOperationException, UnauthorizedOperationException, AwsServiceException, SdkClientException, WorkDocsException Recovers a deleted version of an Amazon WorkDocs document.
- Parameters:
restoreDocumentVersionsRequest
-- Returns:
- Result of the RestoreDocumentVersions operation returned by the service.
- See Also:
-
restoreDocumentVersions
default RestoreDocumentVersionsResponse restoreDocumentVersions(Consumer<RestoreDocumentVersionsRequest.Builder> restoreDocumentVersionsRequest) throws EntityNotExistsException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedResourceAccessException, FailedDependencyException, InvalidOperationException, UnauthorizedOperationException, AwsServiceException, SdkClientException, WorkDocsException Recovers a deleted version of an Amazon WorkDocs document.
This is a convenience which creates an instance of the
RestoreDocumentVersionsRequest.Builder
avoiding the need to create one manually viaRestoreDocumentVersionsRequest.builder()
- Parameters:
restoreDocumentVersionsRequest
- AConsumer
that will call methods onRestoreDocumentVersionsRequest.Builder
to create a request.- Returns:
- Result of the RestoreDocumentVersions operation returned by the service.
- See Also:
-
searchResources
default SearchResourcesResponse searchResources(SearchResourcesRequest searchResourcesRequest) throws InvalidArgumentException, UnauthorizedResourceAccessException, UnauthorizedOperationException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Searches metadata and the content of folders, documents, document versions, and comments.
- Parameters:
searchResourcesRequest
-- Returns:
- Result of the SearchResources operation returned by the service.
- See Also:
-
searchResources
default SearchResourcesResponse searchResources(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest) throws InvalidArgumentException, UnauthorizedResourceAccessException, UnauthorizedOperationException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Searches metadata and the content of folders, documents, document versions, and comments.
This is a convenience which creates an instance of the
SearchResourcesRequest.Builder
avoiding the need to create one manually viaSearchResourcesRequest.builder()
- Parameters:
searchResourcesRequest
- AConsumer
that will call methods onSearchResourcesRequest.Builder
to create a request.- Returns:
- Result of the SearchResources operation returned by the service.
- See Also:
-
searchResourcesPaginator
default SearchResourcesIterable searchResourcesPaginator(SearchResourcesRequest searchResourcesRequest) throws InvalidArgumentException, UnauthorizedResourceAccessException, UnauthorizedOperationException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
searchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.SearchResourcesIterable responses = client.searchResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.SearchResourcesIterable responses = client .searchResourcesPaginator(request); for (software.amazon.awssdk.services.workdocs.model.SearchResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.SearchResourcesIterable responses = client.searchResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
searchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest)
operation.- Parameters:
searchResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchResourcesPaginator
default SearchResourcesIterable searchResourcesPaginator(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest) throws InvalidArgumentException, UnauthorizedResourceAccessException, UnauthorizedOperationException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException This is a variant of
searchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workdocs.paginators.SearchResourcesIterable responses = client.searchResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workdocs.paginators.SearchResourcesIterable responses = client .searchResourcesPaginator(request); for (software.amazon.awssdk.services.workdocs.model.SearchResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workdocs.paginators.SearchResourcesIterable responses = client.searchResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit 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
searchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest)
operation.
This is a convenience which creates an instance of the
SearchResourcesRequest.Builder
avoiding the need to create one manually viaSearchResourcesRequest.builder()
- Parameters:
searchResourcesRequest
- AConsumer
that will call methods onSearchResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
updateDocument
default UpdateDocumentResponse updateDocument(UpdateDocumentRequest updateDocumentRequest) throws EntityNotExistsException, EntityAlreadyExistsException, LimitExceededException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
- Parameters:
updateDocumentRequest
-- Returns:
- Result of the UpdateDocument operation returned by the service.
- See Also:
-
updateDocument
default UpdateDocumentResponse updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest) throws EntityNotExistsException, EntityAlreadyExistsException, LimitExceededException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
This is a convenience which creates an instance of the
UpdateDocumentRequest.Builder
avoiding the need to create one manually viaUpdateDocumentRequest.builder()
- Parameters:
updateDocumentRequest
- AConsumer
that will call methods onUpdateDocumentRequest.Builder
to create a request.- Returns:
- Result of the UpdateDocument operation returned by the service.
- See Also:
-
updateDocumentVersion
default UpdateDocumentVersionResponse updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, InvalidOperationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Changes the status of the document version to ACTIVE.
Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.
- Parameters:
updateDocumentVersionRequest
-- Returns:
- Result of the UpdateDocumentVersion operation returned by the service.
- See Also:
-
updateDocumentVersion
default UpdateDocumentVersionResponse updateDocumentVersion(Consumer<UpdateDocumentVersionRequest.Builder> updateDocumentVersionRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, InvalidOperationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Changes the status of the document version to ACTIVE.
Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.
This is a convenience which creates an instance of the
UpdateDocumentVersionRequest.Builder
avoiding the need to create one manually viaUpdateDocumentVersionRequest.builder()
- Parameters:
updateDocumentVersionRequest
- AConsumer
that will call methods onUpdateDocumentVersionRequest.Builder
to create a request.- Returns:
- Result of the UpdateDocumentVersion operation returned by the service.
- See Also:
-
updateFolder
default UpdateFolderResponse updateFolder(UpdateFolderRequest updateFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
- Parameters:
updateFolderRequest
-- Returns:
- Result of the UpdateFolder operation returned by the service.
- See Also:
-
updateFolder
default UpdateFolderResponse updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, ConflictingOperationException, ConcurrentModificationException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, AwsServiceException, SdkClientException, WorkDocsException Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
This is a convenience which creates an instance of the
UpdateFolderRequest.Builder
avoiding the need to create one manually viaUpdateFolderRequest.builder()
- Parameters:
updateFolderRequest
- AConsumer
that will call methods onUpdateFolderRequest.Builder
to create a request.- Returns:
- Result of the UpdateFolder operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, IllegalUserStateException, ProhibitedStateException, FailedDependencyException, ServiceUnavailableException, DeactivatingLastSystemUserException, InvalidArgumentException, AwsServiceException, SdkClientException, WorkDocsException Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
- Parameters:
updateUserRequest
-- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, IllegalUserStateException, ProhibitedStateException, FailedDependencyException, ServiceUnavailableException, DeactivatingLastSystemUserException, InvalidArgumentException, AwsServiceException, SdkClientException, WorkDocsException Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
This is a convenience which creates an instance of the
UpdateUserRequest.Builder
avoiding the need to create one manually viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
create
Create aWorkDocsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWorkDocsClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-