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

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

Overview

Constant Summary collapse

SENSITIVE =
[:authentication_token]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


1986
1987
1988
1989
1990
1991
1992
1993
1994
# File 'lib/aws-sdk-workdocs/types.rb', line 1986

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)


1986
1987
1988
1989
1990
1991
1992
1993
1994
# File 'lib/aws-sdk-workdocs/types.rb', line 1986

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)


1986
1987
1988
1989
1990
1991
1992
1993
1994
# File 'lib/aws-sdk-workdocs/types.rb', line 1986

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)


1986
1987
1988
1989
1990
1991
1992
1993
1994
# File 'lib/aws-sdk-workdocs/types.rb', line 1986

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)


1986
1987
1988
1989
1990
1991
1992
1993
1994
# File 'lib/aws-sdk-workdocs/types.rb', line 1986

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