| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CloudDirectory.CreateIndex
Description
Creates an index object. See Indexing and search for more information.
Synopsis
- data CreateIndex = CreateIndex' {}
- newCreateIndex :: Text -> Bool -> CreateIndex
- createIndex_parentReference :: Lens' CreateIndex (Maybe ObjectReference)
- createIndex_linkName :: Lens' CreateIndex (Maybe Text)
- createIndex_directoryArn :: Lens' CreateIndex Text
- createIndex_orderedIndexedAttributeList :: Lens' CreateIndex [AttributeKey]
- createIndex_isUnique :: Lens' CreateIndex Bool
- data CreateIndexResponse = CreateIndexResponse' {}
- newCreateIndexResponse :: Int -> CreateIndexResponse
- createIndexResponse_objectIdentifier :: Lens' CreateIndexResponse (Maybe Text)
- createIndexResponse_httpStatus :: Lens' CreateIndexResponse Int
Creating a Request
data CreateIndex Source #
See: newCreateIndex smart constructor.
Constructors
| CreateIndex' | |
Fields
| |
Instances
Create a value of CreateIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parentReference:CreateIndex', createIndex_parentReference - A reference to the parent object that contains the index object.
$sel:linkName:CreateIndex', createIndex_linkName - The name of the link between the parent object and the index object.
$sel:directoryArn:CreateIndex', createIndex_directoryArn - The ARN of the directory where the index should be created.
$sel:orderedIndexedAttributeList:CreateIndex', createIndex_orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a
single attribute is supported.
$sel:isUnique:CreateIndex', createIndex_isUnique - Indicates whether the attribute that is being indexed has unique values
or not.
Request Lenses
createIndex_parentReference :: Lens' CreateIndex (Maybe ObjectReference) Source #
A reference to the parent object that contains the index object.
createIndex_linkName :: Lens' CreateIndex (Maybe Text) Source #
The name of the link between the parent object and the index object.
createIndex_directoryArn :: Lens' CreateIndex Text Source #
The ARN of the directory where the index should be created.
createIndex_orderedIndexedAttributeList :: Lens' CreateIndex [AttributeKey] Source #
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
createIndex_isUnique :: Lens' CreateIndex Bool Source #
Indicates whether the attribute that is being indexed has unique values or not.
Destructuring the Response
data CreateIndexResponse Source #
See: newCreateIndexResponse smart constructor.
Constructors
| CreateIndexResponse' | |
Fields
| |
Instances
newCreateIndexResponse Source #
Arguments
| :: Int | |
| -> CreateIndexResponse |
Create a value of CreateIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:objectIdentifier:CreateIndexResponse', createIndexResponse_objectIdentifier - The ObjectIdentifier of the index created by this operation.
$sel:httpStatus:CreateIndexResponse', createIndexResponse_httpStatus - The response's http status code.
Response Lenses
createIndexResponse_objectIdentifier :: Lens' CreateIndexResponse (Maybe Text) Source #
The ObjectIdentifier of the index created by this operation.
createIndexResponse_httpStatus :: Lens' CreateIndexResponse Int Source #
The response's http status code.