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.ListObjectParentPaths

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data ListObjectParentPaths Source #

See: newListObjectParentPaths smart constructor.

Constructors

ListObjectParentPaths'
Fields nextToken :: Maybe Text The pagination token. maxResults :: Maybe Natural The maximum number of items to be retrieved in a single call. This is an approximate number. directoryArn :: Text The ARN of the directory to which the parent path applies. objectReference :: ObjectReference The reference that identifies the object whose parent paths are listed.

Instances

Instances details

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

newListObjectParentPaths Source #

Arguments

:: Text	`$sel:directoryArn:ListObjectParentPaths'`
-> ObjectReference	`$sel:objectReference:ListObjectParentPaths'`
-> ListObjectParentPaths

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:

$sel:nextToken:ListObjectParentPaths', listObjectParentPaths_nextToken - The pagination token.

$sel:maxResults:ListObjectParentPaths', listObjectParentPaths_maxResults - The maximum number of items to be retrieved in a single call. This is an approximate number.

$sel:directoryArn:ListObjectParentPaths', listObjectParentPaths_directoryArn - The ARN of the directory to which the parent path applies.

$sel:objectReference:ListObjectParentPaths', listObjectParentPaths_objectReference - The reference that identifies the object whose parent paths are listed.

Request Lenses

listObjectParentPaths_nextToken :: Lens' ListObjectParentPaths (Maybe Text) Source #

The pagination token.

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_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.

Constructors

ListObjectParentPathsResponse'
Fields pathToObjectIdentifiersList :: Maybe [PathToObjectIdentifiers] Returns the path to the `ObjectIdentifiers` that are associated with the directory. nextToken :: Maybe Text The pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListObjectParentPathsResponse Source #

Arguments

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

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:

$sel:pathToObjectIdentifiersList:ListObjectParentPathsResponse', listObjectParentPathsResponse_pathToObjectIdentifiersList - Returns the path to the ObjectIdentifiers that are associated with the directory.

$sel:nextToken:ListObjectParentPaths', listObjectParentPathsResponse_nextToken - The pagination token.

$sel:httpStatus:ListObjectParentPathsResponse', listObjectParentPathsResponse_httpStatus - The response's http status code.

Response Lenses

listObjectParentPathsResponse_pathToObjectIdentifiersList :: Lens' ListObjectParentPathsResponse (Maybe [PathToObjectIdentifiers]) Source #

Returns the path to the ObjectIdentifiers that are associated with the directory.

listObjectParentPathsResponse_nextToken :: Lens' ListObjectParentPathsResponse (Maybe Text) Source #

The pagination token.

listObjectParentPathsResponse_httpStatus :: Lens' ListObjectParentPathsResponse Int Source #

The response's http status code.