WorkDocs ¶

Table of Contents

WorkDocs
- Client
- Paginators

Client ¶

class WorkDocs.Client¶

A low-level client representing Amazon WorkDocs

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.

import boto3

client = boto3.client('workdocs')

These are the available methods:

abort_document_version_upload()
activate_user()
add_resource_permissions()
can_paginate()
create_comment()
create_custom_metadata()
create_folder()
create_labels()
create_notification_subscription()
create_user()
deactivate_user()
delete_comment()
delete_custom_metadata()
delete_document()
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()
update_document()
update_document_version()
update_folder()
update_user()

abort_document_version_upload(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.abort_document_version_upload(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
VersionId (string) --
[REQUIRED]

The ID of the version.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

activate_user(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.activate_user(
    UserId='string',
    AuthenticationToken='string'
)

Parameters

UserId (string) --
[REQUIRED]

The ID of the user.
AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Return type

dict

Returns

Response Syntax

{
    'User': {
        'Id': 'string',
        'Username': 'string',
        'EmailAddress': 'string',
        'GivenName': 'string',
        'Surname': 'string',
        'OrganizationId': 'string',
        'RootFolderId': 'string',
        'RecycleBinFolderId': 'string',
        'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
        'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'TimeZoneId': 'string',
        'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
        'Storage': {
            'StorageUtilizedInBytes': 123,
            'StorageRule': {
                'StorageAllocatedInBytes': 123,
                'StorageType': 'UNLIMITED'|'QUOTA'
            }
        }
    }
}

Response Structure

(dict) --
- User (dict) --
  
  The user information.
  - Id (string) --
    
    The ID of the user.
  - Username (string) --
    
    The login name of the user.
  - EmailAddress (string) --
    
    The email address of the user.
  - GivenName (string) --
    
    The given name of the user.
  - Surname (string) --
    
    The surname of the user.
  - OrganizationId (string) --
    
    The ID of the organization.
  - RootFolderId (string) --
    
    The ID of the root folder.
  - RecycleBinFolderId (string) --
    
    The ID of the recycle bin folder.
  - Status (string) --
    
    The status of the user.
  - Type (string) --
    
    The type of user.
  - CreatedTimestamp (datetime) --
    
    The time when the user was created.
  - ModifiedTimestamp (datetime) --
    
    The time when the user was modified.
  - TimeZoneId (string) --
    
    The time zone ID of the user.
  - Locale (string) --
    
    The locale of the user.
  - Storage (dict) --
    
    The storage for the user.
    - StorageUtilizedInBytes (integer) --
      
      The amount of storage used, in bytes.
    - StorageRule (dict) --
      
      The storage for a user.
      - StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
      - StorageType (string) --
        
        The type of storage.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

add_resource_permissions(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.add_resource_permissions(
    AuthenticationToken='string',
    ResourceId='string',
    Principals=[
        {
            'Id': 'string',
            'Type': 'USER'|'GROUP'|'INVITE'|'ANONYMOUS'|'ORGANIZATION',
            'Role': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'COOWNER'
        },
    ],
    NotificationOptions={
        'SendEmail': True|False,
        'EmailMessage': 'string'
    }
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
ResourceId (string) --
[REQUIRED]

The ID of the resource.
Principals (list) --
[REQUIRED]

The users, groups, or organization being granted permission.
- (dict) --
  Describes the recipient type and ID, if available.
  - Id (string) -- [REQUIRED]
    The ID of the recipient.
  - Type (string) -- [REQUIRED]
    The type of the recipient.
  - Role (string) -- [REQUIRED]
    The role of the recipient.
NotificationOptions (dict) --
The notification options.
- SendEmail (boolean) --
  Boolean value to indicate an email notification should be sent to the receipients.
- EmailMessage (string) --
  Text value to be included in the email body.

Return type

dict

Returns

Response Syntax

{
    'ShareResults': [
        {
            'PrincipalId': 'string',
            'InviteePrincipalId': 'string',
            'Role': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'COOWNER',
            'Status': 'SUCCESS'|'FAILURE',
            'ShareId': 'string',
            'StatusMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- ShareResults (list) --
  
  The share results.
  - (dict) --
    
    Describes the share results of a resource.
    - PrincipalId (string) --
      
      The ID of the principal.
    - InviteePrincipalId (string) --
      
      The ID of the invited user.
    - Role (string) --
      
      The role.
    - Status (string) --
      
      The status.
    - ShareId (string) --
      
      The ID of the resource that was shared.
    - StatusMessage (string) --
      
      The status message.

Exceptions

WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

create_comment(**kwargs)¶

Adds a new comment to the specified document version.

See also: AWS API Documentation

Request Syntax

response = client.create_comment(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string',
    ParentId='string',
    ThreadId='string',
    Text='string',
    Visibility='PUBLIC'|'PRIVATE',
    NotifyCollaborators=True|False
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
VersionId (string) --
[REQUIRED]

The ID of the document version.
ParentId (string) -- The ID of the parent comment.
ThreadId (string) -- The ID of the root comment in the thread.
Text (string) --
[REQUIRED]

The text of the comment.
Visibility (string) -- The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
NotifyCollaborators (boolean) -- Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

Return type

dict

Returns

Response Syntax

{
    'Comment': {
        'CommentId': 'string',
        'ParentId': 'string',
        'ThreadId': 'string',
        'Text': 'string',
        'Contributor': {
            'Id': 'string',
            'Username': 'string',
            'EmailAddress': 'string',
            'GivenName': 'string',
            'Surname': 'string',
            'OrganizationId': 'string',
            'RootFolderId': 'string',
            'RecycleBinFolderId': 'string',
            'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
            'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'TimeZoneId': 'string',
            'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
            'Storage': {
                'StorageUtilizedInBytes': 123,
                'StorageRule': {
                    'StorageAllocatedInBytes': 123,
                    'StorageType': 'UNLIMITED'|'QUOTA'
                }
            }
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'Status': 'DRAFT'|'PUBLISHED'|'DELETED',
        'Visibility': 'PUBLIC'|'PRIVATE',
        'RecipientId': 'string'
    }
}

Response Structure

(dict) --
- Comment (dict) --
  
  The comment that has been created.
  - CommentId (string) --
    
    The ID of the comment.
  - ParentId (string) --
    
    The ID of the parent comment.
  - ThreadId (string) --
    
    The ID of the root comment in the thread.
  - Text (string) --
    
    The text of the comment.
  - Contributor (dict) --
    
    The details of the user who made the comment.
    - Id (string) --
      
      The ID of the user.
    - Username (string) --
      
      The login name of the user.
    - EmailAddress (string) --
      
      The email address of the user.
    - GivenName (string) --
      
      The given name of the user.
    - Surname (string) --
      
      The surname of the user.
    - OrganizationId (string) --
      
      The ID of the organization.
    - RootFolderId (string) --
      
      The ID of the root folder.
    - RecycleBinFolderId (string) --
      
      The ID of the recycle bin folder.
    - Status (string) --
      
      The status of the user.
    - Type (string) --
      
      The type of user.
    - CreatedTimestamp (datetime) --
      
      The time when the user was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the user was modified.
    - TimeZoneId (string) --
      
      The time zone ID of the user.
    - Locale (string) --
      
      The locale of the user.
    - Storage (dict) --
      
      The storage for the user.
      - StorageUtilizedInBytes (integer) --
        
        The amount of storage used, in bytes.
      - StorageRule (dict) --
        
        The storage for a user.
        
        StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
        
        StorageType (string) --
        
        The type of storage.
  - CreatedTimestamp (datetime) --
    
    The time that the comment was created.
  - Status (string) --
    
    The status of the comment.
  - Visibility (string) --
    
    The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
  - RecipientId (string) --
    
    If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.DocumentLockedForCommentsException
WorkDocs.Client.exceptions.InvalidCommentOperationException

create_custom_metadata(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.create_custom_metadata(
    AuthenticationToken='string',
    ResourceId='string',
    VersionId='string',
    CustomMetadata={
        'string': 'string'
    }
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
ResourceId (string) --
[REQUIRED]

The ID of the resource.
VersionId (string) -- The ID of the version, if the custom metadata is being added to a document version.
CustomMetadata (dict) --
[REQUIRED]

Custom metadata in the form of name-value pairs.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.CustomMetadataLimitExceededException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

create_folder(**kwargs)¶

Creates a folder with the specified name and parent folder.

See also: AWS API Documentation

Request Syntax

response = client.create_folder(
    AuthenticationToken='string',
    Name='string',
    ParentFolderId='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
Name (string) -- The name of the new folder.
ParentFolderId (string) --
[REQUIRED]

The ID of the parent folder.

Return type

dict

Returns

Response Syntax

{
    'Metadata': {
        'Id': 'string',
        'Name': 'string',
        'CreatorId': 'string',
        'ParentFolderId': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
        'Signature': 'string',
        'Labels': [
            'string',
        ],
        'Size': 123,
        'LatestVersionSize': 123
    }
}

Response Structure

(dict) --
- Metadata (dict) --
  
  The metadata of the folder.
  - Id (string) --
    
    The ID of the folder.
  - Name (string) --
    
    The name of the folder.
  - CreatorId (string) --
    
    The ID of the creator.
  - ParentFolderId (string) --
    
    The ID of the parent folder.
  - CreatedTimestamp (datetime) --
    
    The time when the folder was created.
  - ModifiedTimestamp (datetime) --
    
    The time when the folder was updated.
  - ResourceState (string) --
    
    The resource state of the folder.
  - Signature (string) --
    
    The unique identifier created from the subfolders and documents of the folder.
  - Labels (list) --
    
    List of labels on the folder.
    - (string) --
  - Size (integer) --
    
    The size of the folder metadata.
  - LatestVersionSize (integer) --
    
    The size of the latest version of the folder metadata.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.EntityAlreadyExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.ConflictingOperationException
WorkDocs.Client.exceptions.LimitExceededException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

create_labels(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.create_labels(
    ResourceId='string',
    Labels=[
        'string',
    ],
    AuthenticationToken='string'
)

Parameters

ResourceId (string) --
[REQUIRED]

The ID of the resource.
Labels (list) --
[REQUIRED]

List of labels to add to the resource.
- (string) --
AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.TooManyLabelsException

create_notification_subscription(**kwargs)¶

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 .

See also: AWS API Documentation

Request Syntax

response = client.create_notification_subscription(
    OrganizationId='string',
    Endpoint='string',
    Protocol='HTTPS',
    SubscriptionType='ALL'
)

Parameters

OrganizationId (string) --
[REQUIRED]

The ID of the organization.
Endpoint (string) --
[REQUIRED]

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https .
Protocol (string) --
[REQUIRED]

The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.
SubscriptionType (string) --
[REQUIRED]

The notification type.

Return type

dict

Returns

Response Syntax

{
    'Subscription': {
        'SubscriptionId': 'string',
        'EndPoint': 'string',
        'Protocol': 'HTTPS'
    }
}

Response Structure

(dict) --
- Subscription (dict) --
  
  The subscription.
  - SubscriptionId (string) --
    
    The ID of the subscription.
  - EndPoint (string) --
    
    The endpoint of the subscription.
  - Protocol (string) --
    
    The protocol of the subscription.

Exceptions

WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.TooManySubscriptionsException
WorkDocs.Client.exceptions.ServiceUnavailableException

create_user(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    OrganizationId='string',
    Username='string',
    EmailAddress='string',
    GivenName='string',
    Surname='string',
    Password='string',
    TimeZoneId='string',
    StorageRule={
        'StorageAllocatedInBytes': 123,
        'StorageType': 'UNLIMITED'|'QUOTA'
    },
    AuthenticationToken='string'
)

Parameters

OrganizationId (string) -- The ID of the organization.
Username (string) --
[REQUIRED]

The login name of the user.
EmailAddress (string) -- The email address of the user.
GivenName (string) --
[REQUIRED]

The given name of the user.
Surname (string) --
[REQUIRED]

The surname of the user.
Password (string) --
[REQUIRED]

The password of the user.
TimeZoneId (string) -- The time zone ID of the user.
StorageRule (dict) --
The amount of storage for the user.
- StorageAllocatedInBytes (integer) --
  The amount of storage allocated, in bytes.
- StorageType (string) --
  The type of storage.
AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Return type

dict

Returns

Response Syntax

{
    'User': {
        'Id': 'string',
        'Username': 'string',
        'EmailAddress': 'string',
        'GivenName': 'string',
        'Surname': 'string',
        'OrganizationId': 'string',
        'RootFolderId': 'string',
        'RecycleBinFolderId': 'string',
        'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
        'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'TimeZoneId': 'string',
        'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
        'Storage': {
            'StorageUtilizedInBytes': 123,
            'StorageRule': {
                'StorageAllocatedInBytes': 123,
                'StorageType': 'UNLIMITED'|'QUOTA'
            }
        }
    }
}

Response Structure

(dict) --
- User (dict) --
  
  The user information.
  - Id (string) --
    
    The ID of the user.
  - Username (string) --
    
    The login name of the user.
  - EmailAddress (string) --
    
    The email address of the user.
  - GivenName (string) --
    
    The given name of the user.
  - Surname (string) --
    
    The surname of the user.
  - OrganizationId (string) --
    
    The ID of the organization.
  - RootFolderId (string) --
    
    The ID of the root folder.
  - RecycleBinFolderId (string) --
    
    The ID of the recycle bin folder.
  - Status (string) --
    
    The status of the user.
  - Type (string) --
    
    The type of user.
  - CreatedTimestamp (datetime) --
    
    The time when the user was created.
  - ModifiedTimestamp (datetime) --
    
    The time when the user was modified.
  - TimeZoneId (string) --
    
    The time zone ID of the user.
  - Locale (string) --
    
    The locale of the user.
  - Storage (dict) --
    
    The storage for the user.
    - StorageUtilizedInBytes (integer) --
      
      The amount of storage used, in bytes.
    - StorageRule (dict) --
      
      The storage for a user.
      - StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
      - StorageType (string) --
        
        The type of storage.

Exceptions

WorkDocs.Client.exceptions.EntityAlreadyExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

deactivate_user(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.deactivate_user(
    UserId='string',
    AuthenticationToken='string'
)

Parameters

UserId (string) --
[REQUIRED]

The ID of the user.
AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

delete_comment(**kwargs)¶

Deletes the specified comment from the document version.

See also: AWS API Documentation

Request Syntax

response = client.delete_comment(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string',
    CommentId='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
VersionId (string) --
[REQUIRED]

The ID of the document version.
CommentId (string) --
[REQUIRED]

The ID of the comment.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.DocumentLockedForCommentsException

delete_custom_metadata(**kwargs)¶

Deletes custom metadata from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_custom_metadata(
    AuthenticationToken='string',
    ResourceId='string',
    VersionId='string',
    Keys=[
        'string',
    ],
    DeleteAll=True|False
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
ResourceId (string) --
[REQUIRED]

The ID of the resource, either a document or folder.
VersionId (string) -- The ID of the version, if the custom metadata is being deleted from a document version.
Keys (list) --
List of properties to remove.
- (string) --
DeleteAll (boolean) -- Flag to indicate removal of all custom metadata properties from the specified resource.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

delete_document(**kwargs)¶

Permanently deletes the specified document and its associated metadata.

See also: AWS API Documentation

Request Syntax

response = client.delete_document(
    AuthenticationToken='string',
    DocumentId='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.ConflictingOperationException
WorkDocs.Client.exceptions.ConcurrentModificationException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

delete_folder(**kwargs)¶

Permanently deletes the specified folder and its contents.

See also: AWS API Documentation

Request Syntax

response = client.delete_folder(
    AuthenticationToken='string',
    FolderId='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
FolderId (string) --
[REQUIRED]

The ID of the folder.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.ConflictingOperationException
WorkDocs.Client.exceptions.ConcurrentModificationException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

delete_folder_contents(**kwargs)¶

Deletes the contents of the specified folder.

See also: AWS API Documentation

Request Syntax

response = client.delete_folder_contents(
    AuthenticationToken='string',
    FolderId='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
FolderId (string) --
[REQUIRED]

The ID of the folder.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.ConflictingOperationException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

delete_labels(**kwargs)¶

Deletes the specified list of labels from a resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_labels(
    ResourceId='string',
    AuthenticationToken='string',
    Labels=[
        'string',
    ],
    DeleteAll=True|False
)

Parameters

ResourceId (string) --
[REQUIRED]

The ID of the resource.
AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
Labels (list) --
List of labels to delete from the resource.
- (string) --
DeleteAll (boolean) -- Flag to request removal of all labels from the specified resource.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

delete_notification_subscription(**kwargs)¶

Deletes the specified subscription from the specified organization.

See also: AWS API Documentation

Request Syntax

response = client.delete_notification_subscription(
    SubscriptionId='string',
    OrganizationId='string'
)

Parameters

SubscriptionId (string) --
[REQUIRED]

The ID of the subscription.
OrganizationId (string) --
[REQUIRED]

The ID of the organization.

Returns

None

Exceptions

WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.ProhibitedStateException

delete_user(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    AuthenticationToken='string',
    UserId='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
UserId (string) --
[REQUIRED]

The ID of the user.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

describe_activities(**kwargs)¶

Describes the user activities in a specified time period.

See also: AWS API Documentation

Request Syntax

response = client.describe_activities(
    AuthenticationToken='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    OrganizationId='string',
    ActivityTypes='string',
    ResourceId='string',
    UserId='string',
    IncludeIndirectActivities=True|False,
    Limit=123,
    Marker='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
StartTime (datetime) -- The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
EndTime (datetime) -- The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
OrganizationId (string) -- The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
ActivityTypes (string) -- Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
ResourceId (string) -- The document or folder ID for which to describe activity types.
UserId (string) -- The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.
IncludeIndirectActivities (boolean) -- Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).
Limit (integer) -- The maximum number of items to return.
Marker (string) -- The marker for the next set of results.

Return type

dict

Returns

Response Syntax

{
    'UserActivities': [
        {
            'Type': 'DOCUMENT_CHECKED_IN'|'DOCUMENT_CHECKED_OUT'|'DOCUMENT_RENAMED'|'DOCUMENT_VERSION_UPLOADED'|'DOCUMENT_VERSION_DELETED'|'DOCUMENT_VERSION_VIEWED'|'DOCUMENT_VERSION_DOWNLOADED'|'DOCUMENT_RECYCLED'|'DOCUMENT_RESTORED'|'DOCUMENT_REVERTED'|'DOCUMENT_SHARED'|'DOCUMENT_UNSHARED'|'DOCUMENT_SHARE_PERMISSION_CHANGED'|'DOCUMENT_SHAREABLE_LINK_CREATED'|'DOCUMENT_SHAREABLE_LINK_REMOVED'|'DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED'|'DOCUMENT_MOVED'|'DOCUMENT_COMMENT_ADDED'|'DOCUMENT_COMMENT_DELETED'|'DOCUMENT_ANNOTATION_ADDED'|'DOCUMENT_ANNOTATION_DELETED'|'FOLDER_CREATED'|'FOLDER_DELETED'|'FOLDER_RENAMED'|'FOLDER_RECYCLED'|'FOLDER_RESTORED'|'FOLDER_SHARED'|'FOLDER_UNSHARED'|'FOLDER_SHARE_PERMISSION_CHANGED'|'FOLDER_SHAREABLE_LINK_CREATED'|'FOLDER_SHAREABLE_LINK_REMOVED'|'FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED'|'FOLDER_MOVED',
            'TimeStamp': datetime(2015, 1, 1),
            'IsIndirectActivity': True|False,
            'OrganizationId': 'string',
            'Initiator': {
                'Id': 'string',
                'Username': 'string',
                'GivenName': 'string',
                'Surname': 'string',
                'EmailAddress': 'string'
            },
            'Participants': {
                'Users': [
                    {
                        'Id': 'string',
                        'Username': 'string',
                        'GivenName': 'string',
                        'Surname': 'string',
                        'EmailAddress': 'string'
                    },
                ],
                'Groups': [
                    {
                        'Id': 'string',
                        'Name': 'string'
                    },
                ]
            },
            'ResourceMetadata': {
                'Type': 'FOLDER'|'DOCUMENT',
                'Name': 'string',
                'OriginalName': 'string',
                'Id': 'string',
                'VersionId': 'string',
                'Owner': {
                    'Id': 'string',
                    'Username': 'string',
                    'GivenName': 'string',
                    'Surname': 'string',
                    'EmailAddress': 'string'
                },
                'ParentId': 'string'
            },
            'OriginalParent': {
                'Type': 'FOLDER'|'DOCUMENT',
                'Name': 'string',
                'OriginalName': 'string',
                'Id': 'string',
                'VersionId': 'string',
                'Owner': {
                    'Id': 'string',
                    'Username': 'string',
                    'GivenName': 'string',
                    'Surname': 'string',
                    'EmailAddress': 'string'
                },
                'ParentId': 'string'
            },
            'CommentMetadata': {
                'CommentId': 'string',
                'Contributor': {
                    'Id': 'string',
                    'Username': 'string',
                    'EmailAddress': 'string',
                    'GivenName': 'string',
                    'Surname': 'string',
                    'OrganizationId': 'string',
                    'RootFolderId': 'string',
                    'RecycleBinFolderId': 'string',
                    'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
                    'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
                    'CreatedTimestamp': datetime(2015, 1, 1),
                    'ModifiedTimestamp': datetime(2015, 1, 1),
                    'TimeZoneId': 'string',
                    'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
                    'Storage': {
                        'StorageUtilizedInBytes': 123,
                        'StorageRule': {
                            'StorageAllocatedInBytes': 123,
                            'StorageType': 'UNLIMITED'|'QUOTA'
                        }
                    }
                },
                'CreatedTimestamp': datetime(2015, 1, 1),
                'CommentStatus': 'DRAFT'|'PUBLISHED'|'DELETED',
                'RecipientId': 'string'
            }
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- UserActivities (list) --
  
  The list of activities for the specified user and time period.
  - (dict) --
    
    Describes the activity information.
    - Type (string) --
      
      The activity type.
    - TimeStamp (datetime) --
      
      The timestamp when the action was performed.
    - IsIndirectActivity (boolean) --
      
      Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).
    - OrganizationId (string) --
      
      The ID of the organization.
    - Initiator (dict) --
      
      The user who performed the action.
      - Id (string) --
        
        The ID of the user.
      - Username (string) --
        
        The name of the user.
      - GivenName (string) --
        
        The given name of the user before a rename operation.
      - Surname (string) --
        
        The surname of the user.
      - EmailAddress (string) --
        
        The email address of the user.
    - Participants (dict) --
      
      The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.
      - Users (list) --
        
        The list of users.
        
        (dict) --
        
        Describes the metadata of the user.
        
        Id (string) --
        
        The ID of the user.
        
        Username (string) --
        
        The name of the user.
        
        GivenName (string) --
        
        The given name of the user before a rename operation.
        
        Surname (string) --
        
        The surname of the user.
        
        EmailAddress (string) --
        
        The email address of the user.
      - Groups (list) --
        
        The list of user groups.
        
        (dict) --
        
        Describes the metadata of a user group.
        
        Id (string) --
        
        The ID of the user group.
        
        Name (string) --
        
        The name of the group.
    - ResourceMetadata (dict) --
      
      The metadata of the resource involved in the user action.
      - Type (string) --
        
        The type of resource.
      - Name (string) --
        
        The name of the resource.
      - OriginalName (string) --
        
        The original name of the resource before a rename operation.
      - Id (string) --
        
        The ID of the resource.
      - VersionId (string) --
        
        The version ID of the resource. This is an optional field and is filled for action on document version.
      - Owner (dict) --
        
        The owner of the resource.
        
        Id (string) --
        
        The ID of the user.
        
        Username (string) --
        
        The name of the user.
        
        GivenName (string) --
        
        The given name of the user before a rename operation.
        
        Surname (string) --
        
        The surname of the user.
        
        EmailAddress (string) --
        
        The email address of the user.
      - ParentId (string) --
        
        The parent ID of the resource before a rename operation.
    - OriginalParent (dict) --
      
      The original parent of the resource. This is an optional field and is filled for move activities.
      - Type (string) --
        
        The type of resource.
      - Name (string) --
        
        The name of the resource.
      - OriginalName (string) --
        
        The original name of the resource before a rename operation.
      - Id (string) --
        
        The ID of the resource.
      - VersionId (string) --
        
        The version ID of the resource. This is an optional field and is filled for action on document version.
      - Owner (dict) --
        
        The owner of the resource.
        
        Id (string) --
        
        The ID of the user.
        
        Username (string) --
        
        The name of the user.
        
        GivenName (string) --
        
        The given name of the user before a rename operation.
        
        Surname (string) --
        
        The surname of the user.
        
        EmailAddress (string) --
        
        The email address of the user.
      - ParentId (string) --
        
        The parent ID of the resource before a rename operation.
    - CommentMetadata (dict) --
      
      Metadata of the commenting activity. This is an optional field and is filled for commenting activities.
      - CommentId (string) --
        
        The ID of the comment.
      - Contributor (dict) --
        
        The user who made the comment.
        
        Id (string) --
        
        The ID of the user.
        
        Username (string) --
        
        The login name of the user.
        
        EmailAddress (string) --
        
        The email address of the user.
        
        GivenName (string) --
        
        The given name of the user.
        
        Surname (string) --
        
        The surname of the user.
        
        OrganizationId (string) --
        
        The ID of the organization.
        
        RootFolderId (string) --
        
        The ID of the root folder.
        
        RecycleBinFolderId (string) --
        
        The ID of the recycle bin folder.
        
        Status (string) --
        
        The status of the user.
        
        Type (string) --
        
        The type of user.
        
        CreatedTimestamp (datetime) --
        
        The time when the user was created.
        
        ModifiedTimestamp (datetime) --
        
        The time when the user was modified.
        
        TimeZoneId (string) --
        
        The time zone ID of the user.
        
        Locale (string) --
        
        The locale of the user.
        
        Storage (dict) --
        
        The storage for the user.
        
        StorageUtilizedInBytes (integer) --
        
        The amount of storage used, in bytes.
        
        StorageRule (dict) --
        
        The storage for a user.
        
        StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
        
        StorageType (string) --
        
        The type of storage.
      - CreatedTimestamp (datetime) --
        
        The timestamp that the comment was created.
      - CommentStatus (string) --
        
        The status of the comment.
      - RecipientId (string) --
        
        The ID of the user being replied to.
- Marker (string) --
  
  The marker for the next set of results.

Exceptions

WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.InvalidArgumentException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

describe_comments(**kwargs)¶

List all the comments for the specified document version.

See also: AWS API Documentation

Request Syntax

response = client.describe_comments(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string',
    Limit=123,
    Marker='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
VersionId (string) --
[REQUIRED]

The ID of the document version.
Limit (integer) -- The maximum number of items to return.
Marker (string) -- The marker for the next set of results. This marker was received from a previous call.

Return type

dict

Returns

Response Syntax

{
    'Comments': [
        {
            'CommentId': 'string',
            'ParentId': 'string',
            'ThreadId': 'string',
            'Text': 'string',
            'Contributor': {
                'Id': 'string',
                'Username': 'string',
                'EmailAddress': 'string',
                'GivenName': 'string',
                'Surname': 'string',
                'OrganizationId': 'string',
                'RootFolderId': 'string',
                'RecycleBinFolderId': 'string',
                'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
                'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
                'CreatedTimestamp': datetime(2015, 1, 1),
                'ModifiedTimestamp': datetime(2015, 1, 1),
                'TimeZoneId': 'string',
                'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
                'Storage': {
                    'StorageUtilizedInBytes': 123,
                    'StorageRule': {
                        'StorageAllocatedInBytes': 123,
                        'StorageType': 'UNLIMITED'|'QUOTA'
                    }
                }
            },
            'CreatedTimestamp': datetime(2015, 1, 1),
            'Status': 'DRAFT'|'PUBLISHED'|'DELETED',
            'Visibility': 'PUBLIC'|'PRIVATE',
            'RecipientId': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- Comments (list) --
  
  The list of comments for the specified document version.
  - (dict) --
    
    Describes a comment.
    - CommentId (string) --
      
      The ID of the comment.
    - ParentId (string) --
      
      The ID of the parent comment.
    - ThreadId (string) --
      
      The ID of the root comment in the thread.
    - Text (string) --
      
      The text of the comment.
    - Contributor (dict) --
      
      The details of the user who made the comment.
      - Id (string) --
        
        The ID of the user.
      - Username (string) --
        
        The login name of the user.
      - EmailAddress (string) --
        
        The email address of the user.
      - GivenName (string) --
        
        The given name of the user.
      - Surname (string) --
        
        The surname of the user.
      - OrganizationId (string) --
        
        The ID of the organization.
      - RootFolderId (string) --
        
        The ID of the root folder.
      - RecycleBinFolderId (string) --
        
        The ID of the recycle bin folder.
      - Status (string) --
        
        The status of the user.
      - Type (string) --
        
        The type of user.
      - CreatedTimestamp (datetime) --
        
        The time when the user was created.
      - ModifiedTimestamp (datetime) --
        
        The time when the user was modified.
      - TimeZoneId (string) --
        
        The time zone ID of the user.
      - Locale (string) --
        
        The locale of the user.
      - Storage (dict) --
        
        The storage for the user.
        
        StorageUtilizedInBytes (integer) --
        
        The amount of storage used, in bytes.
        
        StorageRule (dict) --
        
        The storage for a user.
        
        StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
        
        StorageType (string) --
        
        The type of storage.
    - CreatedTimestamp (datetime) --
      
      The time that the comment was created.
    - Status (string) --
      
      The status of the comment.
    - Visibility (string) --
      
      The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
    - RecipientId (string) --
      
      If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.
- Marker (string) --
  
  The marker for the next set of results. This marker was received from a previous call.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

describe_document_versions(**kwargs)¶

Retrieves the document versions for the specified document.

By default, only active versions are returned.

See also: AWS API Documentation

Request Syntax

response = client.describe_document_versions(
    AuthenticationToken='string',
    DocumentId='string',
    Marker='string',
    Limit=123,
    Include='string',
    Fields='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
Marker (string) -- The marker for the next set of results. (You received this marker from a previous call.)
Limit (integer) -- The maximum number of versions to return with this call.
Include (string) -- A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.
Fields (string) -- Specify "SOURCE" to include initialized versions and a URL for the source document.

Return type

dict

Returns

Response Syntax

{
    'DocumentVersions': [
        {
            'Id': 'string',
            'Name': 'string',
            'ContentType': 'string',
            'Size': 123,
            'Signature': 'string',
            'Status': 'INITIALIZED'|'ACTIVE',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ContentCreatedTimestamp': datetime(2015, 1, 1),
            'ContentModifiedTimestamp': datetime(2015, 1, 1),
            'CreatorId': 'string',
            'Thumbnail': {
                'string': 'string'
            },
            'Source': {
                'string': 'string'
            }
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- DocumentVersions (list) --
  
  The document versions.
  - (dict) --
    
    Describes a version of a document.
    - Id (string) --
      
      The ID of the version.
    - Name (string) --
      
      The name of the version.
    - ContentType (string) --
      
      The content type of the document.
    - Size (integer) --
      
      The size of the document, in bytes.
    - Signature (string) --
      
      The signature of the document.
    - Status (string) --
      
      The status of the document.
    - CreatedTimestamp (datetime) --
      
      The timestamp when the document was first uploaded.
    - ModifiedTimestamp (datetime) --
      
      The timestamp when the document was last uploaded.
    - ContentCreatedTimestamp (datetime) --
      
      The timestamp when the content of the document was originally created.
    - ContentModifiedTimestamp (datetime) --
      
      The timestamp when the content of the document was modified.
    - CreatorId (string) --
      
      The ID of the creator.
    - Thumbnail (dict) --
      
      The thumbnail of the document.
      - (string) --
        
        (string) --
    - Source (dict) --
      
      The source of the document.
      - (string) --
        
        (string) --
- Marker (string) --
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.InvalidArgumentException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.ProhibitedStateException

describe_folder_contents(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_folder_contents(
    AuthenticationToken='string',
    FolderId='string',
    Sort='DATE'|'NAME',
    Order='ASCENDING'|'DESCENDING',
    Limit=123,
    Marker='string',
    Type='ALL'|'DOCUMENT'|'FOLDER',
    Include='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
FolderId (string) --
[REQUIRED]

The ID of the folder.
Sort (string) -- The sorting criteria.
Order (string) -- The order for the contents of the folder.
Limit (integer) -- The maximum number of items to return with this call.
Marker (string) -- The marker for the next set of results. This marker was received from a previous call.
Type (string) -- The type of items.
Include (string) -- The contents to include. Specify "INITIALIZED" to include initialized documents.

Return type

dict

Returns

Response Syntax

{
    'Folders': [
        {
            'Id': 'string',
            'Name': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Signature': 'string',
            'Labels': [
                'string',
            ],
            'Size': 123,
            'LatestVersionSize': 123
        },
    ],
    'Documents': [
        {
            'Id': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'LatestVersionMetadata': {
                'Id': 'string',
                'Name': 'string',
                'ContentType': 'string',
                'Size': 123,
                'Signature': 'string',
                'Status': 'INITIALIZED'|'ACTIVE',
                'CreatedTimestamp': datetime(2015, 1, 1),
                'ModifiedTimestamp': datetime(2015, 1, 1),
                'ContentCreatedTimestamp': datetime(2015, 1, 1),
                'ContentModifiedTimestamp': datetime(2015, 1, 1),
                'CreatorId': 'string',
                'Thumbnail': {
                    'string': 'string'
                },
                'Source': {
                    'string': 'string'
                }
            },
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Labels': [
                'string',
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- Folders (list) --
  
  The subfolders in the specified folder.
  - (dict) --
    
    Describes a folder.
    - Id (string) --
      
      The ID of the folder.
    - Name (string) --
      
      The name of the folder.
    - CreatorId (string) --
      
      The ID of the creator.
    - ParentFolderId (string) --
      
      The ID of the parent folder.
    - CreatedTimestamp (datetime) --
      
      The time when the folder was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the folder was updated.
    - ResourceState (string) --
      
      The resource state of the folder.
    - Signature (string) --
      
      The unique identifier created from the subfolders and documents of the folder.
    - Labels (list) --
      
      List of labels on the folder.
      - (string) --
    - Size (integer) --
      
      The size of the folder metadata.
    - LatestVersionSize (integer) --
      
      The size of the latest version of the folder metadata.
- Documents (list) --
  
  The documents in the specified folder.
  - (dict) --
    
    Describes the document.
    - Id (string) --
      
      The ID of the document.
    - CreatorId (string) --
      
      The ID of the creator.
    - ParentFolderId (string) --
      
      The ID of the parent folder.
    - CreatedTimestamp (datetime) --
      
      The time when the document was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the document was updated.
    - LatestVersionMetadata (dict) --
      
      The latest version of the document.
      - Id (string) --
        
        The ID of the version.
      - Name (string) --
        
        The name of the version.
      - ContentType (string) --
        
        The content type of the document.
      - Size (integer) --
        
        The size of the document, in bytes.
      - Signature (string) --
        
        The signature of the document.
      - Status (string) --
        
        The status of the document.
      - CreatedTimestamp (datetime) --
        
        The timestamp when the document was first uploaded.
      - ModifiedTimestamp (datetime) --
        
        The timestamp when the document was last uploaded.
      - ContentCreatedTimestamp (datetime) --
        
        The timestamp when the content of the document was originally created.
      - ContentModifiedTimestamp (datetime) --
        
        The timestamp when the content of the document was modified.
      - CreatorId (string) --
        
        The ID of the creator.
      - Thumbnail (dict) --
        
        The thumbnail of the document.
        
        (string) --
        
        (string) --
      - Source (dict) --
        
        The source of the document.
        
        (string) --
        
        (string) --
    - ResourceState (string) --
      
      The resource state.
    - Labels (list) --
      
      List of labels on the document.
      - (string) --
- Marker (string) --
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.InvalidArgumentException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.ProhibitedStateException

describe_groups(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.describe_groups(
    AuthenticationToken='string',
    SearchQuery='string',
    OrganizationId='string',
    Marker='string',
    Limit=123
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
SearchQuery (string) --
[REQUIRED]

A query to describe groups by group name.
OrganizationId (string) -- The ID of the organization.
Marker (string) -- The marker for the next set of results. (You received this marker from a previous call.)
Limit (integer) -- The maximum number of items to return with this call.

Return type

dict

Returns

Response Syntax

{
    'Groups': [
        {
            'Id': 'string',
            'Name': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- Groups (list) --
  
  The list of groups.
  - (dict) --
    
    Describes the metadata of a user group.
    - Id (string) --
      
      The ID of the user group.
    - Name (string) --
      
      The name of the group.
- Marker (string) --
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions

WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

describe_notification_subscriptions(**kwargs)¶

Lists the specified notification subscriptions.

See also: AWS API Documentation

Request Syntax

response = client.describe_notification_subscriptions(
    OrganizationId='string',
    Marker='string',
    Limit=123
)

Parameters

OrganizationId (string) --
[REQUIRED]

The ID of the organization.
Marker (string) -- The marker for the next set of results. (You received this marker from a previous call.)
Limit (integer) -- The maximum number of items to return with this call.

Return type

dict

Returns

Response Syntax

{
    'Subscriptions': [
        {
            'SubscriptionId': 'string',
            'EndPoint': 'string',
            'Protocol': 'HTTPS'
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- Subscriptions (list) --
  
  The subscriptions.
  - (dict) --
    
    Describes a subscription.
    - SubscriptionId (string) --
      
      The ID of the subscription.
    - EndPoint (string) --
      
      The endpoint of the subscription.
    - Protocol (string) --
      
      The protocol of the subscription.
- Marker (string) --
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions

WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ServiceUnavailableException

describe_resource_permissions(**kwargs)¶

Describes the permissions of a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.describe_resource_permissions(
    AuthenticationToken='string',
    ResourceId='string',
    PrincipalId='string',
    Limit=123,
    Marker='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
ResourceId (string) --
[REQUIRED]

The ID of the resource.
PrincipalId (string) -- The ID of the principal to filter permissions by.
Limit (integer) -- The maximum number of items to return with this call.
Marker (string) -- The marker for the next set of results. (You received this marker from a previous call)

Return type

dict

Returns

Response Syntax

{
    'Principals': [
        {
            'Id': 'string',
            'Type': 'USER'|'GROUP'|'INVITE'|'ANONYMOUS'|'ORGANIZATION',
            'Roles': [
                {
                    'Role': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'COOWNER',
                    'Type': 'DIRECT'|'INHERITED'
                },
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- Principals (list) --
  
  The principals.
  - (dict) --
    
    Describes a resource.
    - Id (string) --
      
      The ID of the resource.
    - Type (string) --
      
      The type of resource.
    - Roles (list) --
      
      The permission information for the resource.
      - (dict) --
        
        Describes the permissions.
        
        Role (string) --
        
        The role of the user.
        
        Type (string) --
        
        The type of permissions.
- Marker (string) --
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions

WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

describe_root_folders(**kwargs)¶

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 .

See also: AWS API Documentation

Request Syntax

response = client.describe_root_folders(
    AuthenticationToken='string',
    Limit=123,
    Marker='string'
)

Parameters

AuthenticationToken (string) --
[REQUIRED]

Amazon WorkDocs authentication token.
Limit (integer) -- The maximum number of items to return.
Marker (string) -- The marker for the next set of results. (You received this marker from a previous call.)

Return type

dict

Returns

Response Syntax

{
    'Folders': [
        {
            'Id': 'string',
            'Name': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Signature': 'string',
            'Labels': [
                'string',
            ],
            'Size': 123,
            'LatestVersionSize': 123
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- Folders (list) --
  
  The user's special folders.
  - (dict) --
    
    Describes a folder.
    - Id (string) --
      
      The ID of the folder.
    - Name (string) --
      
      The name of the folder.
    - CreatorId (string) --
      
      The ID of the creator.
    - ParentFolderId (string) --
      
      The ID of the parent folder.
    - CreatedTimestamp (datetime) --
      
      The time when the folder was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the folder was updated.
    - ResourceState (string) --
      
      The resource state of the folder.
    - Signature (string) --
      
      The unique identifier created from the subfolders and documents of the folder.
    - Labels (list) --
      
      List of labels on the folder.
      - (string) --
    - Size (integer) --
      
      The size of the folder metadata.
    - LatestVersionSize (integer) --
      
      The size of the latest version of the folder metadata.
- Marker (string) --
  
  The marker for the next set of results.

Exceptions

WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.InvalidArgumentException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

describe_users(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_users(
    AuthenticationToken='string',
    OrganizationId='string',
    UserIds='string',
    Query='string',
    Include='ALL'|'ACTIVE_PENDING',
    Order='ASCENDING'|'DESCENDING',
    Sort='USER_NAME'|'FULL_NAME'|'STORAGE_LIMIT'|'USER_STATUS'|'STORAGE_USED',
    Marker='string',
    Limit=123,
    Fields='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
OrganizationId (string) -- The ID of the organization.
UserIds (string) -- The IDs of the users.
Query (string) -- A query to filter users by user name.
Include (string) -- The state of the users. Specify "ALL" to include inactive users.
Order (string) -- The order for the results.
Sort (string) -- The sorting criteria.
Marker (string) -- The marker for the next set of results. (You received this marker from a previous call.)
Limit (integer) -- The maximum number of items to return.
Fields (string) -- A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Return type

dict

Returns

Response Syntax

{
    'Users': [
        {
            'Id': 'string',
            'Username': 'string',
            'EmailAddress': 'string',
            'GivenName': 'string',
            'Surname': 'string',
            'OrganizationId': 'string',
            'RootFolderId': 'string',
            'RecycleBinFolderId': 'string',
            'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
            'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'TimeZoneId': 'string',
            'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
            'Storage': {
                'StorageUtilizedInBytes': 123,
                'StorageRule': {
                    'StorageAllocatedInBytes': 123,
                    'StorageType': 'UNLIMITED'|'QUOTA'
                }
            }
        },
    ],
    'TotalNumberOfUsers': 123,
    'Marker': 'string'
}

Response Structure

(dict) --
- Users (list) --
  
  The users.
  - (dict) --
    
    Describes a user.
    - Id (string) --
      
      The ID of the user.
    - Username (string) --
      
      The login name of the user.
    - EmailAddress (string) --
      
      The email address of the user.
    - GivenName (string) --
      
      The given name of the user.
    - Surname (string) --
      
      The surname of the user.
    - OrganizationId (string) --
      
      The ID of the organization.
    - RootFolderId (string) --
      
      The ID of the root folder.
    - RecycleBinFolderId (string) --
      
      The ID of the recycle bin folder.
    - Status (string) --
      
      The status of the user.
    - Type (string) --
      
      The type of user.
    - CreatedTimestamp (datetime) --
      
      The time when the user was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the user was modified.
    - TimeZoneId (string) --
      
      The time zone ID of the user.
    - Locale (string) --
      
      The locale of the user.
    - Storage (dict) --
      
      The storage for the user.
      - StorageUtilizedInBytes (integer) --
        
        The amount of storage used, in bytes.
      - StorageRule (dict) --
        
        The storage for a user.
        
        StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
        
        StorageType (string) --
        
        The type of storage.
- TotalNumberOfUsers (integer) --
  
  The total number of users included in the results.
- Marker (string) --
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.InvalidArgumentException
WorkDocs.Client.exceptions.RequestedEntityTooLargeException

get_current_user(**kwargs)¶

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 .

See also: AWS API Documentation

Request Syntax

response = client.get_current_user(
    AuthenticationToken='string'
)

Parameters

AuthenticationToken (string) --

[REQUIRED]

Amazon WorkDocs authentication token.

Return type

dict

Returns

Response Syntax

{
    'User': {
        'Id': 'string',
        'Username': 'string',
        'EmailAddress': 'string',
        'GivenName': 'string',
        'Surname': 'string',
        'OrganizationId': 'string',
        'RootFolderId': 'string',
        'RecycleBinFolderId': 'string',
        'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
        'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'TimeZoneId': 'string',
        'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
        'Storage': {
            'StorageUtilizedInBytes': 123,
            'StorageRule': {
                'StorageAllocatedInBytes': 123,
                'StorageType': 'UNLIMITED'|'QUOTA'
            }
        }
    }
}

Response Structure

(dict) --
- User (dict) --
  Metadata of the user.
  - Id (string) --
    The ID of the user.
  - Username (string) --
    The login name of the user.
  - EmailAddress (string) --
    The email address of the user.
  - GivenName (string) --
    The given name of the user.
  - Surname (string) --
    The surname of the user.
  - OrganizationId (string) --
    The ID of the organization.
  - RootFolderId (string) --
    The ID of the root folder.
  - RecycleBinFolderId (string) --
    The ID of the recycle bin folder.
  - Status (string) --
    The status of the user.
  - Type (string) --
    The type of user.
  - CreatedTimestamp (datetime) --
    The time when the user was created.
  - ModifiedTimestamp (datetime) --
    The time when the user was modified.
  - TimeZoneId (string) --
    The time zone ID of the user.
  - Locale (string) --
    The locale of the user.
  - Storage (dict) --
    The storage for the user.
    - StorageUtilizedInBytes (integer) --
      The amount of storage used, in bytes.
    - StorageRule (dict) --
      The storage for a user.
      - StorageAllocatedInBytes (integer) --
        The amount of storage allocated, in bytes.
      - StorageType (string) --
        The type of storage.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

get_document(**kwargs)¶

Retrieves details of a document.

See also: AWS API Documentation

Request Syntax

response = client.get_document(
    AuthenticationToken='string',
    DocumentId='string',
    IncludeCustomMetadata=True|False
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
IncludeCustomMetadata (boolean) -- Set this to TRUE to include custom metadata in the response.

Return type

dict

Returns

Response Syntax

{
    'Metadata': {
        'Id': 'string',
        'CreatorId': 'string',
        'ParentFolderId': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'LatestVersionMetadata': {
            'Id': 'string',
            'Name': 'string',
            'ContentType': 'string',
            'Size': 123,
            'Signature': 'string',
            'Status': 'INITIALIZED'|'ACTIVE',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ContentCreatedTimestamp': datetime(2015, 1, 1),
            'ContentModifiedTimestamp': datetime(2015, 1, 1),
            'CreatorId': 'string',
            'Thumbnail': {
                'string': 'string'
            },
            'Source': {
                'string': 'string'
            }
        },
        'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
        'Labels': [
            'string',
        ]
    },
    'CustomMetadata': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Metadata (dict) --
  
  The metadata details of the document.
  - Id (string) --
    
    The ID of the document.
  - CreatorId (string) --
    
    The ID of the creator.
  - ParentFolderId (string) --
    
    The ID of the parent folder.
  - CreatedTimestamp (datetime) --
    
    The time when the document was created.
  - ModifiedTimestamp (datetime) --
    
    The time when the document was updated.
  - LatestVersionMetadata (dict) --
    
    The latest version of the document.
    - Id (string) --
      
      The ID of the version.
    - Name (string) --
      
      The name of the version.
    - ContentType (string) --
      
      The content type of the document.
    - Size (integer) --
      
      The size of the document, in bytes.
    - Signature (string) --
      
      The signature of the document.
    - Status (string) --
      
      The status of the document.
    - CreatedTimestamp (datetime) --
      
      The timestamp when the document was first uploaded.
    - ModifiedTimestamp (datetime) --
      
      The timestamp when the document was last uploaded.
    - ContentCreatedTimestamp (datetime) --
      
      The timestamp when the content of the document was originally created.
    - ContentModifiedTimestamp (datetime) --
      
      The timestamp when the content of the document was modified.
    - CreatorId (string) --
      
      The ID of the creator.
    - Thumbnail (dict) --
      
      The thumbnail of the document.
      - (string) --
        
        (string) --
    - Source (dict) --
      
      The source of the document.
      - (string) --
        
        (string) --
  - ResourceState (string) --
    
    The resource state.
  - Labels (list) --
    
    List of labels on the document.
    - (string) --
- CustomMetadata (dict) --
  
  The custom metadata on the document.
  - (string) --
    - (string) --

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.InvalidArgumentException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.InvalidPasswordException

get_document_path(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.get_document_path(
    AuthenticationToken='string',
    DocumentId='string',
    Limit=123,
    Fields='string',
    Marker='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
Limit (integer) -- The maximum number of levels in the hierarchy to return.
Fields (string) -- A comma-separated list of values. Specify NAME to include the names of the parent folders.
Marker (string) -- This value is not supported.

Return type

dict

Returns

Response Syntax

{
    'Path': {
        'Components': [
            {
                'Id': 'string',
                'Name': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Path (dict) --
  
  The path information.
  - Components (list) --
    
    The components of the resource path.
    - (dict) --
      
      Describes the resource path.
      - Id (string) --
        
        The ID of the resource path.
      - Name (string) --
        
        The name of the resource path.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

get_document_version(**kwargs)¶

Retrieves version metadata for the specified document.

See also: AWS API Documentation

Request Syntax

response = client.get_document_version(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string',
    Fields='string',
    IncludeCustomMetadata=True|False
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
VersionId (string) --
[REQUIRED]

The version ID of the document.
Fields (string) -- A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.
IncludeCustomMetadata (boolean) -- Set this to TRUE to include custom metadata in the response.

Return type

dict

Returns

Response Syntax

{
    'Metadata': {
        'Id': 'string',
        'Name': 'string',
        'ContentType': 'string',
        'Size': 123,
        'Signature': 'string',
        'Status': 'INITIALIZED'|'ACTIVE',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'ContentCreatedTimestamp': datetime(2015, 1, 1),
        'ContentModifiedTimestamp': datetime(2015, 1, 1),
        'CreatorId': 'string',
        'Thumbnail': {
            'string': 'string'
        },
        'Source': {
            'string': 'string'
        }
    },
    'CustomMetadata': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Metadata (dict) --
  
  The version metadata.
  - Id (string) --
    
    The ID of the version.
  - Name (string) --
    
    The name of the version.
  - ContentType (string) --
    
    The content type of the document.
  - Size (integer) --
    
    The size of the document, in bytes.
  - Signature (string) --
    
    The signature of the document.
  - Status (string) --
    
    The status of the document.
  - CreatedTimestamp (datetime) --
    
    The timestamp when the document was first uploaded.
  - ModifiedTimestamp (datetime) --
    
    The timestamp when the document was last uploaded.
  - ContentCreatedTimestamp (datetime) --
    
    The timestamp when the content of the document was originally created.
  - ContentModifiedTimestamp (datetime) --
    
    The timestamp when the content of the document was modified.
  - CreatorId (string) --
    
    The ID of the creator.
  - Thumbnail (dict) --
    
    The thumbnail of the document.
    - (string) --
      - (string) --
  - Source (dict) --
    
    The source of the document.
    - (string) --
      - (string) --
- CustomMetadata (dict) --
  
  The custom metadata on the document version.
  - (string) --
    - (string) --

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.InvalidPasswordException

get_folder(**kwargs)¶

Retrieves the metadata of the specified folder.

See also: AWS API Documentation

Request Syntax

response = client.get_folder(
    AuthenticationToken='string',
    FolderId='string',
    IncludeCustomMetadata=True|False
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
FolderId (string) --
[REQUIRED]

The ID of the folder.
IncludeCustomMetadata (boolean) -- Set to TRUE to include custom metadata in the response.

Return type

dict

Returns

Response Syntax

{
    'Metadata': {
        'Id': 'string',
        'Name': 'string',
        'CreatorId': 'string',
        'ParentFolderId': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
        'Signature': 'string',
        'Labels': [
            'string',
        ],
        'Size': 123,
        'LatestVersionSize': 123
    },
    'CustomMetadata': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Metadata (dict) --
  
  The metadata of the folder.
  - Id (string) --
    
    The ID of the folder.
  - Name (string) --
    
    The name of the folder.
  - CreatorId (string) --
    
    The ID of the creator.
  - ParentFolderId (string) --
    
    The ID of the parent folder.
  - CreatedTimestamp (datetime) --
    
    The time when the folder was created.
  - ModifiedTimestamp (datetime) --
    
    The time when the folder was updated.
  - ResourceState (string) --
    
    The resource state of the folder.
  - Signature (string) --
    
    The unique identifier created from the subfolders and documents of the folder.
  - Labels (list) --
    
    List of labels on the folder.
    - (string) --
  - Size (integer) --
    
    The size of the folder metadata.
  - LatestVersionSize (integer) --
    
    The size of the latest version of the folder metadata.
- CustomMetadata (dict) --
  
  The custom metadata on the folder.
  - (string) --
    - (string) --

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.InvalidArgumentException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.ProhibitedStateException

get_folder_path(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.get_folder_path(
    AuthenticationToken='string',
    FolderId='string',
    Limit=123,
    Fields='string',
    Marker='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
FolderId (string) --
[REQUIRED]

The ID of the folder.
Limit (integer) -- The maximum number of levels in the hierarchy to return.
Fields (string) -- A comma-separated list of values. Specify "NAME" to include the names of the parent folders.
Marker (string) -- This value is not supported.

Return type

dict

Returns

Response Syntax

{
    'Path': {
        'Components': [
            {
                'Id': 'string',
                'Name': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Path (dict) --
  
  The path information.
  - Components (list) --
    
    The components of the resource path.
    - (dict) --
      
      Describes the resource path.
      - Id (string) --
        
        The ID of the resource path.
      - Name (string) --
        
        The name of the resource path.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_resources(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.get_resources(
    AuthenticationToken='string',
    UserId='string',
    CollectionType='SHARED_WITH_ME',
    Limit=123,
    Marker='string'
)

Parameters

AuthenticationToken (string) -- The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
UserId (string) -- The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.
CollectionType (string) -- The collection type.
Limit (integer) -- The maximum number of resources to return.
Marker (string) -- The marker for the next set of results. This marker was received from a previous call.

Return type

dict

Returns

Response Syntax

{
    'Folders': [
        {
            'Id': 'string',
            'Name': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Signature': 'string',
            'Labels': [
                'string',
            ],
            'Size': 123,
            'LatestVersionSize': 123
        },
    ],
    'Documents': [
        {
            'Id': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'LatestVersionMetadata': {
                'Id': 'string',
                'Name': 'string',
                'ContentType': 'string',
                'Size': 123,
                'Signature': 'string',
                'Status': 'INITIALIZED'|'ACTIVE',
                'CreatedTimestamp': datetime(2015, 1, 1),
                'ModifiedTimestamp': datetime(2015, 1, 1),
                'ContentCreatedTimestamp': datetime(2015, 1, 1),
                'ContentModifiedTimestamp': datetime(2015, 1, 1),
                'CreatorId': 'string',
                'Thumbnail': {
                    'string': 'string'
                },
                'Source': {
                    'string': 'string'
                }
            },
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Labels': [
                'string',
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- Folders (list) --
  
  The folders in the specified folder.
  - (dict) --
    
    Describes a folder.
    - Id (string) --
      
      The ID of the folder.
    - Name (string) --
      
      The name of the folder.
    - CreatorId (string) --
      
      The ID of the creator.
    - ParentFolderId (string) --
      
      The ID of the parent folder.
    - CreatedTimestamp (datetime) --
      
      The time when the folder was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the folder was updated.
    - ResourceState (string) --
      
      The resource state of the folder.
    - Signature (string) --
      
      The unique identifier created from the subfolders and documents of the folder.
    - Labels (list) --
      
      List of labels on the folder.
      - (string) --
    - Size (integer) --
      
      The size of the folder metadata.
    - LatestVersionSize (integer) --
      
      The size of the latest version of the folder metadata.
- Documents (list) --
  
  The documents in the specified collection.
  - (dict) --
    
    Describes the document.
    - Id (string) --
      
      The ID of the document.
    - CreatorId (string) --
      
      The ID of the creator.
    - ParentFolderId (string) --
      
      The ID of the parent folder.
    - CreatedTimestamp (datetime) --
      
      The time when the document was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the document was updated.
    - LatestVersionMetadata (dict) --
      
      The latest version of the document.
      - Id (string) --
        
        The ID of the version.
      - Name (string) --
        
        The name of the version.
      - ContentType (string) --
        
        The content type of the document.
      - Size (integer) --
        
        The size of the document, in bytes.
      - Signature (string) --
        
        The signature of the document.
      - Status (string) --
        
        The status of the document.
      - CreatedTimestamp (datetime) --
        
        The timestamp when the document was first uploaded.
      - ModifiedTimestamp (datetime) --
        
        The timestamp when the document was last uploaded.
      - ContentCreatedTimestamp (datetime) --
        
        The timestamp when the content of the document was originally created.
      - ContentModifiedTimestamp (datetime) --
        
        The timestamp when the content of the document was modified.
      - CreatorId (string) --
        
        The ID of the creator.
      - Thumbnail (dict) --
        
        The thumbnail of the document.
        
        (string) --
        
        (string) --
      - Source (dict) --
        
        The source of the document.
        
        (string) --
        
        (string) --
    - ResourceState (string) --
      
      The resource state.
    - Labels (list) --
      
      List of labels on the document.
      - (string) --
- Marker (string) --
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions

WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.InvalidArgumentException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

initiate_document_version_upload(**kwargs)¶

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 .

See also: AWS API Documentation

Request Syntax

response = client.initiate_document_version_upload(
    AuthenticationToken='string',
    Id='string',
    Name='string',
    ContentCreatedTimestamp=datetime(2015, 1, 1),
    ContentModifiedTimestamp=datetime(2015, 1, 1),
    ContentType='string',
    DocumentSizeInBytes=123,
    ParentFolderId='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
Id (string) -- The ID of the document.
Name (string) -- The name of the document.
ContentCreatedTimestamp (datetime) -- The timestamp when the content of the document was originally created.
ContentModifiedTimestamp (datetime) -- The timestamp when the content of the document was modified.
ContentType (string) -- The content type of the document.
DocumentSizeInBytes (integer) -- The size of the document, in bytes.
ParentFolderId (string) --
[REQUIRED]

The ID of the parent folder.

Return type

dict

Returns

Response Syntax

{
    'Metadata': {
        'Id': 'string',
        'CreatorId': 'string',
        'ParentFolderId': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'LatestVersionMetadata': {
            'Id': 'string',
            'Name': 'string',
            'ContentType': 'string',
            'Size': 123,
            'Signature': 'string',
            'Status': 'INITIALIZED'|'ACTIVE',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ContentCreatedTimestamp': datetime(2015, 1, 1),
            'ContentModifiedTimestamp': datetime(2015, 1, 1),
            'CreatorId': 'string',
            'Thumbnail': {
                'string': 'string'
            },
            'Source': {
                'string': 'string'
            }
        },
        'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
        'Labels': [
            'string',
        ]
    },
    'UploadMetadata': {
        'UploadUrl': 'string',
        'SignedHeaders': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- Metadata (dict) --
  
  The document metadata.
  - Id (string) --
    
    The ID of the document.
  - CreatorId (string) --
    
    The ID of the creator.
  - ParentFolderId (string) --
    
    The ID of the parent folder.
  - CreatedTimestamp (datetime) --
    
    The time when the document was created.
  - ModifiedTimestamp (datetime) --
    
    The time when the document was updated.
  - LatestVersionMetadata (dict) --
    
    The latest version of the document.
    - Id (string) --
      
      The ID of the version.
    - Name (string) --
      
      The name of the version.
    - ContentType (string) --
      
      The content type of the document.
    - Size (integer) --
      
      The size of the document, in bytes.
    - Signature (string) --
      
      The signature of the document.
    - Status (string) --
      
      The status of the document.
    - CreatedTimestamp (datetime) --
      
      The timestamp when the document was first uploaded.
    - ModifiedTimestamp (datetime) --
      
      The timestamp when the document was last uploaded.
    - ContentCreatedTimestamp (datetime) --
      
      The timestamp when the content of the document was originally created.
    - ContentModifiedTimestamp (datetime) --
      
      The timestamp when the content of the document was modified.
    - CreatorId (string) --
      
      The ID of the creator.
    - Thumbnail (dict) --
      
      The thumbnail of the document.
      - (string) --
        
        (string) --
    - Source (dict) --
      
      The source of the document.
      - (string) --
        
        (string) --
  - ResourceState (string) --
    
    The resource state.
  - Labels (list) --
    
    List of labels on the document.
    - (string) --
- UploadMetadata (dict) --
  
  The upload metadata.
  - UploadUrl (string) --
    
    The URL of the upload.
  - SignedHeaders (dict) --
    
    The signed headers.
    - (string) --
      - (string) --

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.EntityAlreadyExistsException
WorkDocs.Client.exceptions.StorageLimitExceededException
WorkDocs.Client.exceptions.StorageLimitWillExceedException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.DraftUploadOutOfSyncException
WorkDocs.Client.exceptions.ResourceAlreadyCheckedOutException

remove_all_resource_permissions(**kwargs)¶

Removes all the permissions from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.remove_all_resource_permissions(
    AuthenticationToken='string',
    ResourceId='string'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
ResourceId (string) --
[REQUIRED]

The ID of the resource.

Returns

None

Exceptions

WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

remove_resource_permission(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.remove_resource_permission(
    AuthenticationToken='string',
    ResourceId='string',
    PrincipalId='string',
    PrincipalType='USER'|'GROUP'|'INVITE'|'ANONYMOUS'|'ORGANIZATION'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
ResourceId (string) --
[REQUIRED]

The ID of the resource.
PrincipalId (string) --
[REQUIRED]

The principal ID of the resource.
PrincipalType (string) -- The principal type of the resource.

Returns

None

Exceptions

WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

update_document(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.update_document(
    AuthenticationToken='string',
    DocumentId='string',
    Name='string',
    ParentFolderId='string',
    ResourceState='ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
Name (string) -- The name of the document.
ParentFolderId (string) -- The ID of the parent folder.
ResourceState (string) -- The resource state of the document. Only ACTIVE and RECYCLED are supported.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.EntityAlreadyExistsException
WorkDocs.Client.exceptions.LimitExceededException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.ConflictingOperationException
WorkDocs.Client.exceptions.ConcurrentModificationException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

update_document_version(**kwargs)¶

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 .

See also: AWS API Documentation

Request Syntax

response = client.update_document_version(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string',
    VersionStatus='ACTIVE'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
VersionId (string) --
[REQUIRED]

The version ID of the document.
VersionStatus (string) -- The status of the version.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.ConcurrentModificationException
WorkDocs.Client.exceptions.InvalidOperationException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

update_folder(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.update_folder(
    AuthenticationToken='string',
    FolderId='string',
    Name='string',
    ParentFolderId='string',
    ResourceState='ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
FolderId (string) --
[REQUIRED]

The ID of the folder.
Name (string) -- The name of the folder.
ParentFolderId (string) -- The ID of the parent folder.
ResourceState (string) -- The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

Returns

None

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.EntityAlreadyExistsException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.ConflictingOperationException
WorkDocs.Client.exceptions.ConcurrentModificationException
WorkDocs.Client.exceptions.LimitExceededException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException

update_user(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    AuthenticationToken='string',
    UserId='string',
    GivenName='string',
    Surname='string',
    Type='USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
    StorageRule={
        'StorageAllocatedInBytes': 123,
        'StorageType': 'UNLIMITED'|'QUOTA'
    },
    TimeZoneId='string',
    Locale='en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
    GrantPoweruserPrivileges='TRUE'|'FALSE'
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
UserId (string) --
[REQUIRED]

The ID of the user.
GivenName (string) -- The given name of the user.
Surname (string) -- The surname of the user.
Type (string) -- The type of the user.
StorageRule (dict) --
The amount of storage for the user.
- StorageAllocatedInBytes (integer) --
  The amount of storage allocated, in bytes.
- StorageType (string) --
  The type of storage.
TimeZoneId (string) -- The time zone ID of the user.
Locale (string) -- The locale of the user.
GrantPoweruserPrivileges (string) -- Boolean value to determine whether the user is granted Poweruser privileges.

Return type

dict

Returns

Response Syntax

{
    'User': {
        'Id': 'string',
        'Username': 'string',
        'EmailAddress': 'string',
        'GivenName': 'string',
        'Surname': 'string',
        'OrganizationId': 'string',
        'RootFolderId': 'string',
        'RecycleBinFolderId': 'string',
        'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
        'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'TimeZoneId': 'string',
        'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
        'Storage': {
            'StorageUtilizedInBytes': 123,
            'StorageRule': {
                'StorageAllocatedInBytes': 123,
                'StorageType': 'UNLIMITED'|'QUOTA'
            }
        }
    }
}

Response Structure

(dict) --
- User (dict) --
  
  The user information.
  - Id (string) --
    
    The ID of the user.
  - Username (string) --
    
    The login name of the user.
  - EmailAddress (string) --
    
    The email address of the user.
  - GivenName (string) --
    
    The given name of the user.
  - Surname (string) --
    
    The surname of the user.
  - OrganizationId (string) --
    
    The ID of the organization.
  - RootFolderId (string) --
    
    The ID of the root folder.
  - RecycleBinFolderId (string) --
    
    The ID of the recycle bin folder.
  - Status (string) --
    
    The status of the user.
  - Type (string) --
    
    The type of user.
  - CreatedTimestamp (datetime) --
    
    The time when the user was created.
  - ModifiedTimestamp (datetime) --
    
    The time when the user was modified.
  - TimeZoneId (string) --
    
    The time zone ID of the user.
  - Locale (string) --
    
    The locale of the user.
  - Storage (dict) --
    
    The storage for the user.
    - StorageUtilizedInBytes (integer) --
      
      The amount of storage used, in bytes.
    - StorageRule (dict) --
      
      The storage for a user.
      - StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
      - StorageType (string) --
        
        The type of storage.

Exceptions

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.IllegalUserStateException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.DeactivatingLastSystemUserException
WorkDocs.Client.exceptions.InvalidArgumentException

Paginators ¶

The available paginators are:

WorkDocs.Paginator.DescribeActivities
WorkDocs.Paginator.DescribeComments
WorkDocs.Paginator.DescribeDocumentVersions
WorkDocs.Paginator.DescribeFolderContents
WorkDocs.Paginator.DescribeGroups
WorkDocs.Paginator.DescribeNotificationSubscriptions
WorkDocs.Paginator.DescribeResourcePermissions
WorkDocs.Paginator.DescribeRootFolders
WorkDocs.Paginator.DescribeUsers

class WorkDocs.Paginator.DescribeActivities¶

paginator = client.get_paginator('describe_activities')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_activities().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    OrganizationId='string',
    ActivityTypes='string',
    ResourceId='string',
    UserId='string',
    IncludeIndirectActivities=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
StartTime (datetime) -- The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
EndTime (datetime) -- The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
OrganizationId (string) -- The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
ActivityTypes (string) -- Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
ResourceId (string) -- The document or folder ID for which to describe activity types.
UserId (string) -- The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.
IncludeIndirectActivities (boolean) -- Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'UserActivities': [
        {
            'Type': 'DOCUMENT_CHECKED_IN'|'DOCUMENT_CHECKED_OUT'|'DOCUMENT_RENAMED'|'DOCUMENT_VERSION_UPLOADED'|'DOCUMENT_VERSION_DELETED'|'DOCUMENT_VERSION_VIEWED'|'DOCUMENT_VERSION_DOWNLOADED'|'DOCUMENT_RECYCLED'|'DOCUMENT_RESTORED'|'DOCUMENT_REVERTED'|'DOCUMENT_SHARED'|'DOCUMENT_UNSHARED'|'DOCUMENT_SHARE_PERMISSION_CHANGED'|'DOCUMENT_SHAREABLE_LINK_CREATED'|'DOCUMENT_SHAREABLE_LINK_REMOVED'|'DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED'|'DOCUMENT_MOVED'|'DOCUMENT_COMMENT_ADDED'|'DOCUMENT_COMMENT_DELETED'|'DOCUMENT_ANNOTATION_ADDED'|'DOCUMENT_ANNOTATION_DELETED'|'FOLDER_CREATED'|'FOLDER_DELETED'|'FOLDER_RENAMED'|'FOLDER_RECYCLED'|'FOLDER_RESTORED'|'FOLDER_SHARED'|'FOLDER_UNSHARED'|'FOLDER_SHARE_PERMISSION_CHANGED'|'FOLDER_SHAREABLE_LINK_CREATED'|'FOLDER_SHAREABLE_LINK_REMOVED'|'FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED'|'FOLDER_MOVED',
            'TimeStamp': datetime(2015, 1, 1),
            'IsIndirectActivity': True|False,
            'OrganizationId': 'string',
            'Initiator': {
                'Id': 'string',
                'Username': 'string',
                'GivenName': 'string',
                'Surname': 'string',
                'EmailAddress': 'string'
            },
            'Participants': {
                'Users': [
                    {
                        'Id': 'string',
                        'Username': 'string',
                        'GivenName': 'string',
                        'Surname': 'string',
                        'EmailAddress': 'string'
                    },
                ],
                'Groups': [
                    {
                        'Id': 'string',
                        'Name': 'string'
                    },
                ]
            },
            'ResourceMetadata': {
                'Type': 'FOLDER'|'DOCUMENT',
                'Name': 'string',
                'OriginalName': 'string',
                'Id': 'string',
                'VersionId': 'string',
                'Owner': {
                    'Id': 'string',
                    'Username': 'string',
                    'GivenName': 'string',
                    'Surname': 'string',
                    'EmailAddress': 'string'
                },
                'ParentId': 'string'
            },
            'OriginalParent': {
                'Type': 'FOLDER'|'DOCUMENT',
                'Name': 'string',
                'OriginalName': 'string',
                'Id': 'string',
                'VersionId': 'string',
                'Owner': {
                    'Id': 'string',
                    'Username': 'string',
                    'GivenName': 'string',
                    'Surname': 'string',
                    'EmailAddress': 'string'
                },
                'ParentId': 'string'
            },
            'CommentMetadata': {
                'CommentId': 'string',
                'Contributor': {
                    'Id': 'string',
                    'Username': 'string',
                    'EmailAddress': 'string',
                    'GivenName': 'string',
                    'Surname': 'string',
                    'OrganizationId': 'string',
                    'RootFolderId': 'string',
                    'RecycleBinFolderId': 'string',
                    'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
                    'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
                    'CreatedTimestamp': datetime(2015, 1, 1),
                    'ModifiedTimestamp': datetime(2015, 1, 1),
                    'TimeZoneId': 'string',
                    'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
                    'Storage': {
                        'StorageUtilizedInBytes': 123,
                        'StorageRule': {
                            'StorageAllocatedInBytes': 123,
                            'StorageType': 'UNLIMITED'|'QUOTA'
                        }
                    }
                },
                'CreatedTimestamp': datetime(2015, 1, 1),
                'CommentStatus': 'DRAFT'|'PUBLISHED'|'DELETED',
                'RecipientId': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- UserActivities (list) --
  
  The list of activities for the specified user and time period.
  - (dict) --
    
    Describes the activity information.
    - Type (string) --
      
      The activity type.
    - TimeStamp (datetime) --
      
      The timestamp when the action was performed.
    - IsIndirectActivity (boolean) --
      
      Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).
    - OrganizationId (string) --
      
      The ID of the organization.
    - Initiator (dict) --
      
      The user who performed the action.
      - Id (string) --
        
        The ID of the user.
      - Username (string) --
        
        The name of the user.
      - GivenName (string) --
        
        The given name of the user before a rename operation.
      - Surname (string) --
        
        The surname of the user.
      - EmailAddress (string) --
        
        The email address of the user.
    - Participants (dict) --
      
      The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.
      - Users (list) --
        
        The list of users.
        
        (dict) --
        
        Describes the metadata of the user.
        
        Id (string) --
        
        The ID of the user.
        
        Username (string) --
        
        The name of the user.
        
        GivenName (string) --
        
        The given name of the user before a rename operation.
        
        Surname (string) --
        
        The surname of the user.
        
        EmailAddress (string) --
        
        The email address of the user.
      - Groups (list) --
        
        The list of user groups.
        
        (dict) --
        
        Describes the metadata of a user group.
        
        Id (string) --
        
        The ID of the user group.
        
        Name (string) --
        
        The name of the group.
    - ResourceMetadata (dict) --
      
      The metadata of the resource involved in the user action.
      - Type (string) --
        
        The type of resource.
      - Name (string) --
        
        The name of the resource.
      - OriginalName (string) --
        
        The original name of the resource before a rename operation.
      - Id (string) --
        
        The ID of the resource.
      - VersionId (string) --
        
        The version ID of the resource. This is an optional field and is filled for action on document version.
      - Owner (dict) --
        
        The owner of the resource.
        
        Id (string) --
        
        The ID of the user.
        
        Username (string) --
        
        The name of the user.
        
        GivenName (string) --
        
        The given name of the user before a rename operation.
        
        Surname (string) --
        
        The surname of the user.
        
        EmailAddress (string) --
        
        The email address of the user.
      - ParentId (string) --
        
        The parent ID of the resource before a rename operation.
    - OriginalParent (dict) --
      
      The original parent of the resource. This is an optional field and is filled for move activities.
      - Type (string) --
        
        The type of resource.
      - Name (string) --
        
        The name of the resource.
      - OriginalName (string) --
        
        The original name of the resource before a rename operation.
      - Id (string) --
        
        The ID of the resource.
      - VersionId (string) --
        
        The version ID of the resource. This is an optional field and is filled for action on document version.
      - Owner (dict) --
        
        The owner of the resource.
        
        Id (string) --
        
        The ID of the user.
        
        Username (string) --
        
        The name of the user.
        
        GivenName (string) --
        
        The given name of the user before a rename operation.
        
        Surname (string) --
        
        The surname of the user.
        
        EmailAddress (string) --
        
        The email address of the user.
      - ParentId (string) --
        
        The parent ID of the resource before a rename operation.
    - CommentMetadata (dict) --
      
      Metadata of the commenting activity. This is an optional field and is filled for commenting activities.
      - CommentId (string) --
        
        The ID of the comment.
      - Contributor (dict) --
        
        The user who made the comment.
        
        Id (string) --
        
        The ID of the user.
        
        Username (string) --
        
        The login name of the user.
        
        EmailAddress (string) --
        
        The email address of the user.
        
        GivenName (string) --
        
        The given name of the user.
        
        Surname (string) --
        
        The surname of the user.
        
        OrganizationId (string) --
        
        The ID of the organization.
        
        RootFolderId (string) --
        
        The ID of the root folder.
        
        RecycleBinFolderId (string) --
        
        The ID of the recycle bin folder.
        
        Status (string) --
        
        The status of the user.
        
        Type (string) --
        
        The type of user.
        
        CreatedTimestamp (datetime) --
        
        The time when the user was created.
        
        ModifiedTimestamp (datetime) --
        
        The time when the user was modified.
        
        TimeZoneId (string) --
        
        The time zone ID of the user.
        
        Locale (string) --
        
        The locale of the user.
        
        Storage (dict) --
        
        The storage for the user.
        
        StorageUtilizedInBytes (integer) --
        
        The amount of storage used, in bytes.
        
        StorageRule (dict) --
        
        The storage for a user.
        
        StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
        
        StorageType (string) --
        
        The type of storage.
      - CreatedTimestamp (datetime) --
        
        The timestamp that the comment was created.
      - CommentStatus (string) --
        
        The status of the comment.
      - RecipientId (string) --
        
        The ID of the user being replied to.
- NextToken (string) --
  
  A token to resume pagination.

class WorkDocs.Paginator.DescribeComments¶

paginator = client.get_paginator('describe_comments')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_comments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
VersionId (string) --
[REQUIRED]

The ID of the document version.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Comments': [
        {
            'CommentId': 'string',
            'ParentId': 'string',
            'ThreadId': 'string',
            'Text': 'string',
            'Contributor': {
                'Id': 'string',
                'Username': 'string',
                'EmailAddress': 'string',
                'GivenName': 'string',
                'Surname': 'string',
                'OrganizationId': 'string',
                'RootFolderId': 'string',
                'RecycleBinFolderId': 'string',
                'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
                'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
                'CreatedTimestamp': datetime(2015, 1, 1),
                'ModifiedTimestamp': datetime(2015, 1, 1),
                'TimeZoneId': 'string',
                'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
                'Storage': {
                    'StorageUtilizedInBytes': 123,
                    'StorageRule': {
                        'StorageAllocatedInBytes': 123,
                        'StorageType': 'UNLIMITED'|'QUOTA'
                    }
                }
            },
            'CreatedTimestamp': datetime(2015, 1, 1),
            'Status': 'DRAFT'|'PUBLISHED'|'DELETED',
            'Visibility': 'PUBLIC'|'PRIVATE',
            'RecipientId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Comments (list) --
  
  The list of comments for the specified document version.
  - (dict) --
    
    Describes a comment.
    - CommentId (string) --
      
      The ID of the comment.
    - ParentId (string) --
      
      The ID of the parent comment.
    - ThreadId (string) --
      
      The ID of the root comment in the thread.
    - Text (string) --
      
      The text of the comment.
    - Contributor (dict) --
      
      The details of the user who made the comment.
      - Id (string) --
        
        The ID of the user.
      - Username (string) --
        
        The login name of the user.
      - EmailAddress (string) --
        
        The email address of the user.
      - GivenName (string) --
        
        The given name of the user.
      - Surname (string) --
        
        The surname of the user.
      - OrganizationId (string) --
        
        The ID of the organization.
      - RootFolderId (string) --
        
        The ID of the root folder.
      - RecycleBinFolderId (string) --
        
        The ID of the recycle bin folder.
      - Status (string) --
        
        The status of the user.
      - Type (string) --
        
        The type of user.
      - CreatedTimestamp (datetime) --
        
        The time when the user was created.
      - ModifiedTimestamp (datetime) --
        
        The time when the user was modified.
      - TimeZoneId (string) --
        
        The time zone ID of the user.
      - Locale (string) --
        
        The locale of the user.
      - Storage (dict) --
        
        The storage for the user.
        
        StorageUtilizedInBytes (integer) --
        
        The amount of storage used, in bytes.
        
        StorageRule (dict) --
        
        The storage for a user.
        
        StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
        
        StorageType (string) --
        
        The type of storage.
    - CreatedTimestamp (datetime) --
      
      The time that the comment was created.
    - Status (string) --
      
      The status of the comment.
    - Visibility (string) --
      
      The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
    - RecipientId (string) --
      
      If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.
- NextToken (string) --
  
  A token to resume pagination.

class WorkDocs.Paginator.DescribeDocumentVersions¶

paginator = client.get_paginator('describe_document_versions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_document_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    DocumentId='string',
    Include='string',
    Fields='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
DocumentId (string) --
[REQUIRED]

The ID of the document.
Include (string) -- A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.
Fields (string) -- Specify "SOURCE" to include initialized versions and a URL for the source document.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'DocumentVersions': [
        {
            'Id': 'string',
            'Name': 'string',
            'ContentType': 'string',
            'Size': 123,
            'Signature': 'string',
            'Status': 'INITIALIZED'|'ACTIVE',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ContentCreatedTimestamp': datetime(2015, 1, 1),
            'ContentModifiedTimestamp': datetime(2015, 1, 1),
            'CreatorId': 'string',
            'Thumbnail': {
                'string': 'string'
            },
            'Source': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- DocumentVersions (list) --
  
  The document versions.
  - (dict) --
    
    Describes a version of a document.
    - Id (string) --
      
      The ID of the version.
    - Name (string) --
      
      The name of the version.
    - ContentType (string) --
      
      The content type of the document.
    - Size (integer) --
      
      The size of the document, in bytes.
    - Signature (string) --
      
      The signature of the document.
    - Status (string) --
      
      The status of the document.
    - CreatedTimestamp (datetime) --
      
      The timestamp when the document was first uploaded.
    - ModifiedTimestamp (datetime) --
      
      The timestamp when the document was last uploaded.
    - ContentCreatedTimestamp (datetime) --
      
      The timestamp when the content of the document was originally created.
    - ContentModifiedTimestamp (datetime) --
      
      The timestamp when the content of the document was modified.
    - CreatorId (string) --
      
      The ID of the creator.
    - Thumbnail (dict) --
      
      The thumbnail of the document.
      - (string) --
        
        (string) --
    - Source (dict) --
      
      The source of the document.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  A token to resume pagination.

class WorkDocs.Paginator.DescribeFolderContents¶

paginator = client.get_paginator('describe_folder_contents')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_folder_contents().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    FolderId='string',
    Sort='DATE'|'NAME',
    Order='ASCENDING'|'DESCENDING',
    Type='ALL'|'DOCUMENT'|'FOLDER',
    Include='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
FolderId (string) --
[REQUIRED]

The ID of the folder.
Sort (string) -- The sorting criteria.
Order (string) -- The order for the contents of the folder.
Type (string) -- The type of items.
Include (string) -- The contents to include. Specify "INITIALIZED" to include initialized documents.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Folders': [
        {
            'Id': 'string',
            'Name': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Signature': 'string',
            'Labels': [
                'string',
            ],
            'Size': 123,
            'LatestVersionSize': 123
        },
    ],
    'Documents': [
        {
            'Id': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'LatestVersionMetadata': {
                'Id': 'string',
                'Name': 'string',
                'ContentType': 'string',
                'Size': 123,
                'Signature': 'string',
                'Status': 'INITIALIZED'|'ACTIVE',
                'CreatedTimestamp': datetime(2015, 1, 1),
                'ModifiedTimestamp': datetime(2015, 1, 1),
                'ContentCreatedTimestamp': datetime(2015, 1, 1),
                'ContentModifiedTimestamp': datetime(2015, 1, 1),
                'CreatorId': 'string',
                'Thumbnail': {
                    'string': 'string'
                },
                'Source': {
                    'string': 'string'
                }
            },
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Labels': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Folders (list) --
  
  The subfolders in the specified folder.
  - (dict) --
    
    Describes a folder.
    - Id (string) --
      
      The ID of the folder.
    - Name (string) --
      
      The name of the folder.
    - CreatorId (string) --
      
      The ID of the creator.
    - ParentFolderId (string) --
      
      The ID of the parent folder.
    - CreatedTimestamp (datetime) --
      
      The time when the folder was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the folder was updated.
    - ResourceState (string) --
      
      The resource state of the folder.
    - Signature (string) --
      
      The unique identifier created from the subfolders and documents of the folder.
    - Labels (list) --
      
      List of labels on the folder.
      - (string) --
    - Size (integer) --
      
      The size of the folder metadata.
    - LatestVersionSize (integer) --
      
      The size of the latest version of the folder metadata.
- Documents (list) --
  
  The documents in the specified folder.
  - (dict) --
    
    Describes the document.
    - Id (string) --
      
      The ID of the document.
    - CreatorId (string) --
      
      The ID of the creator.
    - ParentFolderId (string) --
      
      The ID of the parent folder.
    - CreatedTimestamp (datetime) --
      
      The time when the document was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the document was updated.
    - LatestVersionMetadata (dict) --
      
      The latest version of the document.
      - Id (string) --
        
        The ID of the version.
      - Name (string) --
        
        The name of the version.
      - ContentType (string) --
        
        The content type of the document.
      - Size (integer) --
        
        The size of the document, in bytes.
      - Signature (string) --
        
        The signature of the document.
      - Status (string) --
        
        The status of the document.
      - CreatedTimestamp (datetime) --
        
        The timestamp when the document was first uploaded.
      - ModifiedTimestamp (datetime) --
        
        The timestamp when the document was last uploaded.
      - ContentCreatedTimestamp (datetime) --
        
        The timestamp when the content of the document was originally created.
      - ContentModifiedTimestamp (datetime) --
        
        The timestamp when the content of the document was modified.
      - CreatorId (string) --
        
        The ID of the creator.
      - Thumbnail (dict) --
        
        The thumbnail of the document.
        
        (string) --
        
        (string) --
      - Source (dict) --
        
        The source of the document.
        
        (string) --
        
        (string) --
    - ResourceState (string) --
      
      The resource state.
    - Labels (list) --
      
      List of labels on the document.
      - (string) --
- NextToken (string) --
  
  A token to resume pagination.

class WorkDocs.Paginator.DescribeGroups¶

paginator = client.get_paginator('describe_groups')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    SearchQuery='string',
    OrganizationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
SearchQuery (string) --
[REQUIRED]

A query to describe groups by group name.
OrganizationId (string) -- The ID of the organization.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Groups': [
        {
            'Id': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Groups (list) --
  
  The list of groups.
  - (dict) --
    
    Describes the metadata of a user group.
    - Id (string) --
      
      The ID of the user group.
    - Name (string) --
      
      The name of the group.
- NextToken (string) --
  
  A token to resume pagination.

class WorkDocs.Paginator.DescribeNotificationSubscriptions¶

paginator = client.get_paginator('describe_notification_subscriptions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_notification_subscriptions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

OrganizationId (string) --
[REQUIRED]

The ID of the organization.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Subscriptions': [
        {
            'SubscriptionId': 'string',
            'EndPoint': 'string',
            'Protocol': 'HTTPS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Subscriptions (list) --
  
  The subscriptions.
  - (dict) --
    
    Describes a subscription.
    - SubscriptionId (string) --
      
      The ID of the subscription.
    - EndPoint (string) --
      
      The endpoint of the subscription.
    - Protocol (string) --
      
      The protocol of the subscription.
- NextToken (string) --
  
  A token to resume pagination.

class WorkDocs.Paginator.DescribeResourcePermissions¶

paginator = client.get_paginator('describe_resource_permissions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_resource_permissions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    ResourceId='string',
    PrincipalId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
ResourceId (string) --
[REQUIRED]

The ID of the resource.
PrincipalId (string) -- The ID of the principal to filter permissions by.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Principals': [
        {
            'Id': 'string',
            'Type': 'USER'|'GROUP'|'INVITE'|'ANONYMOUS'|'ORGANIZATION',
            'Roles': [
                {
                    'Role': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'COOWNER',
                    'Type': 'DIRECT'|'INHERITED'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Principals (list) --
  
  The principals.
  - (dict) --
    
    Describes a resource.
    - Id (string) --
      
      The ID of the resource.
    - Type (string) --
      
      The type of resource.
    - Roles (list) --
      
      The permission information for the resource.
      - (dict) --
        
        Describes the permissions.
        
        Role (string) --
        
        The role of the user.
        
        Type (string) --
        
        The type of permissions.
- NextToken (string) --
  
  A token to resume pagination.

class WorkDocs.Paginator.DescribeRootFolders¶

paginator = client.get_paginator('describe_root_folders')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_root_folders().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AuthenticationToken (string) --
[REQUIRED]

Amazon WorkDocs authentication token.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Folders': [
        {
            'Id': 'string',
            'Name': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Signature': 'string',
            'Labels': [
                'string',
            ],
            'Size': 123,
            'LatestVersionSize': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Folders (list) --
  
  The user's special folders.
  - (dict) --
    
    Describes a folder.
    - Id (string) --
      
      The ID of the folder.
    - Name (string) --
      
      The name of the folder.
    - CreatorId (string) --
      
      The ID of the creator.
    - ParentFolderId (string) --
      
      The ID of the parent folder.
    - CreatedTimestamp (datetime) --
      
      The time when the folder was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the folder was updated.
    - ResourceState (string) --
      
      The resource state of the folder.
    - Signature (string) --
      
      The unique identifier created from the subfolders and documents of the folder.
    - Labels (list) --
      
      List of labels on the folder.
      - (string) --
    - Size (integer) --
      
      The size of the folder metadata.
    - LatestVersionSize (integer) --
      
      The size of the latest version of the folder metadata.
- NextToken (string) --
  
  A token to resume pagination.

class WorkDocs.Paginator.DescribeUsers¶

paginator = client.get_paginator('describe_users')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_users().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    OrganizationId='string',
    UserIds='string',
    Query='string',
    Include='ALL'|'ACTIVE_PENDING',
    Order='ASCENDING'|'DESCENDING',
    Sort='USER_NAME'|'FULL_NAME'|'STORAGE_LIMIT'|'USER_STATUS'|'STORAGE_USED',
    Fields='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AuthenticationToken (string) -- Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
OrganizationId (string) -- The ID of the organization.
UserIds (string) -- The IDs of the users.
Query (string) -- A query to filter users by user name.
Include (string) -- The state of the users. Specify "ALL" to include inactive users.
Order (string) -- The order for the results.
Sort (string) -- The sorting criteria.
Fields (string) -- A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Users': [
        {
            'Id': 'string',
            'Username': 'string',
            'EmailAddress': 'string',
            'GivenName': 'string',
            'Surname': 'string',
            'OrganizationId': 'string',
            'RootFolderId': 'string',
            'RecycleBinFolderId': 'string',
            'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
            'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'TimeZoneId': 'string',
            'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
            'Storage': {
                'StorageUtilizedInBytes': 123,
                'StorageRule': {
                    'StorageAllocatedInBytes': 123,
                    'StorageType': 'UNLIMITED'|'QUOTA'
                }
            }
        },
    ],
    'TotalNumberOfUsers': 123,
    'NextToken': 'string'
}

Response Structure

(dict) --
- Users (list) --
  
  The users.
  - (dict) --
    
    Describes a user.
    - Id (string) --
      
      The ID of the user.
    - Username (string) --
      
      The login name of the user.
    - EmailAddress (string) --
      
      The email address of the user.
    - GivenName (string) --
      
      The given name of the user.
    - Surname (string) --
      
      The surname of the user.
    - OrganizationId (string) --
      
      The ID of the organization.
    - RootFolderId (string) --
      
      The ID of the root folder.
    - RecycleBinFolderId (string) --
      
      The ID of the recycle bin folder.
    - Status (string) --
      
      The status of the user.
    - Type (string) --
      
      The type of user.
    - CreatedTimestamp (datetime) --
      
      The time when the user was created.
    - ModifiedTimestamp (datetime) --
      
      The time when the user was modified.
    - TimeZoneId (string) --
      
      The time zone ID of the user.
    - Locale (string) --
      
      The locale of the user.
    - Storage (dict) --
      
      The storage for the user.
      - StorageUtilizedInBytes (integer) --
        
        The amount of storage used, in bytes.
      - StorageRule (dict) --
        
        The storage for a user.
        
        StorageAllocatedInBytes (integer) --
        
        The amount of storage allocated, in bytes.
        
        StorageType (string) --
        
        The type of storage.
- TotalNumberOfUsers (integer) --
  
  The total number of users included in the results.
- NextToken (string) --
  
  A token to resume pagination.

Navigation

Table Of Contents

WorkDocs¶

Client¶

Paginators¶

Navigation

WorkDocs ¶

Client ¶

Paginators ¶