clouddirectory_create_index: Creates an index object

Description Usage Arguments Request syntax

View source: R/clouddirectory_operations.R

Description

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

Usage

1
2
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.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
svc$create_index(
  DirectoryArn = "string",
  OrderedIndexedAttributeList = list(
    list(
      SchemaArn = "string",
      FacetName = "string",
      Name = "string"
    )
  ),
  IsUnique = TRUE|FALSE,
  ParentReference = list(
    Selector = "string"
  ),
  LinkName = "string"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.