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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Note:

When making an API call, you may pass DescribeFolderContentsRequest data as a 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. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1150

class DescribeFolderContentsRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :sort,
  :order,
  :limit,
  :marker,
  :type,
  :include)
  include Aws::Structure
end

#folder_idString

The ID of the folder.

Returns:

  • (String)


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1150

class DescribeFolderContentsRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :sort,
  :order,
  :limit,
  :marker,
  :type,
  :include)
  include Aws::Structure
end

#includeString

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

Returns:

  • (String)


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1150

class DescribeFolderContentsRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :sort,
  :order,
  :limit,
  :marker,
  :type,
  :include)
  include Aws::Structure
end

#limitInteger

The maximum number of items to return with this call.

Returns:

  • (Integer)


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1150

class DescribeFolderContentsRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :sort,
  :order,
  :limit,
  :marker,
  :type,
  :include)
  include Aws::Structure
end

#markerString

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

Returns:

  • (String)


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1150

class DescribeFolderContentsRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :sort,
  :order,
  :limit,
  :marker,
  :type,
  :include)
  include Aws::Structure
end

#orderString

The order for the contents of the folder.

Returns:

  • (String)


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1150

class DescribeFolderContentsRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :sort,
  :order,
  :limit,
  :marker,
  :type,
  :include)
  include Aws::Structure
end

#sortString

The sorting criteria.

Returns:

  • (String)


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1150

class DescribeFolderContentsRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :sort,
  :order,
  :limit,
  :marker,
  :type,
  :include)
  include Aws::Structure
end

#typeString

The type of items.

Returns:

  • (String)


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1150

class DescribeFolderContentsRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :sort,
  :order,
  :limit,
  :marker,
  :type,
  :include)
  include Aws::Structure
end