Copyright | (c) 2013-2018 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 |
Returns a paginated list of child objects that are associated with a given object.
Synopsis
- listObjectChildren :: Text -> ObjectReference -> ListObjectChildren
- data ListObjectChildren
- locConsistencyLevel :: Lens' ListObjectChildren (Maybe ConsistencyLevel)
- locNextToken :: Lens' ListObjectChildren (Maybe Text)
- locMaxResults :: Lens' ListObjectChildren (Maybe Natural)
- locDirectoryARN :: Lens' ListObjectChildren Text
- locObjectReference :: Lens' ListObjectChildren ObjectReference
- listObjectChildrenResponse :: Int -> ListObjectChildrenResponse
- data ListObjectChildrenResponse
- locrsChildren :: Lens' ListObjectChildrenResponse (HashMap Text Text)
- locrsNextToken :: Lens' ListObjectChildrenResponse (Maybe Text)
- locrsResponseStatus :: Lens' ListObjectChildrenResponse Int
Creating a Request
Creates a value of ListObjectChildren
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
locConsistencyLevel
- Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.locNextToken
- The pagination token.locMaxResults
- The maximum number of items to be retrieved in a single call. This is an approximate number.locDirectoryARN
- The Amazon Resource Name (ARN) that is associated with theDirectory
where the object resides. For more information, seearns
.locObjectReference
- The reference that identifies the object for which child objects are being listed.
data ListObjectChildren Source #
See: listObjectChildren
smart constructor.
Instances
Request Lenses
locConsistencyLevel :: Lens' ListObjectChildren (Maybe ConsistencyLevel) Source #
Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
locNextToken :: Lens' ListObjectChildren (Maybe Text) Source #
The pagination token.
locMaxResults :: Lens' ListObjectChildren (Maybe Natural) Source #
The maximum number of items to be retrieved in a single call. This is an approximate number.
locDirectoryARN :: Lens' ListObjectChildren Text Source #
The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides. For more information, see arns
.
locObjectReference :: Lens' ListObjectChildren ObjectReference Source #
The reference that identifies the object for which child objects are being listed.
Destructuring the Response
listObjectChildrenResponse Source #
Creates a value of ListObjectChildrenResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
locrsChildren
- Children structure, which is a map with key as theLinkName
andObjectIdentifier
as the value.locrsNextToken
- The pagination token.locrsResponseStatus
- -- | The response status code.
data ListObjectChildrenResponse Source #
See: listObjectChildrenResponse
smart constructor.
Instances
Response Lenses
locrsChildren :: Lens' ListObjectChildrenResponse (HashMap Text Text) Source #
Children structure, which is a map with key as the LinkName
and ObjectIdentifier
as the value.
locrsNextToken :: Lens' ListObjectChildrenResponse (Maybe Text) Source #
The pagination token.
locrsResponseStatus :: Lens' ListObjectChildrenResponse Int Source #
- - | The response status code.