Paws::WorkDocs - Perl Interface to AWS Amazon WorkDocs
use Paws; my $obj = Paws->service('WorkDocs'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], );
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-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 AWS 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 AWS 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 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.
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01
Each argument is described in detail in: Paws::WorkDocs::AbortDocumentVersionUpload
Returns: nothing
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.
Each argument is described in detail in: Paws::WorkDocs::ActivateUser
Returns: a Paws::WorkDocs::ActivateUserResponse instance
Activates the specified user. Only active users can access Amazon WorkDocs.
Each argument is described in detail in: Paws::WorkDocs::AddResourcePermissions
Returns: a Paws::WorkDocs::AddResourcePermissionsResponse instance
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
Each argument is described in detail in: Paws::WorkDocs::CreateComment
Returns: a Paws::WorkDocs::CreateCommentResponse instance
Adds a new comment to the specified document version.
Each argument is described in detail in: Paws::WorkDocs::CreateCustomMetadata
Returns: a Paws::WorkDocs::CreateCustomMetadataResponse instance
Adds one or more custom properties to the specified resource (a folder, document, or version).
Each argument is described in detail in: Paws::WorkDocs::CreateFolder
Returns: a Paws::WorkDocs::CreateFolderResponse instance
Creates a folder with the specified name and parent folder.
Each argument is described in detail in: Paws::WorkDocs::CreateLabels
Returns: a Paws::WorkDocs::CreateLabelsResponse instance
Adds the specified list of labels to the given resource (a document or folder)
Each argument is described in detail in: Paws::WorkDocs::CreateNotificationSubscription
Returns: a Paws::WorkDocs::CreateNotificationSubscriptionResponse instance
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 (https://docs.aws.amazon.com/workdocs/latest/developerguide/subscribe-notifications.html) in the Amazon WorkDocs Developer Guide.
Each argument is described in detail in: Paws::WorkDocs::CreateUser
Returns: a Paws::WorkDocs::CreateUserResponse instance
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.
Each argument is described in detail in: Paws::WorkDocs::DeactivateUser
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
Each argument is described in detail in: Paws::WorkDocs::DeleteComment
Deletes the specified comment from the document version.
Each argument is described in detail in: Paws::WorkDocs::DeleteCustomMetadata
Returns: a Paws::WorkDocs::DeleteCustomMetadataResponse instance
Deletes custom metadata from the specified resource.
Each argument is described in detail in: Paws::WorkDocs::DeleteDocument
Permanently deletes the specified document and its associated metadata.
Each argument is described in detail in: Paws::WorkDocs::DeleteFolder
Permanently deletes the specified folder and its contents.
Each argument is described in detail in: Paws::WorkDocs::DeleteFolderContents
Deletes the contents of the specified folder.
Each argument is described in detail in: Paws::WorkDocs::DeleteLabels
Returns: a Paws::WorkDocs::DeleteLabelsResponse instance
Deletes the specified list of labels from a resource.
Each argument is described in detail in: Paws::WorkDocs::DeleteNotificationSubscription
Deletes the specified subscription from the specified organization.
Each argument is described in detail in: Paws::WorkDocs::DeleteUser
Deletes the specified user from a Simple AD or Microsoft AD directory.
Each argument is described in detail in: Paws::WorkDocs::DescribeActivities
Returns: a Paws::WorkDocs::DescribeActivitiesResponse instance
Describes the user activities in a specified time period.
Each argument is described in detail in: Paws::WorkDocs::DescribeComments
Returns: a Paws::WorkDocs::DescribeCommentsResponse instance
List all the comments for the specified document version.
Each argument is described in detail in: Paws::WorkDocs::DescribeDocumentVersions
Returns: a Paws::WorkDocs::DescribeDocumentVersionsResponse instance
Retrieves the document versions for the specified document.
By default, only active versions are returned.
Each argument is described in detail in: Paws::WorkDocs::DescribeFolderContents
Returns: a Paws::WorkDocs::DescribeFolderContentsResponse instance
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.
Each argument is described in detail in: Paws::WorkDocs::DescribeGroups
Returns: a Paws::WorkDocs::DescribeGroupsResponse instance
Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
Each argument is described in detail in: Paws::WorkDocs::DescribeNotificationSubscriptions
Returns: a Paws::WorkDocs::DescribeNotificationSubscriptionsResponse instance
Lists the specified notification subscriptions.
Each argument is described in detail in: Paws::WorkDocs::DescribeResourcePermissions
Returns: a Paws::WorkDocs::DescribeResourcePermissionsResponse instance
Describes the permissions of a specified resource.
Each argument is described in detail in: Paws::WorkDocs::DescribeRootFolders
Returns: a Paws::WorkDocs::DescribeRootFoldersResponse instance
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.
RootFolder
RecycleBin
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 (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html) in the Amazon WorkDocs Developer Guide.
Each argument is described in detail in: Paws::WorkDocs::DescribeUsers
Returns: a Paws::WorkDocs::DescribeUsersResponse instance
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.
Each argument is described in detail in: Paws::WorkDocs::GetCurrentUser
Returns: a Paws::WorkDocs::GetCurrentUserResponse instance
Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.
Each argument is described in detail in: Paws::WorkDocs::GetDocument
Returns: a Paws::WorkDocs::GetDocumentResponse instance
Retrieves details of a document.
Each argument is described in detail in: Paws::WorkDocs::GetDocumentPath
Returns: a Paws::WorkDocs::GetDocumentPathResponse instance
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.
Each argument is described in detail in: Paws::WorkDocs::GetDocumentVersion
Returns: a Paws::WorkDocs::GetDocumentVersionResponse instance
Retrieves version metadata for the specified document.
Each argument is described in detail in: Paws::WorkDocs::GetFolder
Returns: a Paws::WorkDocs::GetFolderResponse instance
Retrieves the metadata of the specified folder.
Each argument is described in detail in: Paws::WorkDocs::GetFolderPath
Returns: a Paws::WorkDocs::GetFolderPathResponse instance
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.
Each argument is described in detail in: Paws::WorkDocs::GetResources
Returns: a Paws::WorkDocs::GetResourcesResponse instance
Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.
CollectionType
SHARED_WITH_ME
Each argument is described in detail in: Paws::WorkDocs::InitiateDocumentVersionUpload
Returns: a Paws::WorkDocs::InitiateDocumentVersionUploadResponse instance
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.
Each argument is described in detail in: Paws::WorkDocs::RemoveAllResourcePermissions
Removes all the permissions from the specified resource.
Each argument is described in detail in: Paws::WorkDocs::RemoveResourcePermission
Removes the permission for the specified principal from the specified resource.
Each argument is described in detail in: Paws::WorkDocs::UpdateDocument
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
Each argument is described in detail in: Paws::WorkDocs::UpdateDocumentVersion
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.
Each argument is described in detail in: Paws::WorkDocs::UpdateFolder
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
Each argument is described in detail in: Paws::WorkDocs::UpdateUser
Returns: a Paws::WorkDocs::UpdateUserResponse instance
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
Paginator methods are helpers that repetively call methods that return partial results
If passed a sub as first parameter, it will call the sub for each element found in :
- UserActivities, passing the object as the first parameter, and the string 'UserActivities' as the second parameter
If not, it will return a a Paws::WorkDocs::DescribeActivitiesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
param
- Comments, passing the object as the first parameter, and the string 'Comments' as the second parameter
If not, it will return a a Paws::WorkDocs::DescribeCommentsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- DocumentVersions, passing the object as the first parameter, and the string 'DocumentVersions' as the second parameter
If not, it will return a a Paws::WorkDocs::DescribeDocumentVersionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Folders, passing the object as the first parameter, and the string 'Folders' as the second parameter - Documents, passing the object as the first parameter, and the string 'Documents' as the second parameter
If not, it will return a a Paws::WorkDocs::DescribeFolderContentsResponse instance with all the params; andparams; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Groups, passing the object as the first parameter, and the string 'Groups' as the second parameter
If not, it will return a a Paws::WorkDocs::DescribeGroupsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Subscriptions, passing the object as the first parameter, and the string 'Subscriptions' as the second parameter
If not, it will return a a Paws::WorkDocs::DescribeNotificationSubscriptionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Principals, passing the object as the first parameter, and the string 'Principals' as the second parameter
If not, it will return a a Paws::WorkDocs::DescribeResourcePermissionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Folders, passing the object as the first parameter, and the string 'Folders' as the second parameter
If not, it will return a a Paws::WorkDocs::DescribeRootFoldersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- Users, passing the object as the first parameter, and the string 'Users' as the second parameter
If not, it will return a a Paws::WorkDocs::DescribeUsersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
This service class forms part of Paws
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.