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

Amazonka.CloudDirectory.ListObjectParents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists parent objects that are associated with a given object in pagination fashion.

Synopsis

data ListObjectParents = ListObjectParents' {
- consistencyLevel :: Maybe ConsistencyLevel
- includeAllLinksToEachParent :: Maybe Bool
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- directoryArn :: Text
- objectReference :: ObjectReference
}
newListObjectParents :: Text -> ObjectReference -> ListObjectParents
listObjectParents_consistencyLevel :: Lens' ListObjectParents (Maybe ConsistencyLevel)
listObjectParents_includeAllLinksToEachParent :: Lens' ListObjectParents (Maybe Bool)
listObjectParents_maxResults :: Lens' ListObjectParents (Maybe Natural)
listObjectParents_nextToken :: Lens' ListObjectParents (Maybe Text)
listObjectParents_directoryArn :: Lens' ListObjectParents Text
listObjectParents_objectReference :: Lens' ListObjectParents ObjectReference
data ListObjectParentsResponse = ListObjectParentsResponse' {
- nextToken :: Maybe Text
- parentLinks :: Maybe [ObjectIdentifierAndLinkNameTuple]
- parents :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newListObjectParentsResponse :: Int -> ListObjectParentsResponse
listObjectParentsResponse_nextToken :: Lens' ListObjectParentsResponse (Maybe Text)
listObjectParentsResponse_parentLinks :: Lens' ListObjectParentsResponse (Maybe [ObjectIdentifierAndLinkNameTuple])
listObjectParentsResponse_parents :: Lens' ListObjectParentsResponse (Maybe (HashMap Text Text))
listObjectParentsResponse_httpStatus :: Lens' ListObjectParentsResponse Int

Creating a Request

data ListObjectParents Source #

See: newListObjectParents smart constructor.

Constructors

ListObjectParents'

Fields

consistencyLevel :: Maybe 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.
includeAllLinksToEachParent :: Maybe Bool
When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.
maxResults :: Maybe Natural
The maximum number of items to be retrieved in a single call. This is an approximate number.
nextToken :: Maybe Text
The pagination token.
directoryArn :: Text
The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.
objectReference :: ObjectReference
The reference that identifies the object for which parent objects are being listed.

Instances

Instances details

ToJSON ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods toJSON :: ListObjectParents -> Value # toEncoding :: ListObjectParents -> Encoding # toJSONList :: [ListObjectParents] -> Value # toEncodingList :: [ListObjectParents] -> Encoding #
ToHeaders ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods toHeaders :: ListObjectParents -> [Header] #
ToPath ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods toPath :: ListObjectParents -> ByteString #
ToQuery ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods toQuery :: ListObjectParents -> QueryString #
AWSRequest ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Associated Types type AWSResponse ListObjectParents # Methods request :: (Service -> Service) -> ListObjectParents -> Request ListObjectParents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListObjectParents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListObjectParents))) #
Generic ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Associated Types type Rep ListObjectParents :: Type -> Type # Methods from :: ListObjectParents -> Rep ListObjectParents x # to :: Rep ListObjectParents x -> ListObjectParents #
Read ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods readsPrec :: Int -> ReadS ListObjectParents # readList :: ReadS [ListObjectParents] # readPrec :: ReadPrec ListObjectParents # readListPrec :: ReadPrec [ListObjectParents] #
Show ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods showsPrec :: Int -> ListObjectParents -> ShowS # show :: ListObjectParents -> String # showList :: [ListObjectParents] -> ShowS #
NFData ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods rnf :: ListObjectParents -> () #
Eq ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods (==) :: ListObjectParents -> ListObjectParents -> Bool # (/=) :: ListObjectParents -> ListObjectParents -> Bool #
Hashable ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods hashWithSalt :: Int -> ListObjectParents -> Int # hash :: ListObjectParents -> Int #
type AWSResponse ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents type AWSResponse ListObjectParents = ListObjectParentsResponse
type Rep ListObjectParents Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents type Rep ListObjectParents = D1 ('MetaData "ListObjectParents" "Amazonka.CloudDirectory.ListObjectParents" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListObjectParents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consistencyLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConsistencyLevel)) :: (S1 ('MetaSel ('Just "includeAllLinksToEachParent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "objectReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectReference)))))

newListObjectParents Source #

Arguments

:: Text	`ListObjectParents`
-> ObjectReference	`ListObjectParents`
-> 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.

ListObjectParents, listObjectParents_maxResults - The maximum number of items to be retrieved in a single call. This is an approximate number.

ListObjectParents, listObjectParents_nextToken - The pagination token.

ListObjectParents, listObjectParents_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

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_maxResults :: Lens' ListObjectParents (Maybe Natural) Source #

The maximum number of items to be retrieved in a single call. This is an approximate number.

listObjectParents_nextToken :: Lens' ListObjectParents (Maybe Text) Source #

The pagination token.

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 nextToken :: Maybe Text The pagination token. parentLinks :: Maybe [ObjectIdentifierAndLinkNameTuple] Returns a list of parent reference and LinkName Tuples. parents :: Maybe (HashMap Text Text) The parent structure, which is a map with key as the `ObjectIdentifier` and LinkName as the value. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListObjectParentsResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Associated Types type Rep ListObjectParentsResponse :: Type -> Type # Methods from :: ListObjectParentsResponse -> Rep ListObjectParentsResponse x # to :: Rep ListObjectParentsResponse x -> ListObjectParentsResponse #
Read ListObjectParentsResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods readsPrec :: Int -> ReadS ListObjectParentsResponse # readList :: ReadS [ListObjectParentsResponse] # readPrec :: ReadPrec ListObjectParentsResponse # readListPrec :: ReadPrec [ListObjectParentsResponse] #
Show ListObjectParentsResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods showsPrec :: Int -> ListObjectParentsResponse -> ShowS # show :: ListObjectParentsResponse -> String # showList :: [ListObjectParentsResponse] -> ShowS #
NFData ListObjectParentsResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods rnf :: ListObjectParentsResponse -> () #
Eq ListObjectParentsResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents Methods (==) :: ListObjectParentsResponse -> ListObjectParentsResponse -> Bool # (/=) :: ListObjectParentsResponse -> ListObjectParentsResponse -> Bool #
type Rep ListObjectParentsResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectParents type Rep ListObjectParentsResponse = D1 ('MetaData "ListObjectParentsResponse" "Amazonka.CloudDirectory.ListObjectParents" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListObjectParentsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parentLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ObjectIdentifierAndLinkNameTuple]))) :: (S1 ('MetaSel ('Just "parents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListObjectParentsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListObjectParentsResponse'`
-> ListObjectParentsResponse

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:

ListObjectParents, listObjectParentsResponse_nextToken - The pagination token.

ListObjectParentsResponse, listObjectParentsResponse_parentLinks - Returns a list of parent reference and LinkName Tuples.

$sel:parents:ListObjectParentsResponse', listObjectParentsResponse_parents - The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.

$sel:httpStatus:ListObjectParentsResponse', listObjectParentsResponse_httpStatus - The response's http status code.

Response Lenses

listObjectParentsResponse_nextToken :: Lens' ListObjectParentsResponse (Maybe Text) Source #

The pagination token.

listObjectParentsResponse_parentLinks :: Lens' ListObjectParentsResponse (Maybe [ObjectIdentifierAndLinkNameTuple]) Source #

Returns a list of parent reference and LinkName Tuples.

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_httpStatus :: Lens' ListObjectParentsResponse Int Source #

The response's http status code.