Amazon Cloud Directory will no longer be open to new customers starting on November 7, 2025. For alternatives to Cloud Directory, explore Amazon DynamoDB
BatchCreateIndex
Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchRead:Operations.
Contents
- IsUnique
-
Indicates whether the attribute that is being indexed has unique values or not.
Type: Boolean
Required: Yes
- OrderedIndexedAttributeList
-
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
Type: Array of AttributeKey objects
Required: Yes
- BatchReferenceName
-
The batch reference name. See Transaction Support for more information.
Type: String
Required: No
- 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
- ParentReference
-
A reference to the parent object that contains the index object.
Type: ObjectReference object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: