Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
Creates an index object. See Indexing for more information.
- createIndex :: Text -> Bool -> CreateIndex
- data CreateIndex
- ciParentReference :: Lens' CreateIndex (Maybe ObjectReference)
- ciLinkName :: Lens' CreateIndex (Maybe Text)
- ciDirectoryARN :: Lens' CreateIndex Text
- ciOrderedIndexedAttributeList :: Lens' CreateIndex [AttributeKey]
- ciIsUnique :: Lens' CreateIndex Bool
- createIndexResponse :: Int -> CreateIndexResponse
- data CreateIndexResponse
- cirsObjectIdentifier :: Lens' CreateIndexResponse (Maybe Text)
- cirsResponseStatus :: Lens' CreateIndexResponse Int
Creating a Request
Creates a value of CreateIndex
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ciParentReference
- A reference to the parent object that contains the index object.ciLinkName
- The name of the link between the parent object and the index object.ciDirectoryARN
- The ARN of the directory where the index should be created.ciOrderedIndexedAttributeList
- Specifies the attributes that should be indexed on. Currently only a single attribute is supported.ciIsUnique
- Indicates whether the attribute that is being indexed has unique values or not.
data CreateIndex Source #
See: createIndex
smart constructor.
Request Lenses
ciParentReference :: Lens' CreateIndex (Maybe ObjectReference) Source #
A reference to the parent object that contains the index object.
ciLinkName :: Lens' CreateIndex (Maybe Text) Source #
The name of the link between the parent object and the index object.
ciDirectoryARN :: Lens' CreateIndex Text Source #
The ARN of the directory where the index should be created.
ciOrderedIndexedAttributeList :: Lens' CreateIndex [AttributeKey] Source #
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
ciIsUnique :: Lens' CreateIndex Bool Source #
Indicates whether the attribute that is being indexed has unique values or not.
Destructuring the Response
Creates a value of CreateIndexResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cirsObjectIdentifier
- TheObjectIdentifier
of the index created by this operation.cirsResponseStatus
- -- | The response status code.
data CreateIndexResponse Source #
See: createIndexResponse
smart constructor.
Response Lenses
cirsObjectIdentifier :: Lens' CreateIndexResponse (Maybe Text) Source #
The ObjectIdentifier
of the index created by this operation.
cirsResponseStatus :: Lens' CreateIndexResponse Int Source #
- - | The response status code.