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 |
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure .
Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults
, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.
- listObjectParentPaths :: Text -> ObjectReference -> ListObjectParentPaths
- data ListObjectParentPaths
- loppNextToken :: Lens' ListObjectParentPaths (Maybe Text)
- loppMaxResults :: Lens' ListObjectParentPaths (Maybe Natural)
- loppDirectoryARN :: Lens' ListObjectParentPaths Text
- loppObjectReference :: Lens' ListObjectParentPaths ObjectReference
- listObjectParentPathsResponse :: Int -> ListObjectParentPathsResponse
- data ListObjectParentPathsResponse
- lopprsPathToObjectIdentifiersList :: Lens' ListObjectParentPathsResponse [PathToObjectIdentifiers]
- lopprsNextToken :: Lens' ListObjectParentPathsResponse (Maybe Text)
- lopprsResponseStatus :: Lens' ListObjectParentPathsResponse Int
Creating a Request
listObjectParentPaths Source #
Creates a value of ListObjectParentPaths
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
loppNextToken
- The pagination token.loppMaxResults
- The maximum number of items to be retrieved in a single call. This is an approximate number.loppDirectoryARN
- The ARN of the directory to which the parent path applies.loppObjectReference
- The reference that identifies the object whose parent paths are listed.
data ListObjectParentPaths Source #
See: listObjectParentPaths
smart constructor.
Request Lenses
loppNextToken :: Lens' ListObjectParentPaths (Maybe Text) Source #
The pagination token.
loppMaxResults :: Lens' ListObjectParentPaths (Maybe Natural) Source #
The maximum number of items to be retrieved in a single call. This is an approximate number.
loppDirectoryARN :: Lens' ListObjectParentPaths Text Source #
The ARN of the directory to which the parent path applies.
loppObjectReference :: Lens' ListObjectParentPaths ObjectReference Source #
The reference that identifies the object whose parent paths are listed.
Destructuring the Response
listObjectParentPathsResponse Source #
Creates a value of ListObjectParentPathsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lopprsPathToObjectIdentifiersList
- Returns the path to theObjectIdentifiers
that are associated with the directory.lopprsNextToken
- The pagination token.lopprsResponseStatus
- -- | The response status code.
data ListObjectParentPathsResponse Source #
See: listObjectParentPathsResponse
smart constructor.
Response Lenses
lopprsPathToObjectIdentifiersList :: Lens' ListObjectParentPathsResponse [PathToObjectIdentifiers] Source #
Returns the path to the ObjectIdentifiers
that are associated with the directory.
lopprsNextToken :: Lens' ListObjectParentPathsResponse (Maybe Text) Source #
The pagination token.
lopprsResponseStatus :: Lens' ListObjectParentPathsResponse Int Source #
- - | The response status code.