PUT

/amazonclouddirectory/2017-01-11/index#x-amz-data-partition

http://clouddirectory.{region}.amazonaws.com/amazonclouddirectory/2017-01-11/index#x-amz-data-partition

Creates an index object. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html">Indexing and search</a> for more information.

Access Token Required: API Key

Body Params

IsUniquebooleanrequired

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

LinkNamestring

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

ParentReferenceobject

The reference that identifies an object.

OrderedIndexedAttributeListarrayrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://clouddirectory.{region}.amazonaws.com/amazonclouddirectory/2017-01-11/index#x-amz-data-partition' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT