workdocs/aws.sdk.kotlin.services.workdocs

Package-level declarations

Types

Link copied to clipboard
interface WorkDocsClient : SdkClient

The Amazon WorkDocs API is designed for the following use cases:

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun WorkDocsClient.abortDocumentVersionUpload(crossinline block: AbortDocumentVersionUploadRequest.Builder.() -> Unit): AbortDocumentVersionUploadResponse

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.

Link copied to clipboard
inline suspend fun WorkDocsClient.activateUser(crossinline block: ActivateUserRequest.Builder.() -> Unit): ActivateUserResponse

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

Link copied to clipboard
inline suspend fun WorkDocsClient.addResourcePermissions(crossinline block: AddResourcePermissionsRequest.Builder.() -> Unit): AddResourcePermissionsResponse

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

Link copied to clipboard
inline suspend fun WorkDocsClient.createComment(crossinline block: CreateCommentRequest.Builder.() -> Unit): CreateCommentResponse

Adds a new comment to the specified document version.

Link copied to clipboard
inline suspend fun WorkDocsClient.createCustomMetadata(crossinline block: CreateCustomMetadataRequest.Builder.() -> Unit): CreateCustomMetadataResponse

Adds one or more custom properties to the specified resource (a folder, document, or version).

Link copied to clipboard
inline suspend fun WorkDocsClient.createFolder(crossinline block: CreateFolderRequest.Builder.() -> Unit): CreateFolderResponse

Creates a folder with the specified name and parent folder.

Link copied to clipboard
inline suspend fun WorkDocsClient.createLabels(crossinline block: CreateLabelsRequest.Builder.() -> Unit): CreateLabelsResponse

Adds the specified list of labels to the given resource (a document or folder)

Link copied to clipboard
inline suspend fun WorkDocsClient.createNotificationSubscription(crossinline block: CreateNotificationSubscriptionRequest.Builder.() -> Unit): CreateNotificationSubscriptionResponse

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

Link copied to clipboard
inline suspend fun WorkDocsClient.createUser(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse

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.

Link copied to clipboard
inline suspend fun WorkDocsClient.deactivateUser(crossinline block: DeactivateUserRequest.Builder.() -> Unit): DeactivateUserResponse

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

Link copied to clipboard
inline suspend fun WorkDocsClient.deleteComment(crossinline block: DeleteCommentRequest.Builder.() -> Unit): DeleteCommentResponse

Deletes the specified comment from the document version.

Link copied to clipboard
inline suspend fun WorkDocsClient.deleteCustomMetadata(crossinline block: DeleteCustomMetadataRequest.Builder.() -> Unit): DeleteCustomMetadataResponse

Deletes custom metadata from the specified resource.

Link copied to clipboard
inline suspend fun WorkDocsClient.deleteDocument(crossinline block: DeleteDocumentRequest.Builder.() -> Unit): DeleteDocumentResponse

Permanently deletes the specified document and its associated metadata.

Link copied to clipboard
inline suspend fun WorkDocsClient.deleteDocumentVersion(crossinline block: DeleteDocumentVersionRequest.Builder.() -> Unit): DeleteDocumentVersionResponse

Deletes a specific version of a document.

Link copied to clipboard
inline suspend fun WorkDocsClient.deleteFolder(crossinline block: DeleteFolderRequest.Builder.() -> Unit): DeleteFolderResponse

Permanently deletes the specified folder and its contents.

Link copied to clipboard
inline suspend fun WorkDocsClient.deleteFolderContents(crossinline block: DeleteFolderContentsRequest.Builder.() -> Unit): DeleteFolderContentsResponse

Deletes the contents of the specified folder.

Link copied to clipboard
inline suspend fun WorkDocsClient.deleteLabels(crossinline block: DeleteLabelsRequest.Builder.() -> Unit): DeleteLabelsResponse

Deletes the specified list of labels from a resource.

Link copied to clipboard
inline suspend fun WorkDocsClient.deleteNotificationSubscription(crossinline block: DeleteNotificationSubscriptionRequest.Builder.() -> Unit): DeleteNotificationSubscriptionResponse

Deletes the specified subscription from the specified organization.

Link copied to clipboard
inline suspend fun WorkDocsClient.deleteUser(crossinline block: DeleteUserRequest.Builder.() -> Unit): DeleteUserResponse

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

Link copied to clipboard
inline suspend fun WorkDocsClient.describeActivities(crossinline block: DescribeActivitiesRequest.Builder.() -> Unit): DescribeActivitiesResponse

Describes the user activities in a specified time period.

Link copied to clipboard
inline suspend fun WorkDocsClient.describeComments(crossinline block: DescribeCommentsRequest.Builder.() -> Unit): DescribeCommentsResponse

List all the comments for the specified document version.

Link copied to clipboard
inline suspend fun WorkDocsClient.describeDocumentVersions(crossinline block: DescribeDocumentVersionsRequest.Builder.() -> Unit): DescribeDocumentVersionsResponse

Retrieves the document versions for the specified document.

Link copied to clipboard
inline suspend fun WorkDocsClient.describeFolderContents(crossinline block: DescribeFolderContentsRequest.Builder.() -> Unit): DescribeFolderContentsResponse

Describes the contents of the specified folder, including its documents and subfolders.

Link copied to clipboard
inline suspend fun WorkDocsClient.describeGroups(crossinline block: DescribeGroupsRequest.Builder.() -> Unit): DescribeGroupsResponse

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

Link copied to clipboard
inline suspend fun WorkDocsClient.describeNotificationSubscriptions(crossinline block: DescribeNotificationSubscriptionsRequest.Builder.() -> Unit): DescribeNotificationSubscriptionsResponse

Lists the specified notification subscriptions.

Link copied to clipboard
inline suspend fun WorkDocsClient.describeResourcePermissions(crossinline block: DescribeResourcePermissionsRequest.Builder.() -> Unit): DescribeResourcePermissionsResponse

Describes the permissions of a specified resource.

Link copied to clipboard
inline suspend fun WorkDocsClient.describeRootFolders(crossinline block: DescribeRootFoldersRequest.Builder.() -> Unit): DescribeRootFoldersResponse

Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

Link copied to clipboard
inline suspend fun WorkDocsClient.describeUsers(crossinline block: DescribeUsersRequest.Builder.() -> Unit): DescribeUsersResponse

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

Link copied to clipboard
inline suspend fun WorkDocsClient.getCurrentUser(crossinline block: GetCurrentUserRequest.Builder.() -> Unit): GetCurrentUserResponse

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.

Link copied to clipboard
inline suspend fun WorkDocsClient.getDocument(crossinline block: GetDocumentRequest.Builder.() -> Unit): GetDocumentResponse

Retrieves details of a document.

Link copied to clipboard
inline suspend fun WorkDocsClient.getDocumentPath(crossinline block: GetDocumentPathRequest.Builder.() -> Unit): GetDocumentPathResponse

Retrieves the path information (the hierarchy from the root folder) for the requested document.

Link copied to clipboard
inline suspend fun WorkDocsClient.getDocumentVersion(crossinline block: GetDocumentVersionRequest.Builder.() -> Unit): GetDocumentVersionResponse

Retrieves version metadata for the specified document.

Link copied to clipboard
inline suspend fun WorkDocsClient.getFolder(crossinline block: GetFolderRequest.Builder.() -> Unit): GetFolderResponse

Retrieves the metadata of the specified folder.

Link copied to clipboard
inline suspend fun WorkDocsClient.getFolderPath(crossinline block: GetFolderPathRequest.Builder.() -> Unit): GetFolderPathResponse

Retrieves the path information (the hierarchy from the root folder) for the specified folder.

Link copied to clipboard
inline suspend fun WorkDocsClient.getResources(crossinline block: GetResourcesRequest.Builder.() -> Unit): GetResourcesResponse

Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

Link copied to clipboard
inline suspend fun WorkDocsClient.initiateDocumentVersionUpload(crossinline block: InitiateDocumentVersionUploadRequest.Builder.() -> Unit): InitiateDocumentVersionUploadResponse

Creates a new document object and version object.

Link copied to clipboard
inline suspend fun WorkDocsClient.removeAllResourcePermissions(crossinline block: RemoveAllResourcePermissionsRequest.Builder.() -> Unit): RemoveAllResourcePermissionsResponse

Removes all the permissions from the specified resource.

Link copied to clipboard
inline suspend fun WorkDocsClient.removeResourcePermission(crossinline block: RemoveResourcePermissionRequest.Builder.() -> Unit): RemoveResourcePermissionResponse

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

Link copied to clipboard
inline suspend fun WorkDocsClient.restoreDocumentVersions(crossinline block: RestoreDocumentVersionsRequest.Builder.() -> Unit): RestoreDocumentVersionsResponse

Recovers a deleted version of an Amazon WorkDocs document.

Link copied to clipboard
inline suspend fun WorkDocsClient.searchResources(crossinline block: SearchResourcesRequest.Builder.() -> Unit): SearchResourcesResponse

Searches metadata and the content of folders, documents, document versions, and comments.

Link copied to clipboard
inline suspend fun WorkDocsClient.updateDocument(crossinline block: UpdateDocumentRequest.Builder.() -> Unit): UpdateDocumentResponse

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

Link copied to clipboard
inline suspend fun WorkDocsClient.updateDocumentVersion(crossinline block: UpdateDocumentVersionRequest.Builder.() -> Unit): UpdateDocumentVersionResponse

Changes the status of the document version to ACTIVE.

Link copied to clipboard
inline suspend fun WorkDocsClient.updateFolder(crossinline block: UpdateFolderRequest.Builder.() -> Unit): UpdateFolderResponse

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

Link copied to clipboard
inline suspend fun WorkDocsClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

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

Link copied to clipboard
fun WorkDocsClient.withConfig(block: WorkDocsClient.Config.Builder.() -> Unit): WorkDocsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.