2023/03/20 - Amazon WorkDocs - 1 new1 updated api methods
Changes This release adds a new API, SearchResources, which enable users to search through metadata and content of folders, documents, document versions and comments in a WorkDocs site.
Searches metadata and the content of folders, documents, document versions, and comments.
See also: AWS API Documentation
Request Syntax
client.search_resources(
AuthenticationToken='string',
QueryText='string',
QueryScopes=[
'NAME'|'CONTENT',
],
OrganizationId='string',
AdditionalResponseFields=[
'WEBURL',
],
Filters={
'TextLocales': [
'AR'|'BG'|'BN'|'DA'|'DE'|'CS'|'EL'|'EN'|'ES'|'FA'|'FI'|'FR'|'HI'|'HU'|'ID'|'IT'|'JA'|'KO'|'LT'|'LV'|'NL'|'NO'|'PT'|'RO'|'RU'|'SV'|'SW'|'TH'|'TR'|'ZH'|'DEFAULT',
],
'ContentCategories': [
'IMAGE'|'DOCUMENT'|'PDF'|'SPREADSHEET'|'PRESENTATION'|'AUDIO'|'VIDEO'|'SOURCE_CODE'|'OTHER',
],
'ResourceTypes': [
'FOLDER'|'DOCUMENT'|'COMMENT'|'DOCUMENT_VERSION',
],
'Labels': [
'string',
],
'Principals': [
{
'Id': 'string',
'Roles': [
'VIEWER'|'CONTRIBUTOR'|'OWNER'|'COOWNER',
]
},
],
'AncestorIds': [
'string',
],
'SearchCollectionTypes': [
'OWNED'|'SHARED_WITH_ME',
],
'SizeRange': {
'StartValue': 123,
'EndValue': 123
},
'CreatedRange': {
'StartValue': datetime(2015, 1, 1),
'EndValue': datetime(2015, 1, 1)
},
'ModifiedRange': {
'StartValue': datetime(2015, 1, 1),
'EndValue': datetime(2015, 1, 1)
}
},
OrderBy=[
{
'Field': 'RELEVANCE'|'NAME'|'SIZE'|'CREATED_TIMESTAMP'|'MODIFIED_TIMESTAMP',
'Order': 'ASC'|'DESC'
},
],
Limit=123,
Marker='string'
)
string
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
string
The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.
list
Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
(string) --
string
Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
list
A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
(string) --
dict
Filters results based on entity metadata.
TextLocales (list) --
Filters by the locale of the content or comment.
(string) --
ContentCategories (list) --
Filters by content category.
(string) --
ResourceTypes (list) --
Filters based on entity type.
(string) --
Labels (list) --
Filter by labels using exact match.
(string) --
Principals (list) --
Filter based on UserIds or GroupIds.
(dict) --
Filter based on UserIds or GroupIds.
Id (string) -- [REQUIRED]
UserIds or GroupIds.
Roles (list) --
The Role of a User or Group.
(string) --
AncestorIds (list) --
Filter based on resource’s path.
(string) --
SearchCollectionTypes (list) --
Filter based on file groupings.
(string) --
SizeRange (dict) --
Filter based on size (in bytes).
StartValue (integer) --
The size start range (in bytes).
EndValue (integer) --
The size end range (in bytes).
CreatedRange (dict) --
Filter based on resource’s creation timestamp.
StartValue (datetime) --
Timestamp range start value (in epochs)
EndValue (datetime) --
Timestamp range end value (in epochs).
ModifiedRange (dict) --
Filter based on resource’s modified timestamp.
StartValue (datetime) --
Timestamp range start value (in epochs)
EndValue (datetime) --
Timestamp range end value (in epochs).
list
Order by results in one or more categories.
(dict) --
The result of the sort operation.
Field (string) --
Sort search results based on this field name.
Order (string) --
Sort direction.
integer
Max results count per page.
string
The marker for the next set of results.
dict
Response Syntax
{
'Items': [
{
'ResourceType': 'DOCUMENT'|'FOLDER'|'COMMENT'|'DOCUMENT_VERSION',
'WebUrl': 'string',
'DocumentMetadata': {
'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',
]
},
'FolderMetadata': {
'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
},
'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',
'ContributorId': 'string'
},
'DocumentVersionMetadata': {
'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) --
Items (list) --
List of Documents, Folders, Comments, and Document Versions matching the query.
(dict) --
List of Documents, Folders, Comments, and Document Versions matching the query.
ResourceType (string) --
The type of item being returned.
WebUrl (string) --
The webUrl of the item being returned.
DocumentMetadata (dict) --
The document that matches the query.
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) --
FolderMetadata (dict) --
The folder that matches the query.
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.
CommentMetadata (dict) --
The comment that matches the query.
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.
ContributorId (string) --
The ID of the user who made the comment.
DocumentVersionMetadata (dict) --
The document version that matches the 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) --
Marker (string) --
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
{'UserActivities': {'CommentMetadata': {'ContributorId': 'string'}}}
Describes the user activities in a specified time period.
See also: AWS API Documentation
Request Syntax
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'
)
string
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
datetime
The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
datetime
The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
string
The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
string
Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
string
The document or folder ID for which to describe activity types.
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.
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).
integer
The maximum number of items to return.
string
The marker for the next set of results.
dict
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',
'ContributorId': '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.
ContributorId (string) --
The ID of the user who made the comment.
Marker (string) --
The marker for the next set of results.