Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . clouddirectory ]

attach-to-index

Description

Attaches the specified object to the specified index.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  attach-to-index
--directory-arn <value>
--index-reference <value>
--target-reference <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--directory-arn (string)

The Amazon Resource Name (ARN) of the directory where the object and index exist.

--index-reference (structure)

A reference to the index that you are attaching the object to.

Shorthand Syntax:

Selector=string

JSON Syntax:

{
  "Selector": "string"
}

--target-reference (structure)

A reference to the object that you are attaching to the index.

Shorthand Syntax:

Selector=string

JSON Syntax:

{
  "Selector": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

AttachedObjectIdentifier -> (string)

The ObjectIdentifier of the object that was attached to the index.