CloudDirectory / Client / create_index

create_index#

CloudDirectory.Client.create_index(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_index(
    DirectoryArn='string',
    OrderedIndexedAttributeList=[
        {
            'SchemaArn': 'string',
            'FacetName': 'string',
            'Name': 'string'
        },
    ],
    IsUnique=True|False,
    ParentReference={
        'Selector': 'string'
    },
    LinkName='string'
)
Parameters:

  • DirectoryArn (string) –

    [REQUIRED]

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

  • OrderedIndexedAttributeList (list) –

    [REQUIRED]

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

    • (dict) –

      A unique identifier for an attribute.

      • SchemaArn (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

      • FacetName (string) – [REQUIRED]

        The name of the facet that the attribute exists within.

      • Name (string) – [REQUIRED]

        The name of the attribute.

  • IsUnique (boolean) –

    [REQUIRED]

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

  • ParentReference (dict) –

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

    • Selector (string) –

      A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

      • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

      • /some/path - Identifies the object based on path

      • #SomeBatchReference - Identifies the object in a batch call

  • LinkName (string) – The name of the link between the parent object and the index object.

Return type:

dict

Returns:

Response Syntax

{
    'ObjectIdentifier': 'string'
}

Response Structure

  • (dict) –

    • ObjectIdentifier (string) –

      The ObjectIdentifier of the index created by this operation.

Exceptions

  • CloudDirectory.Client.exceptions.InternalServiceException

  • CloudDirectory.Client.exceptions.InvalidArnException

  • CloudDirectory.Client.exceptions.RetryableConflictException

  • CloudDirectory.Client.exceptions.ValidationException

  • CloudDirectory.Client.exceptions.LimitExceededException

  • CloudDirectory.Client.exceptions.AccessDeniedException

  • CloudDirectory.Client.exceptions.DirectoryNotEnabledException

  • CloudDirectory.Client.exceptions.ResourceNotFoundException

  • CloudDirectory.Client.exceptions.FacetValidationException

  • CloudDirectory.Client.exceptions.LinkNameAlreadyInUseException

  • CloudDirectory.Client.exceptions.UnsupportedIndexTypeException