Menu
Amazon Cloud Directory
API Reference

CreateIndex

Creates an index object. See Indexing for more information.

Request Syntax

PUT /amazonclouddirectory/2017-01-11/index HTTP/1.1
x-amz-data-partition: DirectoryArn
Content-type: application/json

{
   "IsUnique": boolean,
   "LinkName": "string",
   "OrderedIndexedAttributeList": [ 
      { 
         "FacetName": "string",
         "Name": "string",
         "SchemaArn": "string"
      }
   ],
   "ParentReference": { 
      "Selector": "string"
   }
}

URI Request Parameters

The request requires the following URI parameters.

DirectoryArn

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

Request Body

The request accepts the following data in JSON format.

IsUnique

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

Type: Boolean

Required: Yes

LinkName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [^\/\[\]\(\):\{\}#@!?\s\\;]+

Required: No

OrderedIndexedAttributeList

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

Type: Array of AttributeKey objects

Required: Yes

ParentReference

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

Type: ObjectReference object

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "ObjectIdentifier": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ObjectIdentifier

The ObjectIdentifier of the index created by this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access denied. Check your permissions.

HTTP Status Code: 403

DirectoryNotEnabledException

An operation can only operate on a directory that is not enabled.

HTTP Status Code: 400

FacetValidationException

The Facet that you provided was not well formed or could not be validated with the schema.

HTTP Status Code: 400

InternalServiceException

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

HTTP Status Code: 500

InvalidArnException

Indicates that the provided ARN value is not valid.

HTTP Status Code: 400

LimitExceededException

Indicates that limits are exceeded. See Limits for more information.

HTTP Status Code: 400

LinkNameAlreadyInUseException

Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

RetryableConflictException

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

HTTP Status Code: 409

UnsupportedIndexTypeException

Indicates that the requested index type is not supported.

HTTP Status Code: 400

ValidationException

Indicates that your request is malformed in some manner. See the exception message.

HTTP Status Code: 400

Examples

The following examples are formatted for legibility.

Example Request

Copy
PUT /amazonclouddirectory/2017-01-11/index HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 290 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20170913/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=dc93fb34cd655e125aa748b8747d99bef78c7c5785e30327cf151d74accbbcf0 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8 X-Amz-Date: 20170913T012153Z User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 { "ParentReference":{ "Selector":"/" }, "OrderedIndexedAttributeList":[ { "SchemaArn":"arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8/schema/Examplepersonschema/1", "FacetName":"Organization_Person", "Name":"manager" } ], "IsUnique":true, "LinkName":"Examplelink" }

Example Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: f6f0b320-a3e4-11e7-b86b-239c40918c06 Date: Thu, 13 Sep 2017 00:35:44 GMT x-amzn-RequestId: f6f0b320-a3e4-11e7-b86b-239c40918c06 Content-Type: application/json Content-Length: 521 { "ObjectIdentifier":"AQF0Fw173YJDlpLUV1eB50Wv4vU99HjyQIShCCUeVob2fw" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: