Create Index

clouddirectory_create_index

R Documentation

Creates an index object¶

Description¶

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

Usage¶

clouddirectory_create_index(DirectoryArn, OrderedIndexedAttributeList,
  IsUnique, ParentReference, LinkName)

Arguments¶

DirectoryArn: [required] The ARN of the directory where the index should be created.
OrderedIndexedAttributeList: [required] Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
IsUnique: [required] Indicates whether the attribute that is being indexed has unique values or not.
ParentReference: A reference to the parent object that contains the index object.
LinkName: The name of the link between the parent object and the index object.

Value¶

A list with the following syntax:

list(
  ObjectIdentifier = "string"
)

Request syntax¶

svc$create_index(
  DirectoryArn = "string",
  OrderedIndexedAttributeList = list(
    list(
      SchemaArn = "string",
      FacetName = "string",
      Name = "string"
    )
  ),
  IsUnique = TRUE|FALSE,
  ParentReference = list(
    Selector = "string"
  ),
  LinkName = "string"
)