Table Of Contents

Feedback

User Guide

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

[ aws . clouddirectory ]

create-index

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-index
--directory-arn <value>
--ordered-indexed-attribute-list <value>
--is-unique | --no-is-unique
[--parent-reference <value>]
[--link-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--directory-arn (string)

The ARN of the directory where the index should be created.

--ordered-indexed-attribute-list (list)

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

Shorthand Syntax:

SchemaArn=string,FacetName=string,Name=string ...

JSON Syntax:

[
  {
    "SchemaArn": "string",
    "FacetName": "string",
    "Name": "string"
  }
  ...
]

--is-unique | --no-is-unique (boolean)

Indicates whether the attribute that is being indexed has unique values or not.

--parent-reference (structure)

A reference to the parent object that contains the index object.

Shorthand Syntax:

Selector=string

JSON Syntax:

{
  "Selector": "string"
}

--link-name (string)

The name of the link between the parent object and the index object.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

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

ObjectIdentifier -> (string)

The ObjectIdentifier of the index created by this operation.