attached_indices

Creates, updates, deletes, gets or lists an attached_indices resource.

Overview

Name	attached_indices
Type	Resource
Id	aws.clouddirectory.attached_indices

Fields

The following fields are returned by SELECT queries:

list_attached_indices

Name	Datatype	Description
indexed_attributes	array	The indexed attribute values.
object_identifier	string	In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_attached_indices	select	x-amz-data-partition, region	x-amz-consistency-level	Lists indices attached to the specified object.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
x-amz-data-partition	string	The ARN of the directory.
x-amz-consistency-level	string	The consistency level to use for this operation.

SELECT examples

list_attached_indices

Lists indices attached to the specified object.

SELECT
indexed_attributes,
object_identifier
FROM aws.clouddirectory.attached_indices
WHERE `x-amz-data-partition` = '{{ x-amz-data-partition }}' -- required
AND region = '{{ region }}' -- required
AND `x-amz-consistency-level` = '{{ x-amz-consistency-level }}'
;