[ aws . workdocs ]

get-resources

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-resources
[--authentication-token <value>]
[--user-id <value>]
[--collection-type <value>]
[--limit <value>]
[--marker <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--authentication-token (string)

The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

--user-id (string)

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

--collection-type (string)

The collection type.

Possible values:

• SHARED_WITH_ME

--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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve shared resources

The following get-resources example retrieves the resources shared with the specified Amazon WorkDocs user.

aws workdocs get-resources \
    --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333" \
    --collection-type SHARED_WITH_ME

Output:

{
"Folders": [],
"Documents": []
}

For more information, see Sharing Files and Folders in the Amazon WorkDocs User Guide.

Output

Folders -> (list)

The folders in the specified folder.

(structure)

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 -> (timestamp)

The time when the folder was created.

ModifiedTimestamp -> (timestamp)

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 -> (long)

The size of the folder metadata.

LatestVersionSize -> (long)

The size of the latest version of the folder metadata.

Documents -> (list)

The documents in the specified collection.

(structure)

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 -> (timestamp)

The time when the document was created.

ModifiedTimestamp -> (timestamp)

The time when the document was updated.

LatestVersionMetadata -> (structure)

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 -> (long)

The size of the document, in bytes.

Signature -> (string)

The signature of the document.

Status -> (string)

The status of the document.

CreatedTimestamp -> (timestamp)

The timestamp when the document was first uploaded.

ModifiedTimestamp -> (timestamp)

The timestamp when the document was last uploaded.

ContentCreatedTimestamp -> (timestamp)

The timestamp when the content of the document was originally created.

ContentModifiedTimestamp -> (timestamp)

The timestamp when the content of the document was modified.

CreatorId -> (string)

The ID of the creator.

Thumbnail -> (map)

The thumbnail of the document.

key -> (string)

value -> (string)

Source -> (map)

The source of the document.

key -> (string)

value -> (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.