com.amazonaws.services.workdocs

Class AbstractAmazonWorkDocs

java.lang.Object

com.amazonaws.services.workdocs.AbstractAmazonWorkDocs

All Implemented Interfaces:

AmazonWorkDocs

Direct Known Subclasses:

AbstractAmazonWorkDocsAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonWorkDocs
extends Object
implements AmazonWorkDocs

Abstract implementation of AmazonWorkDocs. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.workdocs.AmazonWorkDocs

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AbortDocumentVersionUploadResult	abortDocumentVersionUpload(AbortDocumentVersionUploadRequest request) Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload.
ActivateUserResult	activateUser(ActivateUserRequest request) Activates the specified user.
AddResourcePermissionsResult	addResourcePermissions(AddResourcePermissionsRequest request) Creates a set of permissions for the specified folder or document.
CreateFolderResult	createFolder(CreateFolderRequest request) Creates a folder with the specified name and parent folder.
CreateNotificationSubscriptionResult	createNotificationSubscription(CreateNotificationSubscriptionRequest request) Configure WorkDocs to use Amazon SNS notifications.
CreateUserResult	createUser(CreateUserRequest request) Creates a user in a Simple AD or Microsoft AD directory.
DeactivateUserResult	deactivateUser(DeactivateUserRequest request) Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
DeleteDocumentResult	deleteDocument(DeleteDocumentRequest request) Permanently deletes the specified document and its associated metadata.
DeleteFolderResult	deleteFolder(DeleteFolderRequest request) Permanently deletes the specified folder and its contents.
DeleteFolderContentsResult	deleteFolderContents(DeleteFolderContentsRequest request) Deletes the contents of the specified folder.
DeleteNotificationSubscriptionResult	deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request) Deletes the specified subscription from the specified organization.
DeleteUserResult	deleteUser(DeleteUserRequest request) Deletes the specified user from a Simple AD or Microsoft AD directory.
DescribeDocumentVersionsResult	describeDocumentVersions(DescribeDocumentVersionsRequest request) Retrieves the document versions for the specified document.
DescribeFolderContentsResult	describeFolderContents(DescribeFolderContentsRequest request) Describes the contents of the specified folder, including its documents and sub-folders.
DescribeNotificationSubscriptionsResult	describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest request) Lists the specified notification subscriptions.
DescribeResourcePermissionsResult	describeResourcePermissions(DescribeResourcePermissionsRequest request) Describes the permissions of a specified resource.
DescribeUsersResult	describeUsers(DescribeUsersRequest request) Describes the specified users.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetDocumentResult	getDocument(GetDocumentRequest request) Retrieves the specified document object.
GetDocumentPathResult	getDocumentPath(GetDocumentPathRequest request) Retrieves the path information (the hierarchy from the root folder) for the requested document.
GetDocumentVersionResult	getDocumentVersion(GetDocumentVersionRequest request) Retrieves version metadata for the specified document.
GetFolderResult	getFolder(GetFolderRequest request) Retrieves the metadata of the specified folder.
GetFolderPathResult	getFolderPath(GetFolderPathRequest request) Retrieves the path information (the hierarchy from the root folder) for the specified folder.
InitiateDocumentVersionUploadResult	initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest request) Creates a new document object and version object.
RemoveAllResourcePermissionsResult	removeAllResourcePermissions(RemoveAllResourcePermissionsRequest request) Removes all the permissions from the specified resource.
RemoveResourcePermissionResult	removeResourcePermission(RemoveResourcePermissionRequest request) Removes the permission for the specified principal from the specified resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateDocumentResult	updateDocument(UpdateDocumentRequest request) Updates the specified attributes of the specified document.
UpdateDocumentVersionResult	updateDocumentVersion(UpdateDocumentVersionRequest request) Changes the status of the document version to ACTIVE.
UpdateFolderResult	updateFolder(UpdateFolderRequest request) Updates the specified attributes of the specified folder.
UpdateUserResult	updateUser(UpdateUserRequest request) Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

abortDocumentVersionUpload

public AbortDocumentVersionUploadResult abortDocumentVersionUpload(AbortDocumentVersionUploadRequest request)

Description copied from interface: AmazonWorkDocs

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 or fails to upload the document version.

Specified by:

abortDocumentVersionUpload in interface AmazonWorkDocs

Returns:

Result of the AbortDocumentVersionUpload operation returned by the service.

See Also:

AWS API Documentation

activateUser

public ActivateUserResult activateUser(ActivateUserRequest request)

Description copied from interface: AmazonWorkDocs

Activates the specified user. Only active users can access Amazon WorkDocs.

Specified by:

activateUser in interface AmazonWorkDocs

Returns:

Result of the ActivateUser operation returned by the service.

See Also:

AWS API Documentation

addResourcePermissions

public AddResourcePermissionsResult addResourcePermissions(AddResourcePermissionsRequest request)

Description copied from interface: AmazonWorkDocs

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

Specified by:

addResourcePermissions in interface AmazonWorkDocs

Returns:

Result of the AddResourcePermissions operation returned by the service.

See Also:

AWS API Documentation

createFolder

public CreateFolderResult createFolder(CreateFolderRequest request)

Description copied from interface: AmazonWorkDocs

Creates a folder with the specified name and parent folder.

Specified by:

createFolder in interface AmazonWorkDocs

Returns:

Result of the CreateFolder operation returned by the service.

See Also:

AWS API Documentation

createNotificationSubscription

public CreateNotificationSubscriptionResult createNotificationSubscription(CreateNotificationSubscriptionRequest request)

Description copied from interface: AmazonWorkDocs

Configure WorkDocs to use Amazon SNS notifications.

The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription in the Amazon Simple Notification Service Developer Guide.

Specified by:

createNotificationSubscription in interface AmazonWorkDocs

Returns:

Result of the CreateNotificationSubscription operation returned by the service.

See Also:

AWS API Documentation

createUser

public CreateUserResult createUser(CreateUserRequest request)

Description copied from interface: AmazonWorkDocs

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.

Specified by:

createUser in interface AmazonWorkDocs

Returns:

Result of the CreateUser operation returned by the service.

See Also:

AWS API Documentation

deactivateUser

public DeactivateUserResult deactivateUser(DeactivateUserRequest request)

Description copied from interface: AmazonWorkDocs

Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

Specified by:

deactivateUser in interface AmazonWorkDocs

Returns:

Result of the DeactivateUser operation returned by the service.

See Also:

AWS API Documentation

deleteDocument

public DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)

Description copied from interface: AmazonWorkDocs

Permanently deletes the specified document and its associated metadata.

Specified by:

deleteDocument in interface AmazonWorkDocs

Returns:

Result of the DeleteDocument operation returned by the service.

See Also:

AWS API Documentation

deleteFolder

public DeleteFolderResult deleteFolder(DeleteFolderRequest request)

Description copied from interface: AmazonWorkDocs

Permanently deletes the specified folder and its contents.

Specified by:

deleteFolder in interface AmazonWorkDocs

Returns:

Result of the DeleteFolder operation returned by the service.

See Also:

AWS API Documentation

deleteFolderContents

public DeleteFolderContentsResult deleteFolderContents(DeleteFolderContentsRequest request)

Description copied from interface: AmazonWorkDocs

Deletes the contents of the specified folder.

Specified by:

deleteFolderContents in interface AmazonWorkDocs

Returns:

Result of the DeleteFolderContents operation returned by the service.

See Also:

AWS API Documentation

deleteNotificationSubscription

public DeleteNotificationSubscriptionResult deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request)

Description copied from interface: AmazonWorkDocs

Deletes the specified subscription from the specified organization.

Specified by:

deleteNotificationSubscription in interface AmazonWorkDocs

Returns:

Result of the DeleteNotificationSubscription operation returned by the service.

See Also:

AWS API Documentation

deleteUser

public DeleteUserResult deleteUser(DeleteUserRequest request)

Description copied from interface: AmazonWorkDocs

Deletes the specified user from a Simple AD or Microsoft AD directory.

Specified by:

deleteUser in interface AmazonWorkDocs

Returns:

Result of the DeleteUser operation returned by the service.

See Also:

AWS API Documentation

describeDocumentVersions

public DescribeDocumentVersionsResult describeDocumentVersions(DescribeDocumentVersionsRequest request)

Description copied from interface: AmazonWorkDocs

Retrieves the document versions for the specified document.

By default, only active versions are returned.

Specified by:

describeDocumentVersions in interface AmazonWorkDocs

Returns:

Result of the DescribeDocumentVersions operation returned by the service.

See Also:

AWS API Documentation

describeFolderContents

public DescribeFolderContentsResult describeFolderContents(DescribeFolderContentsRequest request)

Description copied from interface: AmazonWorkDocs

Describes the contents of the specified folder, including its documents and sub-folders.

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.

Specified by:

describeFolderContents in interface AmazonWorkDocs

Returns:

Result of the DescribeFolderContents operation returned by the service.

See Also:

AWS API Documentation

describeNotificationSubscriptions

public DescribeNotificationSubscriptionsResult describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest request)

Description copied from interface: AmazonWorkDocs

Lists the specified notification subscriptions.

Specified by:

describeNotificationSubscriptions in interface AmazonWorkDocs

Returns:

Result of the DescribeNotificationSubscriptions operation returned by the service.

See Also:

AWS API Documentation

describeResourcePermissions

public DescribeResourcePermissionsResult describeResourcePermissions(DescribeResourcePermissionsRequest request)

Description copied from interface: AmazonWorkDocs

Describes the permissions of a specified resource.

Specified by:

describeResourcePermissions in interface AmazonWorkDocs

Returns:

Result of the DescribeResourcePermissions operation returned by the service.

See Also:

AWS API Documentation

describeUsers

public DescribeUsersResult describeUsers(DescribeUsersRequest request)

Description copied from interface: AmazonWorkDocs

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.

Specified by:

describeUsers in interface AmazonWorkDocs

Returns:

Result of the DescribeUsers operation returned by the service.

See Also:

AWS API Documentation

getDocument

public GetDocumentResult getDocument(GetDocumentRequest request)

Description copied from interface: AmazonWorkDocs

Retrieves the specified document object.

Specified by:

getDocument in interface AmazonWorkDocs

Returns:

Result of the GetDocument operation returned by the service.

See Also:

AWS API Documentation

getDocumentPath

public GetDocumentPathResult getDocumentPath(GetDocumentPathRequest request)

Description copied from interface: AmazonWorkDocs

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.

Specified by:

getDocumentPath in interface AmazonWorkDocs

Returns:

Result of the GetDocumentPath operation returned by the service.

See Also:

AWS API Documentation

getDocumentVersion

public GetDocumentVersionResult getDocumentVersion(GetDocumentVersionRequest request)

Description copied from interface: AmazonWorkDocs

Retrieves version metadata for the specified document.

Specified by:

getDocumentVersion in interface AmazonWorkDocs

Returns:

Result of the GetDocumentVersion operation returned by the service.

See Also:

AWS API Documentation

getFolder

public GetFolderResult getFolder(GetFolderRequest request)

Description copied from interface: AmazonWorkDocs

Retrieves the metadata of the specified folder.

Specified by:

getFolder in interface AmazonWorkDocs

Returns:

Result of the GetFolder operation returned by the service.

See Also:

AWS API Documentation

getFolderPath

public GetFolderPathResult getFolderPath(GetFolderPathRequest request)

Description copied from interface: AmazonWorkDocs

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.

Specified by:

getFolderPath in interface AmazonWorkDocs

Returns:

Result of the GetFolderPath operation returned by the service.

See Also:

AWS API Documentation

initiateDocumentVersionUpload

public InitiateDocumentVersionUploadResult initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest request)

Description copied from interface: AmazonWorkDocs

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.

Specified by:

initiateDocumentVersionUpload in interface AmazonWorkDocs

Returns:

Result of the InitiateDocumentVersionUpload operation returned by the service.

See Also:

AWS API Documentation

removeAllResourcePermissions

public RemoveAllResourcePermissionsResult removeAllResourcePermissions(RemoveAllResourcePermissionsRequest request)

Description copied from interface: AmazonWorkDocs

Removes all the permissions from the specified resource.

Specified by:

removeAllResourcePermissions in interface AmazonWorkDocs

Returns:

Result of the RemoveAllResourcePermissions operation returned by the service.

See Also:

AWS API Documentation

removeResourcePermission

public RemoveResourcePermissionResult removeResourcePermission(RemoveResourcePermissionRequest request)

Description copied from interface: AmazonWorkDocs

Removes the permission for the specified principal from the specified resource.

Specified by:

removeResourcePermission in interface AmazonWorkDocs

Returns:

Result of the RemoveResourcePermission operation returned by the service.

See Also:

AWS API Documentation

updateDocument

public UpdateDocumentResult updateDocument(UpdateDocumentRequest request)

Description copied from interface: AmazonWorkDocs

Updates the specified attributes of the specified document. The user must have access to both the document and its parent folder, if applicable.

Specified by:

updateDocument in interface AmazonWorkDocs

Returns:

Result of the UpdateDocument operation returned by the service.

See Also:

AWS API Documentation

updateDocumentVersion

public UpdateDocumentVersionResult updateDocumentVersion(UpdateDocumentVersionRequest request)

Description copied from interface: AmazonWorkDocs

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.

Specified by:

updateDocumentVersion in interface AmazonWorkDocs

Returns:

Result of the UpdateDocumentVersion operation returned by the service.

See Also:

AWS API Documentation

updateFolder

public UpdateFolderResult updateFolder(UpdateFolderRequest request)

Description copied from interface: AmazonWorkDocs

Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.

Specified by:

updateFolder in interface AmazonWorkDocs

Returns:

Result of the UpdateFolder operation returned by the service.

See Also:

AWS API Documentation

updateUser

public UpdateUserResult updateUser(UpdateUserRequest request)

Description copied from interface: AmazonWorkDocs

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Specified by:

updateUser in interface AmazonWorkDocs

Returns:

Result of the UpdateUser operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonWorkDocs

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonWorkDocs

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonWorkDocs

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AmazonWorkDocs

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.