Class: Aws::WorkDocs::Types::GetResourcesRequest

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 GetResourcesRequest data as a hash:

{
  authentication_token: "AuthenticationHeaderType",
  user_id: "IdType",
  collection_type: "SHARED_WITH_ME", # accepts SHARED_WITH_ME
  limit: 1,
  marker: "PageMarkerType",
}

Constant Summary collapse

SENSITIVE =
[:authentication_token]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2218

class GetResourcesRequest < Struct.new(
  :authentication_token,
  :user_id,
  :collection_type,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#collection_typeString

The collection type.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2218

class GetResourcesRequest < Struct.new(
  :authentication_token,
  :user_id,
  :collection_type,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#limitInteger

The maximum number of resources to return.

Returns:

  • (Integer)


2218
2219
2220
2221
2222
2223
2224
2225
2226
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2218

class GetResourcesRequest < Struct.new(
  :authentication_token,
  :user_id,
  :collection_type,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#markerString

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

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2218

class GetResourcesRequest < Struct.new(
  :authentication_token,
  :user_id,
  :collection_type,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end

#user_idString

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Returns:

  • (String)


2218
2219
2220
2221
2222
2223
2224
2225
2226
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2218

class GetResourcesRequest < Struct.new(
  :authentication_token,
  :user_id,
  :collection_type,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token]
  include Aws::Structure
end