You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkDocs::Types::DescribeFolderContentsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeFolderContentsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  authentication_token: "AuthenticationHeaderType",
  folder_id: "ResourceIdType", # required
  sort: "DATE", # accepts DATE, NAME
  order: "ASCENDING", # accepts ASCENDING, DESCENDING
  limit: 1,
  marker: "PageMarkerType",
  type: "ALL", # accepts ALL, DOCUMENT, FOLDER
  include: "FieldNamesType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)

    Amazon WorkDocs authentication token.

#folder_idString

The ID of the folder.

Returns:

  • (String)

    The ID of the folder.

#includeString

The contents to include. Specify \"INITIALIZED\" to include initialized documents.

Returns:

  • (String)

    The contents to include.

#limitInteger

The maximum number of items to return with this call.

Returns:

  • (Integer)

    The maximum number of items to return with this call.

#markerString

The marker for the next set of results. This marker was received from a previous call.

Returns:

  • (String)

    The marker for the next set of results.

#orderString

The order for the contents of the folder.

Possible values:

  • ASCENDING
  • DESCENDING

Returns:

  • (String)

    The order for the contents of the folder.

#sortString

The sorting criteria.

Possible values:

  • DATE
  • NAME

Returns:

  • (String)

    The sorting criteria.

#typeString

The type of items.

Possible values:

  • ALL
  • DOCUMENT
  • FOLDER

Returns:

  • (String)

    The type of items.