WorkDocs#
Client#
- class WorkDocs.Client#
A low-level client representing Amazon WorkDocs
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.
Note
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.
client = session.create_client('workdocs')
These are the available methods:
- abort_document_version_upload
- activate_user
- add_resource_permissions
- can_paginate
- close
- create_comment
- create_custom_metadata
- create_folder
- create_labels
- create_notification_subscription
- create_user
- deactivate_user
- delete_comment
- delete_custom_metadata
- delete_document
- delete_document_version
- delete_folder
- delete_folder_contents
- delete_labels
- delete_notification_subscription
- delete_user
- describe_activities
- describe_comments
- describe_document_versions
- describe_folder_contents
- describe_groups
- describe_notification_subscriptions
- describe_resource_permissions
- describe_root_folders
- describe_users
- get_current_user
- get_document
- get_document_path
- get_document_version
- get_folder
- get_folder_path
- get_paginator
- get_resources
- get_waiter
- initiate_document_version_upload
- remove_all_resource_permissions
- remove_resource_permission
- restore_document_versions
- search_resources
- update_document
- update_document_version
- update_folder
- update_user
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- ConcurrentModificationException
- ConflictingOperationException
- CustomMetadataLimitExceededException
- DeactivatingLastSystemUserException
- DocumentLockedForCommentsException
- DraftUploadOutOfSyncException
- EntityAlreadyExistsException
- EntityNotExistsException
- FailedDependencyException
- IllegalUserStateException
- InvalidArgumentException
- InvalidCommentOperationException
- InvalidOperationException
- InvalidPasswordException
- LimitExceededException
- ProhibitedStateException
- RequestedEntityTooLargeException
- ResourceAlreadyCheckedOutException
- ServiceUnavailableException
- StorageLimitExceededException
- StorageLimitWillExceedException
- TooManyLabelsException
- TooManySubscriptionsException
- UnauthorizedOperationException
- UnauthorizedResourceAccessException
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: