2017/03/08 - Amazon WorkDocs - 29 new api methods
Changes Amazon WorkDocs API provides full administrator level access to WorkDocs site resources, allowing developers to integrate their applications to manage WorkDocs users, content and permissions programmatically.
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
client.update_user(
UserId='string',
GivenName='string',
Surname='string',
Type='USER'|'ADMIN',
StorageRule={
'StorageAllocatedInBytes': 123,
'StorageType': 'UNLIMITED'|'QUOTA'
},
TimeZoneId='string',
Locale='en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default'
)
string
[REQUIRED]
The ID of the user.
string
The given name of the user.
string
The surname of the user.
string
The type of the user.
dict
The amount of storage for the user.
StorageAllocatedInBytes (integer) --
The amount of storage allocated, in bytes.
StorageType (string) --
The type of storage.
string
The time zone ID of the user.
string
The locale of the user.
dict
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',
'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 utilized, in bytes.
StorageRule (dict) --
The storage for a user.
StorageAllocatedInBytes (integer) --
The amount of storage allocated, in bytes.
StorageType (string) --
The type of storage.
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
client.describe_users(
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'
)
string
The ID of the organization.
string
The IDs of the users.
string
A query to filter users by user name.
string
The state of the users. Specify "ALL" to include inactive users.
string
The order for the results.
string
The sorting criteria.
string
The marker for the next set of results. (You received this marker from a previous call.)
integer
The maximum number of items to return.
string
A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.
dict
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',
'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 utilized, 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.
Configure WorkDocs to use Amazon SNS notifications.
The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription in the Amazon Simple Notification Service Developer Guide .
See also: AWS API Documentation
Request Syntax
client.create_notification_subscription(
OrganizationId='string',
Endpoint='string',
Protocol='HTTPS',
SubscriptionType='ALL'
)
string
[REQUIRED]
The ID of the organization.
string
[REQUIRED]
The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with "https://".
string
[REQUIRED]
The protocol to use. The supported value is https, which delivers JSON-encoded messasges using HTTPS POST.
string
[REQUIRED]
The notification type.
dict
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.
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
client.get_folder_path(
FolderId='string',
Limit=123,
Fields='string',
Marker='string'
)
string
[REQUIRED]
The ID of the folder.
integer
The maximum number of levels in the hierarchy to return.
string
A comma-separated list of values. Specify "NAME" to include the names of the parent folders.
string
This value is not supported.
dict
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.
Deletes the specified user from a Simple AD or Microsoft AD directory.
See also: AWS API Documentation
Request Syntax
client.delete_user(
UserId='string'
)
string
[REQUIRED]
The ID of the user.
None
Deletes the specified subscription from the specified organization.
See also: AWS API Documentation
Request Syntax
client.delete_notification_subscription(
SubscriptionId='string',
OrganizationId='string'
)
string
[REQUIRED]
The ID of the subscription.
string
[REQUIRED]
The ID of the organization.
None
Creates a folder with the specified name and parent folder.
See also: AWS API Documentation
Request Syntax
client.create_folder(
Name='string',
ParentFolderId='string'
)
string
The name of the new folder.
string
[REQUIRED]
The ID of the parent folder.
dict
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'
}
}
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.
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
client.update_document_version(
DocumentId='string',
VersionId='string',
VersionStatus='ACTIVE'
)
string
[REQUIRED]
The ID of the document.
string
[REQUIRED]
The version ID of the document.
string
The status of the version.
None
Lists the specified notification subscriptions.
See also: AWS API Documentation
Request Syntax
client.describe_notification_subscriptions(
OrganizationId='string',
Marker='string',
Limit=123
)
string
[REQUIRED]
The ID of the organization.
string
The marker for the next set of results. (You received this marker from a previous call.)
integer
The maximum number of items to return with this call.
dict
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.
Deletes the contents of the specified folder.
See also: AWS API Documentation
Request Syntax
client.delete_folder_contents(
FolderId='string'
)
string
[REQUIRED]
The ID of the folder.
None
Describes the contents of the specified folder, including its documents and sub-folders.
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
client.describe_folder_contents(
FolderId='string',
Sort='DATE'|'NAME',
Order='ASCENDING'|'DESCENDING',
Limit=123,
Marker='string',
Type='ALL'|'DOCUMENT'|'FOLDER',
Include='string'
)
string
[REQUIRED]
The ID of the folder.
string
The sorting criteria.
string
The order for the contents of the folder.
integer
The maximum number of items to return with this call.
string
The marker for the next set of results. (You received this marker from a previous call.)
string
The type of items.
string
The contents to include. Specify "INITIALIZED" to include initialized documents.
dict
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'
},
],
'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'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Folders (list) --
The sub-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.
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 time stamp when the document was first uploaded.
ModifiedTimestamp (datetime) --
The time stamp when the document was last uploaded.
ContentCreatedTimestamp (datetime) --
The time stamp when the content of the document was originally created.
ContentModifiedTimestamp (datetime) --
The time stamp 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.
Marker (string) --
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
Retrieves the metadata of the specified folder.
See also: AWS API Documentation
Request Syntax
client.get_folder(
FolderId='string'
)
string
[REQUIRED]
The ID of the folder.
dict
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'
}
}
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.
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
See also: AWS API Documentation
Request Syntax
client.deactivate_user(
UserId='string'
)
string
[REQUIRED]
The ID of the user.
None
Removes the permission for the specified principal from the specified resource.
See also: AWS API Documentation
Request Syntax
client.remove_resource_permission(
ResourceId='string',
PrincipalId='string',
PrincipalType='USER'|'GROUP'|'INVITE'|'ANONYMOUS'|'ORGANIZATION'
)
string
[REQUIRED]
The ID of the resource.
string
[REQUIRED]
The principal ID of the resource.
string
The principal type of the resource.
None
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
client.initiate_document_version_upload(
Id='string',
Name='string',
ContentCreatedTimestamp=datetime(2015, 1, 1),
ContentModifiedTimestamp=datetime(2015, 1, 1),
ContentType='string',
DocumentSizeInBytes=123,
ParentFolderId='string'
)
string
The ID of the document.
string
The name of the document.
datetime
The time stamp when the content of the document was originally created.
datetime
The time stamp when the content of the document was modified.
string
The content type of the document.
integer
The size of the document, in bytes.
string
[REQUIRED]
The ID of the parent folder.
dict
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'
},
'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 time stamp when the document was first uploaded.
ModifiedTimestamp (datetime) --
The time stamp when the document was last uploaded.
ContentCreatedTimestamp (datetime) --
The time stamp when the content of the document was originally created.
ContentModifiedTimestamp (datetime) --
The time stamp 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.
UploadMetadata (dict) --
The upload metadata.
UploadUrl (string) --
The URL of the upload.
SignedHeaders (dict) --
The signed headers.
(string) --
(string) --
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
client.add_resource_permissions(
ResourceId='string',
Principals=[
{
'Id': 'string',
'Type': 'USER'|'GROUP'|'INVITE'|'ANONYMOUS'|'ORGANIZATION',
'Role': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'COOWNER'
},
]
)
string
[REQUIRED]
The ID of the resource.
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.
dict
Response Syntax
{
'ShareResults': [
{
'PrincipalId': '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.
Role (string) --
The role.
Status (string) --
The status.
ShareId (string) --
The ID of the resource that was shared.
StatusMessage (string) --
The status message.
Retrieves version metadata for the specified document.
See also: AWS API Documentation
Request Syntax
client.get_document_version(
DocumentId='string',
VersionId='string',
Fields='string'
)
string
[REQUIRED]
The ID of the document.
string
[REQUIRED]
The version ID of the document.
string
A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.
dict
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'
}
}
}
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 time stamp when the document was first uploaded.
ModifiedTimestamp (datetime) --
The time stamp when the document was last uploaded.
ContentCreatedTimestamp (datetime) --
The time stamp when the content of the document was originally created.
ContentModifiedTimestamp (datetime) --
The time stamp 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) --
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
client.create_user(
OrganizationId='string',
Username='string',
GivenName='string',
Surname='string',
Password='string',
TimeZoneId='string',
StorageRule={
'StorageAllocatedInBytes': 123,
'StorageType': 'UNLIMITED'|'QUOTA'
}
)
string
The ID of the organization.
string
[REQUIRED]
The login name of the user.
string
[REQUIRED]
The given name of the user.
string
[REQUIRED]
The surname of the user.
string
[REQUIRED]
The password of the user.
string
The time zone ID of the user.
dict
The amount of storage for the user.
StorageAllocatedInBytes (integer) --
The amount of storage allocated, in bytes.
StorageType (string) --
The type of storage.
dict
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',
'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 utilized, in bytes.
StorageRule (dict) --
The storage for a user.
StorageAllocatedInBytes (integer) --
The amount of storage allocated, in bytes.
StorageType (string) --
The type of storage.
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 or fails to upload the document version.
See also: AWS API Documentation
Request Syntax
client.abort_document_version_upload(
DocumentId='string',
VersionId='string'
)
string
[REQUIRED]
The ID of the document.
string
[REQUIRED]
The ID of the version.
None
Permanently deletes the specified document and its associated metadata.
See also: AWS API Documentation
Request Syntax
client.delete_document(
DocumentId='string'
)
string
[REQUIRED]
The ID of the document.
None
Activates the specified user. Only active users can access Amazon WorkDocs.
See also: AWS API Documentation
Request Syntax
client.activate_user(
UserId='string'
)
string
[REQUIRED]
The ID of the user.
dict
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',
'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 utilized, in bytes.
StorageRule (dict) --
The storage for a user.
StorageAllocatedInBytes (integer) --
The amount of storage allocated, in bytes.
StorageType (string) --
The type of storage.
Permanently deletes the specified folder and its contents.
See also: AWS API Documentation
Request Syntax
client.delete_folder(
FolderId='string'
)
string
[REQUIRED]
The ID of the folder.
None
Retrieves the document versions for the specified document.
By default, only active versions are returned.
See also: AWS API Documentation
Request Syntax
client.describe_document_versions(
DocumentId='string',
Marker='string',
Limit=123,
Include='string',
Fields='string'
)
string
[REQUIRED]
The ID of the document.
string
The marker for the next set of results. (You received this marker from a previous call.)
integer
The maximum number of versions to return with this call.
string
A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.
string
Specify "SOURCE" to include initialized versions and a URL for the source document.
dict
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 time stamp when the document was first uploaded.
ModifiedTimestamp (datetime) --
The time stamp when the document was last uploaded.
ContentCreatedTimestamp (datetime) --
The time stamp when the content of the document was originally created.
ContentModifiedTimestamp (datetime) --
The time stamp 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.
Retrieves the specified document object.
See also: AWS API Documentation
Request Syntax
client.get_document(
DocumentId='string'
)
string
[REQUIRED]
The ID of the document object.
dict
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'
}
}
Response Structure
(dict) --
Metadata (dict) --
The document object.
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 time stamp when the document was first uploaded.
ModifiedTimestamp (datetime) --
The time stamp when the document was last uploaded.
ContentCreatedTimestamp (datetime) --
The time stamp when the content of the document was originally created.
ContentModifiedTimestamp (datetime) --
The time stamp 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.
Describes the permissions of a specified resource.
See also: AWS API Documentation
Request Syntax
client.describe_resource_permissions(
ResourceId='string',
Limit=123,
Marker='string'
)
string
[REQUIRED]
The ID of the resource.
integer
The maximum number of items to return with this call.
string
The marker for the next set of results. (You received this marker from a previous call)
dict
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.
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
client.update_folder(
FolderId='string',
Name='string',
ParentFolderId='string',
ResourceState='ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED'
)
string
[REQUIRED]
The ID of the folder.
string
The name of the folder.
string
The ID of the parent folder.
string
The resource state of the folder. Note that only ACTIVE and RECYCLED are accepted values from the API.
None
Updates the specified attributes of the specified document. The user must have access to both the document and its parent folder, if applicable.
See also: AWS API Documentation
Request Syntax
client.update_document(
DocumentId='string',
Name='string',
ParentFolderId='string',
ResourceState='ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED'
)
string
[REQUIRED]
The ID of the document.
string
The name of the document.
string
The ID of the parent folder.
string
The resource state of the document. Note that only ACTIVE and RECYCLED are supported.
None
Removes all the permissions from the specified resource.
See also: AWS API Documentation
Request Syntax
client.remove_all_resource_permissions(
ResourceId='string'
)
string
[REQUIRED]
The ID of the resource.
None
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
client.get_document_path(
DocumentId='string',
Limit=123,
Fields='string',
Marker='string'
)
string
[REQUIRED]
The ID of the document.
integer
The maximum number of levels in the hierarchy to return.
string
A comma-separated list of values. Specify "NAME" to include the names of the parent folders.
string
This value is not supported.
dict
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.