Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
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.
This operation returns paginated results.
Synopsis
- data ListObjectParentPaths = ListObjectParentPaths' {}
- newListObjectParentPaths :: Text -> ObjectReference -> ListObjectParentPaths
- listObjectParentPaths_maxResults :: Lens' ListObjectParentPaths (Maybe Natural)
- listObjectParentPaths_nextToken :: Lens' ListObjectParentPaths (Maybe Text)
- listObjectParentPaths_directoryArn :: Lens' ListObjectParentPaths Text
- listObjectParentPaths_objectReference :: Lens' ListObjectParentPaths ObjectReference
- data ListObjectParentPathsResponse = ListObjectParentPathsResponse' {}
- newListObjectParentPathsResponse :: Int -> ListObjectParentPathsResponse
- listObjectParentPathsResponse_nextToken :: Lens' ListObjectParentPathsResponse (Maybe Text)
- listObjectParentPathsResponse_pathToObjectIdentifiersList :: Lens' ListObjectParentPathsResponse (Maybe [PathToObjectIdentifiers])
- listObjectParentPathsResponse_httpStatus :: Lens' ListObjectParentPathsResponse Int
Creating a Request
data ListObjectParentPaths Source #
See: newListObjectParentPaths
smart constructor.
ListObjectParentPaths' | |
|
Instances
newListObjectParentPaths Source #
Create a value of ListObjectParentPaths
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectParentPaths
, listObjectParentPaths_maxResults
- The maximum number of items to be retrieved in a single call. This is an
approximate number.
ListObjectParentPaths
, listObjectParentPaths_nextToken
- The pagination token.
ListObjectParentPaths
, listObjectParentPaths_directoryArn
- The ARN of the directory to which the parent path applies.
ListObjectParentPaths
, listObjectParentPaths_objectReference
- The reference that identifies the object whose parent paths are listed.
Request Lenses
listObjectParentPaths_maxResults :: Lens' ListObjectParentPaths (Maybe Natural) Source #
The maximum number of items to be retrieved in a single call. This is an approximate number.
listObjectParentPaths_nextToken :: Lens' ListObjectParentPaths (Maybe Text) Source #
The pagination token.
listObjectParentPaths_directoryArn :: Lens' ListObjectParentPaths Text Source #
The ARN of the directory to which the parent path applies.
listObjectParentPaths_objectReference :: Lens' ListObjectParentPaths ObjectReference Source #
The reference that identifies the object whose parent paths are listed.
Destructuring the Response
data ListObjectParentPathsResponse Source #
See: newListObjectParentPathsResponse
smart constructor.
ListObjectParentPathsResponse' | |
|
Instances
newListObjectParentPathsResponse Source #
Create a value of ListObjectParentPathsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListObjectParentPaths
, listObjectParentPathsResponse_nextToken
- The pagination token.
ListObjectParentPathsResponse
, listObjectParentPathsResponse_pathToObjectIdentifiersList
- Returns the path to the ObjectIdentifiers
that are associated with the
directory.
$sel:httpStatus:ListObjectParentPathsResponse'
, listObjectParentPathsResponse_httpStatus
- The response's http status code.
Response Lenses
listObjectParentPathsResponse_nextToken :: Lens' ListObjectParentPathsResponse (Maybe Text) Source #
The pagination token.
listObjectParentPathsResponse_pathToObjectIdentifiersList :: Lens' ListObjectParentPathsResponse (Maybe [PathToObjectIdentifiers]) Source #
Returns the path to the ObjectIdentifiers
that are associated with the
directory.
listObjectParentPathsResponse_httpStatus :: Lens' ListObjectParentPathsResponse Int Source #
The response's http status code.