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

Class: Aws::CloudDirectory::Types::BatchListObjectAttributes

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

Overview

Note:

When making an API call, you may pass BatchListObjectAttributes data as a hash:

{
  object_reference: { # required
    selector: "SelectorObjectReference",
  },
  next_token: "NextToken",
  max_results: 1,
  facet_filter: {
    schema_arn: "Arn",
    facet_name: "FacetName",
  },
}

Represents the output of a ListObjectAttributes operation.

Instance Attribute Summary collapse

Instance Attribute Details

#facet_filterTypes::SchemaFacet

Used to filter the list of object attributes that are associated with a certain facet.

Returns:



1385
1386
1387
1388
1389
1390
1391
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 1385

class BatchListObjectAttributes < Struct.new(
  :object_reference,
  :next_token,
  :max_results,
  :facet_filter)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of items to be retrieved in a single call. This is an approximate number.

Returns:

  • (Integer)


1385
1386
1387
1388
1389
1390
1391
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 1385

class BatchListObjectAttributes < Struct.new(
  :object_reference,
  :next_token,
  :max_results,
  :facet_filter)
  include Aws::Structure
end

#next_tokenString

The pagination token.

Returns:

  • (String)


1385
1386
1387
1388
1389
1390
1391
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 1385

class BatchListObjectAttributes < Struct.new(
  :object_reference,
  :next_token,
  :max_results,
  :facet_filter)
  include Aws::Structure
end

#object_referenceTypes::ObjectReference

Reference of the object whose attributes need to be listed.



1385
1386
1387
1388
1389
1390
1391
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 1385

class BatchListObjectAttributes < Struct.new(
  :object_reference,
  :next_token,
  :max_results,
  :facet_filter)
  include Aws::Structure
end