class Aws::CloudDirectory::Types::BatchReadOperation

Represents the output of a `BatchRead` operation.

@note When making an API call, you may pass BatchReadOperation

data as a hash:

    {
      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
      },
    }

@!attribute [rw] list_object_attributes

Lists all attributes that are associated with an object.
@return [Types::BatchListObjectAttributes]

@!attribute [rw] list_object_children

Returns a paginated list of child objects that are associated with a
given object.
@return [Types::BatchListObjectChildren]

@!attribute [rw] list_attached_indices

Lists indices attached to an object.
@return [Types::BatchListAttachedIndices]

@!attribute [rw] list_object_parent_paths

Retrieves all available parent paths for any object type such as
node, leaf node, policy node, and index node objects. For more
information about objects, see [Directory Structure][1].

[1]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html
@return [Types::BatchListObjectParentPaths]

@!attribute [rw] get_object_information

Retrieves metadata about an object.
@return [Types::BatchGetObjectInformation]

@!attribute [rw] get_object_attributes

Retrieves attributes within a facet that are associated with an
object.
@return [Types::BatchGetObjectAttributes]

@!attribute [rw] list_object_parents

Lists parent objects that are associated with a given object in
pagination fashion.
@return [Types::BatchListObjectParents]

@!attribute [rw] list_object_policies

Returns policies attached to an object in pagination fashion.
@return [Types::BatchListObjectPolicies]

@!attribute [rw] list_policy_attachments

Returns all of the `ObjectIdentifiers` to which a given policy is
attached.
@return [Types::BatchListPolicyAttachments]

@!attribute [rw] lookup_policy

Lists all policies from the root of the Directory to the object
specified. If there are no policies present, an empty list is
returned. If policies are present, and if some objects don't have
the policies attached, it returns the `ObjectIdentifier` for such
objects. If policies are present, it returns `ObjectIdentifier`,
`policyId`, and `policyType`. Paths that don't lead to the root
from the target object are ignored. For more information, see
[Policies][1].

[1]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies
@return [Types::BatchLookupPolicy]

@!attribute [rw] list_index

Lists objects attached to the specified index.
@return [Types::BatchListIndex]

@!attribute [rw] list_outgoing_typed_links

Returns a paginated list of all the outgoing TypedLinkSpecifier
information for an object. It also supports filtering by typed link
facet and identity attributes. For more information, see [Typed
Links][1].

[1]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink
@return [Types::BatchListOutgoingTypedLinks]

@!attribute [rw] list_incoming_typed_links

Returns a paginated list of all the incoming TypedLinkSpecifier
information for an object. It also supports filtering by typed link
facet and identity attributes. For more information, see [Typed
Links][1].

[1]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink
@return [Types::BatchListIncomingTypedLinks]

@!attribute [rw] get_link_attributes

Retrieves attributes that are associated with a typed link.
@return [Types::BatchGetLinkAttributes]

@see docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/BatchReadOperation AWS API Documentation

Constants

SENSITIVE