Network.AWS.CloudDirectory.ListObjectChildren

Returns a paginated list of child objects that are associated with a given object.

Creating a Request

listObjectChildren

Arguments

:: Text

locDirectoryARN

-> ObjectReference

locObjectReference

-> ListObjectChildren

Creates a value of ListObjectChildren with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• locConsistencyLevel - 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.
• locNextToken - The pagination token.
• locMaxResults - The maximum number of items to be retrieved in a single call. This is an approximate number.
• locDirectoryARN - The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns .
• locObjectReference - The reference that identifies the object for which child objects are being listed.

data ListObjectChildren

See: listObjectChildren smart constructor.

Instances

Eq ListObjectChildren

Methods

(==) :: ListObjectChildren -> ListObjectChildren -> Bool

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

Data ListObjectChildren

Methods

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

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

toConstr :: ListObjectChildren -> Constr

dataTypeOf :: ListObjectChildren -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListObjectChildren

Methods

readsPrec :: Int -> ReadS ListObjectChildren

readList :: ReadS [ListObjectChildren]

readPrec :: ReadPrec ListObjectChildren

readListPrec :: ReadPrec [ListObjectChildren]

Show ListObjectChildren

Methods

showsPrec :: Int -> ListObjectChildren -> ShowS

show :: ListObjectChildren -> String

showList :: [ListObjectChildren] -> ShowS

Generic ListObjectChildren

Associated Types

type Rep ListObjectChildren :: * -> *

Methods

from :: ListObjectChildren -> Rep ListObjectChildren x

to :: Rep ListObjectChildren x -> ListObjectChildren

Hashable ListObjectChildren

Methods

hashWithSalt :: Int -> ListObjectChildren -> Int

hash :: ListObjectChildren -> Int

ToJSON ListObjectChildren

Methods

toJSON :: ListObjectChildren -> Value

toEncoding :: ListObjectChildren -> Encoding

toJSONList :: [ListObjectChildren] -> Value

toEncodingList :: [ListObjectChildren] -> Encoding

NFData ListObjectChildren

Methods

rnf :: ListObjectChildren -> ()

AWSRequest ListObjectChildren

Associated Types

type Rs ListObjectChildren :: *

Methods

request :: ListObjectChildren -> Request ListObjectChildren

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

ToHeaders ListObjectChildren

Methods

toHeaders :: ListObjectChildren -> [Header]

ToPath ListObjectChildren

Methods

toPath :: ListObjectChildren -> ByteString

ToQuery ListObjectChildren

Methods

toQuery :: ListObjectChildren -> QueryString

type Rep ListObjectChildren

type Rep ListObjectChildren = D1 * (MetaData "ListObjectChildren" "Network.AWS.CloudDirectory.ListObjectChildren" "amazonka-clouddirectory-1.6.0-8IFjLCYNMx175Dinq6Lqlq" False) (C1 * (MetaCons "ListObjectChildren'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_locConsistencyLevel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ConsistencyLevel))) (S1 * (MetaSel (Just Symbol "_locNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_locMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_locDirectoryARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_locObjectReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ObjectReference))))))

type Rs ListObjectChildren

type Rs ListObjectChildren = ListObjectChildrenResponse

Request Lenses

locConsistencyLevel :: Lens' ListObjectChildren (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.

locNextToken :: Lens' ListObjectChildren (Maybe Text)

The pagination token.

locMaxResults :: Lens' ListObjectChildren (Maybe Natural)

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

locDirectoryARN :: Lens' ListObjectChildren Text

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

locObjectReference :: Lens' ListObjectChildren ObjectReference

The reference that identifies the object for which child objects are being listed.

Destructuring the Response

listObjectChildrenResponse

Arguments

:: Int

locrsResponseStatus

-> ListObjectChildrenResponse

Creates a value of ListObjectChildrenResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• locrsChildren - Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.
• locrsNextToken - The pagination token.
• locrsResponseStatus - -- | The response status code.

data ListObjectChildrenResponse

See: listObjectChildrenResponse smart constructor.

Instances

Eq ListObjectChildrenResponse

Methods

(==) :: ListObjectChildrenResponse -> ListObjectChildrenResponse -> Bool

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

Data ListObjectChildrenResponse

Methods

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

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

toConstr :: ListObjectChildrenResponse -> Constr

dataTypeOf :: ListObjectChildrenResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListObjectChildrenResponse

Methods

readsPrec :: Int -> ReadS ListObjectChildrenResponse

readList :: ReadS [ListObjectChildrenResponse]

readPrec :: ReadPrec ListObjectChildrenResponse

readListPrec :: ReadPrec [ListObjectChildrenResponse]

Show ListObjectChildrenResponse

Methods

showsPrec :: Int -> ListObjectChildrenResponse -> ShowS

show :: ListObjectChildrenResponse -> String

showList :: [ListObjectChildrenResponse] -> ShowS

Generic ListObjectChildrenResponse

Associated Types

type Rep ListObjectChildrenResponse :: * -> *

Methods

from :: ListObjectChildrenResponse -> Rep ListObjectChildrenResponse x

to :: Rep ListObjectChildrenResponse x -> ListObjectChildrenResponse

NFData ListObjectChildrenResponse

Methods

rnf :: ListObjectChildrenResponse -> ()

type Rep ListObjectChildrenResponse

type Rep ListObjectChildrenResponse = D1 * (MetaData "ListObjectChildrenResponse" "Network.AWS.CloudDirectory.ListObjectChildren" "amazonka-clouddirectory-1.6.0-8IFjLCYNMx175Dinq6Lqlq" False) (C1 * (MetaCons "ListObjectChildrenResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_locrsChildren") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_locrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_locrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

locrsChildren :: Lens' ListObjectChildrenResponse (HashMap Text Text)

Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.

locrsNextToken :: Lens' ListObjectChildrenResponse (Maybe Text)

The pagination token.

locrsResponseStatus :: Lens' ListObjectChildrenResponse Int

• - | The response status code.