| 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 |
Network.AWS.CloudDirectory.ListObjectParents
Description
Lists parent objects that are associated with a given object in pagination fashion.
- listObjectParents :: Text -> ObjectReference -> ListObjectParents
- data ListObjectParents
- lopConsistencyLevel :: Lens' ListObjectParents (Maybe ConsistencyLevel)
- lopNextToken :: Lens' ListObjectParents (Maybe Text)
- lopMaxResults :: Lens' ListObjectParents (Maybe Natural)
- lopDirectoryARN :: Lens' ListObjectParents Text
- lopObjectReference :: Lens' ListObjectParents ObjectReference
- listObjectParentsResponse :: Int -> ListObjectParentsResponse
- data ListObjectParentsResponse
- lrsNextToken :: Lens' ListObjectParentsResponse (Maybe Text)
- lrsParents :: Lens' ListObjectParentsResponse (HashMap Text Text)
- lrsResponseStatus :: Lens' ListObjectParentsResponse Int
Creating a Request
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ListObjectParents |
Creates a value of ListObjectParents with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lopConsistencyLevel- 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.lopNextToken- The pagination token.lopMaxResults- The maximum number of items to be retrieved in a single call. This is an approximate number.lopDirectoryARN- The Amazon Resource Name (ARN) that is associated with theDirectorywhere the object resides. For more information, seearns.lopObjectReference- The reference that identifies the object for which parent objects are being listed.
data ListObjectParents Source #
See: listObjectParents smart constructor.
Instances
Request Lenses
lopConsistencyLevel :: Lens' ListObjectParents (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.
lopNextToken :: Lens' ListObjectParents (Maybe Text) Source #
The pagination token.
lopMaxResults :: Lens' ListObjectParents (Maybe Natural) Source #
The maximum number of items to be retrieved in a single call. This is an approximate number.
lopDirectoryARN :: Lens' ListObjectParents Text Source #
The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns .
lopObjectReference :: Lens' ListObjectParents ObjectReference Source #
The reference that identifies the object for which parent objects are being listed.
Destructuring the Response
listObjectParentsResponse Source #
Arguments
| :: Int | |
| -> ListObjectParentsResponse |
Creates a value of ListObjectParentsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrsNextToken- The pagination token.lrsParents- The parent structure, which is a map with key as theObjectIdentifierand LinkName as the value.lrsResponseStatus- -- | The response status code.
data ListObjectParentsResponse Source #
See: listObjectParentsResponse smart constructor.
Response Lenses
lrsNextToken :: Lens' ListObjectParentsResponse (Maybe Text) Source #
The pagination token.
lrsParents :: Lens' ListObjectParentsResponse (HashMap Text Text) Source #
The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.
lrsResponseStatus :: Lens' ListObjectParentsResponse Int Source #
- - | The response status code.