You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudDirectory::Types::BatchReadRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudDirectory::Types::BatchReadRequest
- Defined in:
- (unknown)
Overview
Note:
When passing BatchReadRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
directory_arn: "Arn", # required
operations: [ # required
{
list_object_attributes: {
object_reference: { # required
selector: "SelectorObjectReference",
},
next_token: "NextToken",
max_results: 1,
facet_filter: {
schema_arn: "Arn",
facet_name: "FacetName",
},
},
list_object_children: {
object_reference: { # required
selector: "SelectorObjectReference",
},
next_token: "NextToken",
max_results: 1,
},
list_attached_indices: {
target_reference: { # required
selector: "SelectorObjectReference",
},
next_token: "NextToken",
max_results: 1,
},
list_object_parent_paths: {
object_reference: { # required
selector: "SelectorObjectReference",
},
next_token: "NextToken",
max_results: 1,
},
get_object_information: {
object_reference: { # required
selector: "SelectorObjectReference",
},
},
get_object_attributes: {
object_reference: { # required
selector: "SelectorObjectReference",
},
schema_facet: { # required
schema_arn: "Arn",
facet_name: "FacetName",
},
attribute_names: ["AttributeName"], # required
},
list_object_parents: {
object_reference: { # required
selector: "SelectorObjectReference",
},
next_token: "NextToken",
max_results: 1,
},
list_object_policies: {
object_reference: { # required
selector: "SelectorObjectReference",
},
next_token: "NextToken",
max_results: 1,
},
list_policy_attachments: {
policy_reference: { # required
selector: "SelectorObjectReference",
},
next_token: "NextToken",
max_results: 1,
},
lookup_policy: {
object_reference: { # required
selector: "SelectorObjectReference",
},
next_token: "NextToken",
max_results: 1,
},
list_index: {
ranges_on_indexed_values: [
{
attribute_key: {
schema_arn: "Arn", # required
facet_name: "FacetName", # required
name: "AttributeName", # required
},
range: {
start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
start_value: {
string_value: "StringAttributeValue",
binary_value: "data",
boolean_value: false,
number_value: "NumberAttributeValue",
datetime_value: Time.now,
},
end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
end_value: {
string_value: "StringAttributeValue",
binary_value: "data",
boolean_value: false,
number_value: "NumberAttributeValue",
datetime_value: Time.now,
},
},
},
],
index_reference: { # required
selector: "SelectorObjectReference",
},
max_results: 1,
next_token: "NextToken",
},
list_outgoing_typed_links: {
object_reference: { # required
selector: "SelectorObjectReference",
},
filter_attribute_ranges: [
{
attribute_name: "AttributeName",
range: { # required
start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
start_value: {
string_value: "StringAttributeValue",
binary_value: "data",
boolean_value: false,
number_value: "NumberAttributeValue",
datetime_value: Time.now,
},
end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
end_value: {
string_value: "StringAttributeValue",
binary_value: "data",
boolean_value: false,
number_value: "NumberAttributeValue",
datetime_value: Time.now,
},
},
},
],
filter_typed_link: {
schema_arn: "Arn", # required
typed_link_name: "TypedLinkName", # required
},
next_token: "NextToken",
max_results: 1,
},
list_incoming_typed_links: {
object_reference: { # required
selector: "SelectorObjectReference",
},
filter_attribute_ranges: [
{
attribute_name: "AttributeName",
range: { # required
start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
start_value: {
string_value: "StringAttributeValue",
binary_value: "data",
boolean_value: false,
number_value: "NumberAttributeValue",
datetime_value: Time.now,
},
end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
end_value: {
string_value: "StringAttributeValue",
binary_value: "data",
boolean_value: false,
number_value: "NumberAttributeValue",
datetime_value: Time.now,
},
},
},
],
filter_typed_link: {
schema_arn: "Arn", # required
typed_link_name: "TypedLinkName", # required
},
next_token: "NextToken",
max_results: 1,
},
get_link_attributes: {
typed_link_specifier: { # required
typed_link_facet: { # required
schema_arn: "Arn", # required
typed_link_name: "TypedLinkName", # required
},
source_object_reference: { # required
selector: "SelectorObjectReference",
},
target_object_reference: { # required
selector: "SelectorObjectReference",
},
identity_attribute_values: [ # required
{
attribute_name: "AttributeName", # required
value: { # required
string_value: "StringAttributeValue",
binary_value: "data",
boolean_value: false,
number_value: "NumberAttributeValue",
datetime_value: Time.now,
},
},
],
},
attribute_names: ["AttributeName"], # required
},
},
],
consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
}
Instance Attribute Summary collapse
-
#consistency_level ⇒ String
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.
-
#directory_arn ⇒ String
The Amazon Resource Name (ARN) that is associated with the Directory.
-
#operations ⇒ Array<Types::BatchReadOperation>
A list of operations that are part of the batch.
Instance Attribute Details
#consistency_level ⇒ String
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.
Possible values:
- SERIALIZABLE
- EVENTUAL
#directory_arn ⇒ String
#operations ⇒ Array<Types::BatchReadOperation>
A list of operations that are part of the batch.