| Copyright | (c) 2013-2021 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 |
Amazonka.CloudDirectory.ListObjectParents
Description
Lists parent objects that are associated with a given object in pagination fashion.
Synopsis
- data ListObjectParents = ListObjectParents' {}
- newListObjectParents :: Text -> ObjectReference -> ListObjectParents
- listObjectParents_consistencyLevel :: Lens' ListObjectParents (Maybe ConsistencyLevel)
- listObjectParents_includeAllLinksToEachParent :: Lens' ListObjectParents (Maybe Bool)
- listObjectParents_nextToken :: Lens' ListObjectParents (Maybe Text)
- listObjectParents_maxResults :: Lens' ListObjectParents (Maybe Natural)
- listObjectParents_directoryArn :: Lens' ListObjectParents Text
- listObjectParents_objectReference :: Lens' ListObjectParents ObjectReference
- data ListObjectParentsResponse = ListObjectParentsResponse' {}
- newListObjectParentsResponse :: Int -> ListObjectParentsResponse
- listObjectParentsResponse_nextToken :: Lens' ListObjectParentsResponse (Maybe Text)
- listObjectParentsResponse_parents :: Lens' ListObjectParentsResponse (Maybe (HashMap Text Text))
- listObjectParentsResponse_parentLinks :: Lens' ListObjectParentsResponse (Maybe [ObjectIdentifierAndLinkNameTuple])
- listObjectParentsResponse_httpStatus :: Lens' ListObjectParentsResponse Int
Creating a Request
data ListObjectParents Source #
See: newListObjectParents smart constructor.
Constructors
| ListObjectParents' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ListObjectParents |
Create a value of ListObjectParents 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:
$sel:consistencyLevel:ListObjectParents', listObjectParents_consistencyLevel - 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.
$sel:includeAllLinksToEachParent:ListObjectParents', listObjectParents_includeAllLinksToEachParent - When set to True, returns all ListObjectParentsResponse$ParentLinks.
There could be multiple links between a parent-child pair.
$sel:nextToken:ListObjectParents', listObjectParents_nextToken - The pagination token.
$sel:maxResults:ListObjectParents', listObjectParents_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
$sel:directoryArn:ListObjectParents', listObjectParents_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides. For more information, see arns.
$sel:objectReference:ListObjectParents', listObjectParents_objectReference - The reference that identifies the object for which parent objects are
being listed.
Request Lenses
listObjectParents_consistencyLevel :: 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.
listObjectParents_includeAllLinksToEachParent :: Lens' ListObjectParents (Maybe Bool) Source #
When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.
listObjectParents_nextToken :: Lens' ListObjectParents (Maybe Text) Source #
The pagination token.
listObjectParents_maxResults :: Lens' ListObjectParents (Maybe Natural) Source #
The maximum number of items to be retrieved in a single call. This is an approximate number.
listObjectParents_directoryArn :: Lens' ListObjectParents Text Source #
The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.
listObjectParents_objectReference :: Lens' ListObjectParents ObjectReference Source #
The reference that identifies the object for which parent objects are being listed.
Destructuring the Response
data ListObjectParentsResponse Source #
See: newListObjectParentsResponse smart constructor.
Constructors
| ListObjectParentsResponse' | |
Fields
| |
Instances
newListObjectParentsResponse Source #
Create a value of ListObjectParentsResponse 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:
$sel:nextToken:ListObjectParents', listObjectParentsResponse_nextToken - The pagination token.
$sel:parents:ListObjectParentsResponse', listObjectParentsResponse_parents - The parent structure, which is a map with key as the ObjectIdentifier
and LinkName as the value.
$sel:parentLinks:ListObjectParentsResponse', listObjectParentsResponse_parentLinks - Returns a list of parent reference and LinkName Tuples.
$sel:httpStatus:ListObjectParentsResponse', listObjectParentsResponse_httpStatus - The response's http status code.
Response Lenses
listObjectParentsResponse_nextToken :: Lens' ListObjectParentsResponse (Maybe Text) Source #
The pagination token.
listObjectParentsResponse_parents :: Lens' ListObjectParentsResponse (Maybe (HashMap Text Text)) Source #
The parent structure, which is a map with key as the ObjectIdentifier
and LinkName as the value.
listObjectParentsResponse_parentLinks :: Lens' ListObjectParentsResponse (Maybe [ObjectIdentifierAndLinkNameTuple]) Source #
Returns a list of parent reference and LinkName Tuples.
listObjectParentsResponse_httpStatus :: Lens' ListObjectParentsResponse Int Source #
The response's http status code.