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

Class: Aws::CloudDirectory::Types::BatchWriteOperation

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing BatchWriteOperation as input to an Aws::Client method, you can use a vanilla Hash:

{
  create_object: {
    schema_facet: [ # required
      {
        schema_arn: "Arn",
        facet_name: "FacetName",
      },
    ],
    object_attribute_list: [ # required
      {
        key: { # required
          schema_arn: "Arn", # required
          facet_name: "FacetName", # required
          name: "AttributeName", # required
        },
        value: { # required
          string_value: "StringAttributeValue",
          binary_value: "data",
          boolean_value: false,
          number_value: "NumberAttributeValue",
          datetime_value: Time.now,
        },
      },
    ],
    parent_reference: {
      selector: "SelectorObjectReference",
    },
    link_name: "LinkName",
    batch_reference_name: "BatchReferenceName",
  },
  attach_object: {
    parent_reference: { # required
      selector: "SelectorObjectReference",
    },
    child_reference: { # required
      selector: "SelectorObjectReference",
    },
    link_name: "LinkName", # required
  },
  detach_object: {
    parent_reference: { # required
      selector: "SelectorObjectReference",
    },
    link_name: "LinkName", # required
    batch_reference_name: "BatchReferenceName",
  },
  update_object_attributes: {
    object_reference: { # required
      selector: "SelectorObjectReference",
    },
    attribute_updates: [ # required
      {
        object_attribute_key: {
          schema_arn: "Arn", # required
          facet_name: "FacetName", # required
          name: "AttributeName", # required
        },
        object_attribute_action: {
          object_attribute_action_type: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
          object_attribute_update_value: {
            string_value: "StringAttributeValue",
            binary_value: "data",
            boolean_value: false,
            number_value: "NumberAttributeValue",
            datetime_value: Time.now,
          },
        },
      },
    ],
  },
  delete_object: {
    object_reference: { # required
      selector: "SelectorObjectReference",
    },
  },
  add_facet_to_object: {
    schema_facet: { # required
      schema_arn: "Arn",
      facet_name: "FacetName",
    },
    object_attribute_list: [ # required
      {
        key: { # required
          schema_arn: "Arn", # required
          facet_name: "FacetName", # required
          name: "AttributeName", # required
        },
        value: { # required
          string_value: "StringAttributeValue",
          binary_value: "data",
          boolean_value: false,
          number_value: "NumberAttributeValue",
          datetime_value: Time.now,
        },
      },
    ],
    object_reference: { # required
      selector: "SelectorObjectReference",
    },
  },
  remove_facet_from_object: {
    schema_facet: { # required
      schema_arn: "Arn",
      facet_name: "FacetName",
    },
    object_reference: { # required
      selector: "SelectorObjectReference",
    },
  },
  attach_policy: {
    policy_reference: { # required
      selector: "SelectorObjectReference",
    },
    object_reference: { # required
      selector: "SelectorObjectReference",
    },
  },
  detach_policy: {
    policy_reference: { # required
      selector: "SelectorObjectReference",
    },
    object_reference: { # required
      selector: "SelectorObjectReference",
    },
  },
  create_index: {
    ordered_indexed_attribute_list: [ # required
      {
        schema_arn: "Arn", # required
        facet_name: "FacetName", # required
        name: "AttributeName", # required
      },
    ],
    is_unique: false, # required
    parent_reference: {
      selector: "SelectorObjectReference",
    },
    link_name: "LinkName",
    batch_reference_name: "BatchReferenceName",
  },
  attach_to_index: {
    index_reference: { # required
      selector: "SelectorObjectReference",
    },
    target_reference: { # required
      selector: "SelectorObjectReference",
    },
  },
  detach_from_index: {
    index_reference: { # required
      selector: "SelectorObjectReference",
    },
    target_reference: { # required
      selector: "SelectorObjectReference",
    },
  },
  attach_typed_link: {
    source_object_reference: { # required
      selector: "SelectorObjectReference",
    },
    target_object_reference: { # required
      selector: "SelectorObjectReference",
    },
    typed_link_facet: { # required
      schema_arn: "Arn", # required
      typed_link_name: "TypedLinkName", # required
    },
    attributes: [ # required
      {
        attribute_name: "AttributeName", # required
        value: { # required
          string_value: "StringAttributeValue",
          binary_value: "data",
          boolean_value: false,
          number_value: "NumberAttributeValue",
          datetime_value: Time.now,
        },
      },
    ],
  },
  detach_typed_link: {
    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,
          },
        },
      ],
    },
  },
  update_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_updates: [ # required
      {
        attribute_key: {
          schema_arn: "Arn", # required
          facet_name: "FacetName", # required
          name: "AttributeName", # required
        },
        attribute_action: {
          attribute_action_type: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
          attribute_update_value: {
            string_value: "StringAttributeValue",
            binary_value: "data",
            boolean_value: false,
            number_value: "NumberAttributeValue",
            datetime_value: Time.now,
          },
        },
      },
    ],
  },
}

Represents the output of a BatchWrite operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#add_facet_to_object ⇒ Types::BatchAddFacetToObject

A batch operation that adds a facet to an object.

Returns:

#attach_object ⇒ Types::BatchAttachObject

Attaches an object to a Directory.

Returns:

#attach_policy ⇒ Types::BatchAttachPolicy

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

Returns:

#attach_to_index ⇒ Types::BatchAttachToIndex

Attaches the specified object to the specified index.

Returns:

#attach_typed_link ⇒ Types::BatchAttachTypedLink

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

Returns:

#create_index ⇒ Types::BatchCreateIndex

Creates an index object. See Indexing and search for more information.

Returns:

#create_object ⇒ Types::BatchCreateObject

Creates an object.

Returns:

#delete_object ⇒ Types::BatchDeleteObject

Deletes an object in a Directory.

Returns:

#detach_from_index ⇒ Types::BatchDetachFromIndex

Detaches the specified object from the specified index.

Returns:

#detach_object ⇒ Types::BatchDetachObject

Detaches an object from a Directory.

Returns:

#detach_policy ⇒ Types::BatchDetachPolicy

Detaches a policy from a Directory.

Returns:

#detach_typed_link ⇒ Types::BatchDetachTypedLink

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

Returns:

#remove_facet_from_object ⇒ Types::BatchRemoveFacetFromObject

A batch operation that removes a facet from an object.

Returns:

#update_link_attributes ⇒ Types::BatchUpdateLinkAttributes

Updates a given object\'s attributes.

Returns:

#update_object_attributes ⇒ Types::BatchUpdateObjectAttributes

Updates a given object\'s attributes.

Returns: