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

Class: Aws::CloudDirectory::Types::BatchReadOperation

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

Represents the output of a BatchRead operation.

Instance Attribute Summary collapse

Instance Attribute Details

Retrieves attributes that are associated with a typed link.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#get_object_attributesTypes::BatchGetObjectAttributes

Retrieves attributes within a facet that are associated with an object.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#get_object_informationTypes::BatchGetObjectInformation

Retrieves metadata about an object.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#list_attached_indicesTypes::BatchListAttachedIndices

Lists indices attached to an object.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

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 link.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#list_indexTypes::BatchListIndex

Lists objects attached to the specified index.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#list_object_attributesTypes::BatchListObjectAttributes

Lists all attributes that are associated with an object.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#list_object_childrenTypes::BatchListObjectChildren

Returns a paginated list of child objects that are associated with a given object.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#list_object_parent_pathsTypes::BatchListObjectParentPaths

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.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#list_object_policiesTypes::BatchListObjectPolicies

Returns policies attached to an object in pagination fashion.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

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 link.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#list_policy_attachmentsTypes::BatchListPolicyAttachments

Returns all of the ObjectIdentifiers to which a given policy is attached.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end

#lookup_policyTypes::BatchLookupPolicy

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.



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 2223

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  include Aws::Structure
end