folder_contents

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

Overview

Name	folder_contents
Type	Resource
Id	aws.workdocs.folder_contents

Fields

The following fields are returned by SELECT queries:

describe_folder_contents

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_folder_contents	select	folder_id, region	Authentication, sort, order, limit, marker, type, include	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.
delete_folder_contents	delete	folder_id, region	Authentication	Deletes the contents of the specified folder.

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
folder_id	string	The ID of the folder.
region	string	AWS region (default: us-east-1)
Authentication	string	Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
include	string	The contents to include. Specify "INITIALIZED" to include initialized documents.
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.
order	string	The order for the contents of the folder.
sort	string	The sorting criteria.
type	string	The type of items.

SELECT examples

describe_folder_contents

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.

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

DELETE examples

delete_folder_contents

Deletes the contents of the specified folder.

DELETE FROM aws.workdocs.folder_contents
WHERE folder_id = '{{ folder_id }}' --required
AND region = '{{ region }}' --required
AND Authentication = '{{ Authentication }}'
;