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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data ListObjectChildren = ListObjectChildren' {
- consistencyLevel :: Maybe ConsistencyLevel
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- directoryArn :: Text
- objectReference :: ObjectReference
}
newListObjectChildren :: Text -> ObjectReference -> ListObjectChildren
listObjectChildren_consistencyLevel :: Lens' ListObjectChildren (Maybe ConsistencyLevel)
listObjectChildren_nextToken :: Lens' ListObjectChildren (Maybe Text)
listObjectChildren_maxResults :: Lens' ListObjectChildren (Maybe Natural)
listObjectChildren_directoryArn :: Lens' ListObjectChildren Text
listObjectChildren_objectReference :: Lens' ListObjectChildren ObjectReference
data ListObjectChildrenResponse = ListObjectChildrenResponse' {
- children :: Maybe (HashMap Text Text)
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListObjectChildrenResponse :: Int -> ListObjectChildrenResponse
listObjectChildrenResponse_children :: Lens' ListObjectChildrenResponse (Maybe (HashMap Text Text))
listObjectChildrenResponse_nextToken :: Lens' ListObjectChildrenResponse (Maybe Text)
listObjectChildrenResponse_httpStatus :: Lens' ListObjectChildrenResponse Int

Creating a Request

data ListObjectChildren Source #

See: newListObjectChildren smart constructor.

Constructors

ListObjectChildren'

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.
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 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 child objects are being listed.

Instances

Instances details

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

newListObjectChildren Source #

Arguments

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

Create a value of ListObjectChildren 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:ListObjectChildren', listObjectChildren_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:nextToken:ListObjectChildren', listObjectChildren_nextToken - The pagination token.

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

$sel:directoryArn:ListObjectChildren', listObjectChildren_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

$sel:objectReference:ListObjectChildren', listObjectChildren_objectReference - The reference that identifies the object for which child objects are being listed.

Request Lenses

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

listObjectChildren_nextToken :: Lens' ListObjectChildren (Maybe Text) Source #

The pagination token.

listObjectChildren_maxResults :: Lens' ListObjectChildren (Maybe Natural) Source #

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

listObjectChildren_directoryArn :: Lens' ListObjectChildren Text Source #

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

listObjectChildren_objectReference :: Lens' ListObjectChildren ObjectReference Source #

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

Destructuring the Response

data ListObjectChildrenResponse Source #

See: newListObjectChildrenResponse smart constructor.

Constructors

ListObjectChildrenResponse'
Fields children :: Maybe (HashMap Text Text) Children structure, which is a map with key as the `LinkName` and `ObjectIdentifier` as the value. nextToken :: Maybe Text The pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListObjectChildrenResponse Source #

Arguments

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

Create a value of ListObjectChildrenResponse 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:children:ListObjectChildrenResponse', listObjectChildrenResponse_children - Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.

$sel:nextToken:ListObjectChildren', listObjectChildrenResponse_nextToken - The pagination token.

$sel:httpStatus:ListObjectChildrenResponse', listObjectChildrenResponse_httpStatus - The response's http status code.

Response Lenses

listObjectChildrenResponse_children :: Lens' ListObjectChildrenResponse (Maybe (HashMap Text Text)) Source #

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

listObjectChildrenResponse_nextToken :: Lens' ListObjectChildrenResponse (Maybe Text) Source #

The pagination token.

listObjectChildrenResponse_httpStatus :: Lens' ListObjectChildrenResponse Int Source #

The response's http status code.