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

Class: Aws::CloudDirectory::Types::ListObjectAttributesRequest

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

{
  directory_arn: "Arn", # required
  object_reference: { # required
    selector: "SelectorObjectReference",
  },
  next_token: "NextToken",
  max_results: 1,
  consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
  facet_filter: {
    schema_arn: "Arn",
    facet_name: "FacetName",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#consistency_levelString

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

Returns:

  • (String)


4911
4912
4913
4914
4915
4916
4917
4918
4919
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4911

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

#directory_arnString

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

Returns:

  • (String)


4911
4912
4913
4914
4915
4916
4917
4918
4919
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4911

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

#facet_filterTypes::SchemaFacet

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

Returns:



4911
4912
4913
4914
4915
4916
4917
4918
4919
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4911

class ListObjectAttributesRequest < Struct.new(
  :directory_arn,
  :object_reference,
  :next_token,
  :max_results,
  :consistency_level,
  :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)


4911
4912
4913
4914
4915
4916
4917
4918
4919
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4911

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

#next_tokenString

The pagination token.

Returns:

  • (String)


4911
4912
4913
4914
4915
4916
4917
4918
4919
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4911

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

#object_referenceTypes::ObjectReference

The reference that identifies the object whose attributes will be listed.



4911
4912
4913
4914
4915
4916
4917
4918
4919
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4911

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