[ aws . workdocs ]

get-folder

Description

Retrieves the metadata of the specified folder.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-folder
[--authentication-token <value>]
--folder-id <value>
[--include-custom-metadata | --no-include-custom-metadata]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--authentication-token (string)

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

--folder-id (string)

The ID of the folder.

--include-custom-metadata | --no-include-custom-metadata (boolean)

Set to TRUE to include custom metadata in the response.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve the metadata for a folder

This example retrieves the metadata for the specified folder.

Command:

aws workdocs get-folder --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08

Output:

{
  "Metadata": {
      "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08",
      "Name": "exampleFolder",
      "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
      "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
      "CreatedTimestamp": 1534450467.622,
      "ModifiedTimestamp": 1534451113.504,
      "ResourceState": "ACTIVE",
      "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
      "Size": 23019,
      "LatestVersionSize": 11537
  }
}

Output

Metadata -> (structure)

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

CustomMetadata -> (map)

The custom metadata on the folder.

key -> (string)

value -> (string)