aws workdocs get-document-path

Retrieves the path information (the hierarchy from the root folder) for the requested document. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To retrieve a document's path information

The following get-document-path example retrieves the path information (hierarchy from the root folder) for the specified document, and includes the names of the parent folders.

aws workdocs get-document-path --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --fields NAME

Identify

--document-idThe ID of the document.

--fieldsA comma-separated list of values.

Its output

{
    "Path": {
        "Components": [
            {
                "Id": "a43d29cbb8e7c4d25cfee8b803a504b0dc63e760b55ad0c611c6b87691eb6ff3",
                "Name": "/"
            },
            {
                "Id": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
                "Name": "Top Level Folder"
            },
            {
                "Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
                "Name": "exampleDoc.docx"
            }
        ]
    }
}

Options

5 in the AWS CLI reference

--authentication-tokenAmazon WorkDocs authentication token.

--document-idThe ID of the document.

--fieldsA comma-separated list of values.

--limitThe maximum number of levels in the hierarchy to return.

--markerThis value is not supported.