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 |
Lists objects attached to the specified index.
- listIndex :: Text -> ObjectReference -> ListIndex
- data ListIndex
- liRangesOnIndexedValues :: Lens' ListIndex [ObjectAttributeRange]
- liConsistencyLevel :: Lens' ListIndex (Maybe ConsistencyLevel)
- liNextToken :: Lens' ListIndex (Maybe Text)
- liMaxResults :: Lens' ListIndex (Maybe Natural)
- liDirectoryARN :: Lens' ListIndex Text
- liIndexReference :: Lens' ListIndex ObjectReference
- listIndexResponse :: Int -> ListIndexResponse
- data ListIndexResponse
- lirsIndexAttachments :: Lens' ListIndexResponse [IndexAttachment]
- lirsNextToken :: Lens' ListIndexResponse (Maybe Text)
- lirsResponseStatus :: Lens' ListIndexResponse Int
Creating a Request
Creates a value of ListIndex
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
liRangesOnIndexedValues
- Specifies the ranges of indexed values that you want to query.liConsistencyLevel
- The consistency level to execute the request at.liNextToken
- The pagination token.liMaxResults
- The maximum number of results to retrieve from the index.liDirectoryARN
- The ARN of the directory that the index exists in.liIndexReference
- The reference to the index to list.
See: listIndex
smart constructor.
Request Lenses
liRangesOnIndexedValues :: Lens' ListIndex [ObjectAttributeRange] Source #
Specifies the ranges of indexed values that you want to query.
liConsistencyLevel :: Lens' ListIndex (Maybe ConsistencyLevel) Source #
The consistency level to execute the request at.
liMaxResults :: Lens' ListIndex (Maybe Natural) Source #
The maximum number of results to retrieve from the index.
liIndexReference :: Lens' ListIndex ObjectReference Source #
The reference to the index to list.
Destructuring the Response
Creates a value of ListIndexResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lirsIndexAttachments
- The objects and indexed values attached to the index.lirsNextToken
- The pagination token.lirsResponseStatus
- -- | The response status code.
data ListIndexResponse Source #
See: listIndexResponse
smart constructor.
Response Lenses
lirsIndexAttachments :: Lens' ListIndexResponse [IndexAttachment] Source #
The objects and indexed values attached to the index.
lirsNextToken :: Lens' ListIndexResponse (Maybe Text) Source #
The pagination token.
lirsResponseStatus :: Lens' ListIndexResponse Int Source #
- - | The response status code.