WorkDocs / Client / describe_folder_contents

describe_folder_contents

WorkDocs.Client.describe_folder_contents(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_folder_contents(
    AuthenticationToken='string',
    FolderId='string',
    Sort='DATE'|'NAME',
    Order='ASCENDING'|'DESCENDING',
    Limit=123,
    Marker='string',
    Type='ALL'|'DOCUMENT'|'FOLDER',
    Include='string'
)

Parameters:

• AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

• FolderId (string) –

  [REQUIRED]

  The ID of the folder.

• Sort (string) – The sorting criteria.

• Order (string) – The order for the contents of the folder.

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

• Type (string) – The type of items.

• Include (string) – The contents to include. Specify “INITIALIZED” to include initialized documents.

Return type:

dict

Returns:

Response Syntax

{
    'Folders': [
        {
            'Id': 'string',
            'Name': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Signature': 'string',
            'Labels': [
                'string',
            ],
            'Size': 123,
            'LatestVersionSize': 123
        },
    ],
    'Documents': [
        {
            'Id': 'string',
            'CreatorId': 'string',
            'ParentFolderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'LatestVersionMetadata': {
                'Id': 'string',
                'Name': 'string',
                'ContentType': 'string',
                'Size': 123,
                'Signature': 'string',
                'Status': 'INITIALIZED'|'ACTIVE',
                'CreatedTimestamp': datetime(2015, 1, 1),
                'ModifiedTimestamp': datetime(2015, 1, 1),
                'ContentCreatedTimestamp': datetime(2015, 1, 1),
                'ContentModifiedTimestamp': datetime(2015, 1, 1),
                'CreatorId': 'string',
                'Thumbnail': {
                    'string': 'string'
                },
                'Source': {
                    'string': 'string'
                }
            },
            'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
            'Labels': [
                'string',
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

  • Folders (list) –

    The subfolders in the specified folder.

    • (dict) –

      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 (datetime) –

        The time when the folder was created.

      • ModifiedTimestamp (datetime) –

        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 (integer) –

        The size of the folder metadata.

      • LatestVersionSize (integer) –

        The size of the latest version of the folder metadata.

  • Documents (list) –

    The documents in the specified folder.

    • (dict) –

      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 (datetime) –

        The time when the document was created.

      • ModifiedTimestamp (datetime) –

        The time when the document was updated.

      • LatestVersionMetadata (dict) –

        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 (integer) –

          The size of the document, in bytes.

        • Signature (string) –

          The signature of the document.

        • Status (string) –

          The status of the document.

        • CreatedTimestamp (datetime) –

          The timestamp when the document was first uploaded.

        • ModifiedTimestamp (datetime) –

          The timestamp when the document was last uploaded.

        • ContentCreatedTimestamp (datetime) –

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

        • ContentModifiedTimestamp (datetime) –

          The timestamp when the content of the document was modified.

        • CreatorId (string) –

          The ID of the creator.

        • Thumbnail (dict) –

          The thumbnail of the document.

          • (string) –

            • (string) –

        • Source (dict) –

          The source of the document.

          • (string) –

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

Exceptions

• WorkDocs.Client.exceptions.EntityNotExistsException

• WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

• WorkDocs.Client.exceptions.InvalidArgumentException

• WorkDocs.Client.exceptions.FailedDependencyException

• WorkDocs.Client.exceptions.ServiceUnavailableException

• WorkDocs.Client.exceptions.ProhibitedStateException