root_folders

Creates, updates, deletes, gets or lists a root_folders resource.

Overview

Name	root_folders
Type	Resource
Id	aws.workdocs.root_folders

Fields

The following fields are returned by SELECT queries:

describe_root_folders

Name	Datatype	Description
created_timestamp	string (date-time)	The time when the folder was created.
creator_id	string	The ID of the creator. (pattern: <code>[&\w+-.@]+</code>)
id	string	The ID of the folder. (pattern: <code>[\w+-.@]+</code>)
labels	array	List of labels on the folder.
latest_version_size	integer (int64)	The size of the latest version of the folder metadata.
modified_timestamp	string (date-time)	The time when the folder was updated.
name	string	The name of the folder. (pattern: <code>[\u0020-\u202D\u202F-\uFFFF]+</code>)
parent_folder_id	string	The ID of the parent folder. (pattern: <code>[\w+-.@]+</code>)
resource_state	string	The resource state of the folder. (ACTIVE, RESTORING, RECYCLING, RECYCLED)
signature	string	The unique identifier created from the subfolders and documents of the folder. (pattern: <code>[&\w+-.@]+</code>)
size	integer (int64)	The size of the folder metadata.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_root_folders	select	Authentication, region	limit, marker	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
Authentication	string	Amazon WorkDocs authentication token.
region	string	AWS region (default: us-east-1)
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.)

SELECT examples

describe_root_folders

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.

SELECT
created_timestamp,
creator_id,
id,
labels,
latest_version_size,
modified_timestamp,
name,
parent_folder_id,
resource_state,
signature,
size
FROM aws.workdocs.root_folders
WHERE Authentication = '{{ Authentication }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND marker = '{{ marker }}'
;