Network.AWS.CloudDirectory.ListObjectParentPaths

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.

Creating a Request

listObjectParentPaths

Arguments

:: Text

loppDirectoryARN

-> ObjectReference

loppObjectReference

-> ListObjectParentPaths

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

See: listObjectParentPaths smart constructor.

Instances

Eq ListObjectParentPaths

Methods

(==) :: ListObjectParentPaths -> ListObjectParentPaths -> Bool

(/=) :: ListObjectParentPaths -> ListObjectParentPaths -> Bool

Data ListObjectParentPaths

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListObjectParentPaths -> c ListObjectParentPaths

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListObjectParentPaths

toConstr :: ListObjectParentPaths -> Constr

dataTypeOf :: ListObjectParentPaths -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListObjectParentPaths)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListObjectParentPaths)

gmapT :: (forall b. Data b => b -> b) -> ListObjectParentPaths -> ListObjectParentPaths

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListObjectParentPaths -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListObjectParentPaths -> r

gmapQ :: (forall d. Data d => d -> u) -> ListObjectParentPaths -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListObjectParentPaths -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListObjectParentPaths -> m ListObjectParentPaths

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListObjectParentPaths -> m ListObjectParentPaths

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListObjectParentPaths -> m ListObjectParentPaths

Read ListObjectParentPaths

Methods

readsPrec :: Int -> ReadS ListObjectParentPaths

readList :: ReadS [ListObjectParentPaths]

readPrec :: ReadPrec ListObjectParentPaths

readListPrec :: ReadPrec [ListObjectParentPaths]

Show ListObjectParentPaths

Methods

showsPrec :: Int -> ListObjectParentPaths -> ShowS

show :: ListObjectParentPaths -> String

showList :: [ListObjectParentPaths] -> ShowS

Generic ListObjectParentPaths

Associated Types

type Rep ListObjectParentPaths :: * -> *

Methods

from :: ListObjectParentPaths -> Rep ListObjectParentPaths x

to :: Rep ListObjectParentPaths x -> ListObjectParentPaths

Hashable ListObjectParentPaths

Methods

hashWithSalt :: Int -> ListObjectParentPaths -> Int

hash :: ListObjectParentPaths -> Int

ToJSON ListObjectParentPaths

Methods

toJSON :: ListObjectParentPaths -> Value

toEncoding :: ListObjectParentPaths -> Encoding

toJSONList :: [ListObjectParentPaths] -> Value

toEncodingList :: [ListObjectParentPaths] -> Encoding

NFData ListObjectParentPaths

Methods

rnf :: ListObjectParentPaths -> ()

AWSPager ListObjectParentPaths

Methods

page :: ListObjectParentPaths -> Rs ListObjectParentPaths -> Maybe ListObjectParentPaths

AWSRequest ListObjectParentPaths

Associated Types

type Rs ListObjectParentPaths :: *

Methods

request :: ListObjectParentPaths -> Request ListObjectParentPaths

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListObjectParentPaths -> ClientResponse -> m (Response ListObjectParentPaths)

ToHeaders ListObjectParentPaths

Methods

toHeaders :: ListObjectParentPaths -> [Header]

ToPath ListObjectParentPaths

Methods

toPath :: ListObjectParentPaths -> ByteString

ToQuery ListObjectParentPaths

Methods

toQuery :: ListObjectParentPaths -> QueryString

type Rep ListObjectParentPaths

type Rep ListObjectParentPaths = D1 * (MetaData "ListObjectParentPaths" "Network.AWS.CloudDirectory.ListObjectParentPaths" "amazonka-clouddirectory-1.6.0-8IFjLCYNMx175Dinq6Lqlq" False) (C1 * (MetaCons "ListObjectParentPaths'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_loppNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_loppMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_loppDirectoryARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_loppObjectReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ObjectReference)))))

type Rs ListObjectParentPaths

type Rs ListObjectParentPaths = ListObjectParentPathsResponse

Request Lenses

loppNextToken :: Lens' ListObjectParentPaths (Maybe Text)

The pagination token.

loppMaxResults :: Lens' ListObjectParentPaths (Maybe Natural)

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

loppDirectoryARN :: Lens' ListObjectParentPaths Text

The ARN of the directory to which the parent path applies.

loppObjectReference :: Lens' ListObjectParentPaths ObjectReference

The reference that identifies the object whose parent paths are listed.

Destructuring the Response

listObjectParentPathsResponse

Arguments

:: Int

lopprsResponseStatus

-> ListObjectParentPathsResponse

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 the ObjectIdentifiers that are associated with the directory.
• lopprsNextToken - The pagination token.
• lopprsResponseStatus - -- | The response status code.

data ListObjectParentPathsResponse

See: listObjectParentPathsResponse smart constructor.

Instances

Eq ListObjectParentPathsResponse

Methods

(==) :: ListObjectParentPathsResponse -> ListObjectParentPathsResponse -> Bool

(/=) :: ListObjectParentPathsResponse -> ListObjectParentPathsResponse -> Bool

Data ListObjectParentPathsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListObjectParentPathsResponse -> c ListObjectParentPathsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListObjectParentPathsResponse

toConstr :: ListObjectParentPathsResponse -> Constr

dataTypeOf :: ListObjectParentPathsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListObjectParentPathsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListObjectParentPathsResponse)

gmapT :: (forall b. Data b => b -> b) -> ListObjectParentPathsResponse -> ListObjectParentPathsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListObjectParentPathsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListObjectParentPathsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListObjectParentPathsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListObjectParentPathsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListObjectParentPathsResponse -> m ListObjectParentPathsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListObjectParentPathsResponse -> m ListObjectParentPathsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListObjectParentPathsResponse -> m ListObjectParentPathsResponse

Read ListObjectParentPathsResponse

Methods

readsPrec :: Int -> ReadS ListObjectParentPathsResponse

readList :: ReadS [ListObjectParentPathsResponse]

readPrec :: ReadPrec ListObjectParentPathsResponse

readListPrec :: ReadPrec [ListObjectParentPathsResponse]

Show ListObjectParentPathsResponse

Methods

showsPrec :: Int -> ListObjectParentPathsResponse -> ShowS

show :: ListObjectParentPathsResponse -> String

showList :: [ListObjectParentPathsResponse] -> ShowS

Generic ListObjectParentPathsResponse

Associated Types

type Rep ListObjectParentPathsResponse :: * -> *

Methods

from :: ListObjectParentPathsResponse -> Rep ListObjectParentPathsResponse x

to :: Rep ListObjectParentPathsResponse x -> ListObjectParentPathsResponse

NFData ListObjectParentPathsResponse

Methods

rnf :: ListObjectParentPathsResponse -> ()

type Rep ListObjectParentPathsResponse

type Rep ListObjectParentPathsResponse = D1 * (MetaData "ListObjectParentPathsResponse" "Network.AWS.CloudDirectory.ListObjectParentPaths" "amazonka-clouddirectory-1.6.0-8IFjLCYNMx175Dinq6Lqlq" False) (C1 * (MetaCons "ListObjectParentPathsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lopprsPathToObjectIdentifiersList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PathToObjectIdentifiers]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lopprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lopprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lopprsPathToObjectIdentifiersList :: Lens' ListObjectParentPathsResponse [PathToObjectIdentifiers]

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

lopprsNextToken :: Lens' ListObjectParentPathsResponse (Maybe Text)

The pagination token.

lopprsResponseStatus :: Lens' ListObjectParentPathsResponse Int

• - | The response status code.