Crate rusoto_workdocs [] [src]

The 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-premise or off-premise 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 anti-virus or data loss prevention. The APIs, in conjunction with Amazon CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs, so the application can take the necessary actions and replace the target file. The application can also choose to email the user if the target file violates the policy.

  • eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic and/or record the actions in an Amazon WorkDocs site, in conjunction with Amazon CloudTrails, to replicate data for eDiscovery, backup, or analytical applications.

All Amazon WorkDocs APIs are Amazon authenticated, certificate-signed APIs. They not only require the use of the AWS 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.

If you're using the service, you're probably looking for WorkdocsClient and Workdocs.

Structs

AbortDocumentVersionUploadRequest
ActivateUserRequest
ActivateUserResponse
Activity

Describes the activity information.

AddResourcePermissionsRequest
AddResourcePermissionsResponse
Comment

Describes a comment.

CommentMetadata

Describes the metadata of a comment.

CreateCommentRequest
CreateCommentResponse
CreateCustomMetadataRequest
CreateCustomMetadataResponse
CreateFolderRequest
CreateFolderResponse
CreateLabelsRequest
CreateLabelsResponse
CreateNotificationSubscriptionRequest
CreateNotificationSubscriptionResponse
CreateUserRequest
CreateUserResponse
DeactivateUserRequest
DeleteCommentRequest
DeleteCustomMetadataRequest
DeleteCustomMetadataResponse
DeleteDocumentRequest
DeleteFolderContentsRequest
DeleteFolderRequest
DeleteLabelsRequest
DeleteLabelsResponse
DeleteNotificationSubscriptionRequest
DeleteUserRequest
DescribeActivitiesRequest
DescribeActivitiesResponse
DescribeCommentsRequest
DescribeCommentsResponse
DescribeDocumentVersionsRequest
DescribeDocumentVersionsResponse
DescribeFolderContentsRequest
DescribeFolderContentsResponse
DescribeNotificationSubscriptionsRequest
DescribeNotificationSubscriptionsResponse
DescribeResourcePermissionsRequest
DescribeResourcePermissionsResponse
DescribeRootFoldersRequest
DescribeRootFoldersResponse
DescribeUsersRequest
DescribeUsersResponse
DocumentMetadata

Describes the document.

DocumentVersionMetadata

Describes a version of a document.

FolderMetadata

Describes a folder.

GetCurrentUserRequest
GetCurrentUserResponse
GetDocumentPathRequest
GetDocumentPathResponse
GetDocumentRequest
GetDocumentResponse
GetDocumentVersionRequest
GetDocumentVersionResponse
GetFolderPathRequest
GetFolderPathResponse
GetFolderRequest
GetFolderResponse
GroupMetadata

Describes the metadata of a user group.

InitiateDocumentVersionUploadRequest
InitiateDocumentVersionUploadResponse
Participants

Describes the users and/or user groups.

PermissionInfo

Describes the permissions.

Principal

Describes a resource.

RemoveAllResourcePermissionsRequest
RemoveResourcePermissionRequest
ResourceMetadata

Describes the metadata of a resource.

ResourcePath

Describes the path information of a resource.

ResourcePathComponent

Describes the resource path.

SharePrincipal

Describes the recipient type and ID, if available.

ShareResult

Describes the share results of a resource.

StorageRuleType

Describes the storage for a user.

Subscription

Describes a subscription.

UpdateDocumentRequest
UpdateDocumentVersionRequest
UpdateFolderRequest
UpdateUserRequest
UpdateUserResponse
UploadMetadata

Describes the upload.

User

Describes a user.

UserMetadata

Describes the metadata of the user.

UserStorageMetadata

Describes the storage for a user.

WorkdocsClient

A client for the Amazon WorkDocs API.

Enums

AbortDocumentVersionUploadError

Errors returned by AbortDocumentVersionUpload

ActivateUserError

Errors returned by ActivateUser

AddResourcePermissionsError

Errors returned by AddResourcePermissions

CreateCommentError

Errors returned by CreateComment

CreateCustomMetadataError

Errors returned by CreateCustomMetadata

CreateFolderError

Errors returned by CreateFolder

CreateLabelsError

Errors returned by CreateLabels

CreateNotificationSubscriptionError

Errors returned by CreateNotificationSubscription

CreateUserError

Errors returned by CreateUser

DeactivateUserError

Errors returned by DeactivateUser

DeleteCommentError

Errors returned by DeleteComment

DeleteCustomMetadataError

Errors returned by DeleteCustomMetadata

DeleteDocumentError

Errors returned by DeleteDocument

DeleteFolderContentsError

Errors returned by DeleteFolderContents

DeleteFolderError

Errors returned by DeleteFolder

DeleteLabelsError

Errors returned by DeleteLabels

DeleteNotificationSubscriptionError

Errors returned by DeleteNotificationSubscription

DeleteUserError

Errors returned by DeleteUser

DescribeActivitiesError

Errors returned by DescribeActivities

DescribeCommentsError

Errors returned by DescribeComments

DescribeDocumentVersionsError

Errors returned by DescribeDocumentVersions

DescribeFolderContentsError

Errors returned by DescribeFolderContents

DescribeNotificationSubscriptionsError

Errors returned by DescribeNotificationSubscriptions

DescribeResourcePermissionsError

Errors returned by DescribeResourcePermissions

DescribeRootFoldersError

Errors returned by DescribeRootFolders

DescribeUsersError

Errors returned by DescribeUsers

GetCurrentUserError

Errors returned by GetCurrentUser

GetDocumentError

Errors returned by GetDocument

GetDocumentPathError

Errors returned by GetDocumentPath

GetDocumentVersionError

Errors returned by GetDocumentVersion

GetFolderError

Errors returned by GetFolder

GetFolderPathError

Errors returned by GetFolderPath

InitiateDocumentVersionUploadError

Errors returned by InitiateDocumentVersionUpload

RemoveAllResourcePermissionsError

Errors returned by RemoveAllResourcePermissions

RemoveResourcePermissionError

Errors returned by RemoveResourcePermission

UpdateDocumentError

Errors returned by UpdateDocument

UpdateDocumentVersionError

Errors returned by UpdateDocumentVersion

UpdateFolderError

Errors returned by UpdateFolder

UpdateUserError

Errors returned by UpdateUser

Traits

Workdocs

Trait representing the capabilities of the Amazon WorkDocs API. Amazon WorkDocs clients implement this trait.