Skip to content

CreateIndexRequest

Source code in docs_src/capo_clouddirectory/types/create_index_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class CreateIndexRequest(TypedDict, closed=True):
    directory_arn: "capo_clouddirectory.types.arn.Arn"
    """<p>The ARN of the directory where the index should be created.</p>"""
    ordered_indexed_attribute_list: (
        "capo_clouddirectory.types.attribute_key_list.AttributeKeyList"
    )
    """<p>Specifies the attributes that should be indexed on. Currently only a single attribute is supported.</p>"""
    is_unique: "capo_clouddirectory.types.bool.Bool"
    """<p>Indicates whether the attribute that is being indexed has unique values or not.</p>"""
    parent_reference: NotRequired[
        "capo_clouddirectory.types.object_reference.ObjectReference"
    ]
    """<p>A reference to the parent object that contains the index object.</p>"""
    link_name: NotRequired["capo_clouddirectory.types.link_name.LinkName"]
    """<p>The name of the link between the parent object and the index object.</p>"""

directory_arn instance-attribute 

directory_arn: Arn

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

is_unique instance-attribute 

is_unique: Bool

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

link_name: NotRequired[LinkName]

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

ordered_indexed_attribute_list instance-attribute 

ordered_indexed_attribute_list: AttributeKeyList

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

parent_reference instance-attribute 

parent_reference: NotRequired[ObjectReference]

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