Struct WorkdocsClient

pub struct WorkdocsClient { /* private fields */ }

A client for the Amazon WorkDocs API.

Implementations

impl WorkdocsClient

pub fn new(region: Region) -> WorkdocsClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>( request_dispatcher: D, credentials_provider: P, region: Region, ) -> WorkdocsClient

where P: ProvideAwsCredentials + Send + Sync + 'static, D: DispatchSignedRequest + Send + Sync + 'static,

pub fn new_with_client(client: Client, region: Region) -> WorkdocsClient

Trait Implementations

impl Clone for WorkdocsClient

fn clone(&self) -> WorkdocsClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Workdocs for WorkdocsClient

fn abort_document_version_upload<'life0, 'async_trait>( &'life0 self, input: AbortDocumentVersionUploadRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AbortDocumentVersionUploadError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn activate_user<'life0, 'async_trait>( &'life0 self, input: ActivateUserRequest, ) -> Pin<Box<dyn Future<Output = Result<ActivateUserResponse, RusotoError<ActivateUserError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn add_resource_permissions<'life0, 'async_trait>( &'life0 self, input: AddResourcePermissionsRequest, ) -> Pin<Box<dyn Future<Output = Result<AddResourcePermissionsResponse, RusotoError<AddResourcePermissionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn create_comment<'life0, 'async_trait>( &'life0 self, input: CreateCommentRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateCommentResponse, RusotoError<CreateCommentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds a new comment to the specified document version.

fn create_custom_metadata<'life0, 'async_trait>( &'life0 self, input: CreateCustomMetadataRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateCustomMetadataResponse, RusotoError<CreateCustomMetadataError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn create_folder<'life0, 'async_trait>( &'life0 self, input: CreateFolderRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateFolderResponse, RusotoError<CreateFolderError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a folder with the specified name and parent folder.

fn create_labels<'life0, 'async_trait>( &'life0 self, input: CreateLabelsRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateLabelsResponse, RusotoError<CreateLabelsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn create_notification_subscription<'life0, 'async_trait>( &'life0 self, input: CreateNotificationSubscriptionRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateNotificationSubscriptionResponse, RusotoError<CreateNotificationSubscriptionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide.

fn create_user<'life0, 'async_trait>( &'life0 self, input: CreateUserRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateUserResponse, RusotoError<CreateUserError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn deactivate_user<'life0, 'async_trait>( &'life0 self, input: DeactivateUserRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeactivateUserError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn delete_comment<'life0, 'async_trait>( &'life0 self, input: DeleteCommentRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteCommentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes the specified comment from the document version.

fn delete_custom_metadata<'life0, 'async_trait>( &'life0 self, input: DeleteCustomMetadataRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteCustomMetadataResponse, RusotoError<DeleteCustomMetadataError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes custom metadata from the specified resource.

fn delete_document<'life0, 'async_trait>( &'life0 self, input: DeleteDocumentRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteDocumentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Permanently deletes the specified document and its associated metadata.

fn delete_folder<'life0, 'async_trait>( &'life0 self, input: DeleteFolderRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteFolderError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Permanently deletes the specified folder and its contents.

fn delete_folder_contents<'life0, 'async_trait>( &'life0 self, input: DeleteFolderContentsRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteFolderContentsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes the contents of the specified folder.

fn delete_labels<'life0, 'async_trait>( &'life0 self, input: DeleteLabelsRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteLabelsResponse, RusotoError<DeleteLabelsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes the specified list of labels from a resource.

fn delete_notification_subscription<'life0, 'async_trait>( &'life0 self, input: DeleteNotificationSubscriptionRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteNotificationSubscriptionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes the specified subscription from the specified organization.

fn delete_user<'life0, 'async_trait>( &'life0 self, input: DeleteUserRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteUserError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn describe_activities<'life0, 'async_trait>( &'life0 self, input: DescribeActivitiesRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeActivitiesResponse, RusotoError<DescribeActivitiesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Describes the user activities in a specified time period.

fn describe_comments<'life0, 'async_trait>( &'life0 self, input: DescribeCommentsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeCommentsResponse, RusotoError<DescribeCommentsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List all the comments for the specified document version.

fn describe_document_versions<'life0, 'async_trait>( &'life0 self, input: DescribeDocumentVersionsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeDocumentVersionsResponse, RusotoError<DescribeDocumentVersionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the document versions for the specified document.

By default, only active versions are returned.

fn describe_folder_contents<'life0, 'async_trait>( &'life0 self, input: DescribeFolderContentsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeFolderContentsResponse, RusotoError<DescribeFolderContentsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn describe_groups<'life0, 'async_trait>( &'life0 self, input: DescribeGroupsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeGroupsResponse, RusotoError<DescribeGroupsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn describe_notification_subscriptions<'life0, 'async_trait>( &'life0 self, input: DescribeNotificationSubscriptionsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeNotificationSubscriptionsResponse, RusotoError<DescribeNotificationSubscriptionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lists the specified notification subscriptions.

fn describe_resource_permissions<'life0, 'async_trait>( &'life0 self, input: DescribeResourcePermissionsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeResourcePermissionsResponse, RusotoError<DescribeResourcePermissionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Describes the permissions of a specified resource.

fn describe_root_folders<'life0, 'async_trait>( &'life0 self, input: DescribeRootFoldersRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeRootFoldersResponse, RusotoError<DescribeRootFoldersError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

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.

fn describe_users<'life0, 'async_trait>( &'life0 self, input: DescribeUsersRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeUsersResponse, RusotoError<DescribeUsersError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn get_current_user<'life0, 'async_trait>( &'life0 self, input: GetCurrentUserRequest, ) -> Pin<Box<dyn Future<Output = Result<GetCurrentUserResponse, RusotoError<GetCurrentUserError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn get_document<'life0, 'async_trait>( &'life0 self, input: GetDocumentRequest, ) -> Pin<Box<dyn Future<Output = Result<GetDocumentResponse, RusotoError<GetDocumentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves details of a document.

fn get_document_path<'life0, 'async_trait>( &'life0 self, input: GetDocumentPathRequest, ) -> Pin<Box<dyn Future<Output = Result<GetDocumentPathResponse, RusotoError<GetDocumentPathError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn get_document_version<'life0, 'async_trait>( &'life0 self, input: GetDocumentVersionRequest, ) -> Pin<Box<dyn Future<Output = Result<GetDocumentVersionResponse, RusotoError<GetDocumentVersionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves version metadata for the specified document.

fn get_folder<'life0, 'async_trait>( &'life0 self, input: GetFolderRequest, ) -> Pin<Box<dyn Future<Output = Result<GetFolderResponse, RusotoError<GetFolderError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the metadata of the specified folder.

fn get_folder_path<'life0, 'async_trait>( &'life0 self, input: GetFolderPathRequest, ) -> Pin<Box<dyn Future<Output = Result<GetFolderPathResponse, RusotoError<GetFolderPathError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn get_resources<'life0, 'async_trait>( &'life0 self, input: GetResourcesRequest, ) -> Pin<Box<dyn Future<Output = Result<GetResourcesResponse, RusotoError<GetResourcesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn initiate_document_version_upload<'life0, 'async_trait>( &'life0 self, input: InitiateDocumentVersionUploadRequest, ) -> Pin<Box<dyn Future<Output = Result<InitiateDocumentVersionUploadResponse, RusotoError<InitiateDocumentVersionUploadError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn remove_all_resource_permissions<'life0, 'async_trait>( &'life0 self, input: RemoveAllResourcePermissionsRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<RemoveAllResourcePermissionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Removes all the permissions from the specified resource.

fn remove_resource_permission<'life0, 'async_trait>( &'life0 self, input: RemoveResourcePermissionRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<RemoveResourcePermissionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn update_document<'life0, 'async_trait>( &'life0 self, input: UpdateDocumentRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateDocumentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn update_document_version<'life0, 'async_trait>( &'life0 self, input: UpdateDocumentVersionRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateDocumentVersionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn update_folder<'life0, 'async_trait>( &'life0 self, input: UpdateFolderRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateFolderError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn update_user<'life0, 'async_trait>( &'life0 self, input: UpdateUserRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateUserResponse, RusotoError<UpdateUserError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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