Amazonka.CloudDirectory.ListObjectChildren

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

Creating a Request

data ListObjectChildren

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.

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

Instances

ToJSON ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

toJSON :: ListObjectChildren -> Value

toEncoding :: ListObjectChildren -> Encoding

toJSONList :: [ListObjectChildren] -> Value

toEncodingList :: [ListObjectChildren] -> Encoding

ToHeaders ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

toHeaders :: ListObjectChildren -> [Header]

ToPath ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

toPath :: ListObjectChildren -> ByteString

ToQuery ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

toQuery :: ListObjectChildren -> QueryString

AWSRequest ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Associated Types

type AWSResponse ListObjectChildren

Methods

request :: (Service -> Service) -> ListObjectChildren -> Request ListObjectChildren

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListObjectChildren -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListObjectChildren)))

Generic ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Associated Types

type Rep ListObjectChildren :: Type -> Type

Methods

from :: ListObjectChildren -> Rep ListObjectChildren x

to :: Rep ListObjectChildren x -> ListObjectChildren

Read ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

readsPrec :: Int -> ReadS ListObjectChildren

readList :: ReadS [ListObjectChildren]

readPrec :: ReadPrec ListObjectChildren

readListPrec :: ReadPrec [ListObjectChildren]

Show ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

showsPrec :: Int -> ListObjectChildren -> ShowS

show :: ListObjectChildren -> String

showList :: [ListObjectChildren] -> ShowS

NFData ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

rnf :: ListObjectChildren -> ()

Eq ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

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

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

Hashable ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

hashWithSalt :: Int -> ListObjectChildren -> Int

hash :: ListObjectChildren -> Int

type AWSResponse ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

type AWSResponse ListObjectChildren = ListObjectChildrenResponse

type Rep ListObjectChildren

Defined in Amazonka.CloudDirectory.ListObjectChildren

type Rep ListObjectChildren = D1 ('MetaData "ListObjectChildren" "Amazonka.CloudDirectory.ListObjectChildren" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListObjectChildren'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consistencyLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConsistencyLevel)) :*: 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)))))

newListObjectChildren

Arguments

:: Text

ListObjectChildren

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

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

ListObjectChildren, listObjectChildren_nextToken - The pagination token.

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

ListObjectChildren, listObjectChildren_objectReference - The reference that identifies the object for which child objects are being listed.

Request Lenses

listObjectChildren_consistencyLevel :: 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.

listObjectChildren_maxResults :: Lens' ListObjectChildren (Maybe Natural)

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

listObjectChildren_nextToken :: Lens' ListObjectChildren (Maybe Text)

The pagination token.

listObjectChildren_directoryArn :: Lens' ListObjectChildren Text

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

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

Destructuring the Response

data ListObjectChildrenResponse

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

Generic ListObjectChildrenResponse

Defined in Amazonka.CloudDirectory.ListObjectChildren

Associated Types

type Rep ListObjectChildrenResponse :: Type -> Type

Methods

from :: ListObjectChildrenResponse -> Rep ListObjectChildrenResponse x

to :: Rep ListObjectChildrenResponse x -> ListObjectChildrenResponse

Read ListObjectChildrenResponse

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

readsPrec :: Int -> ReadS ListObjectChildrenResponse

readList :: ReadS [ListObjectChildrenResponse]

readPrec :: ReadPrec ListObjectChildrenResponse

readListPrec :: ReadPrec [ListObjectChildrenResponse]

Show ListObjectChildrenResponse

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

showsPrec :: Int -> ListObjectChildrenResponse -> ShowS

show :: ListObjectChildrenResponse -> String

showList :: [ListObjectChildrenResponse] -> ShowS

NFData ListObjectChildrenResponse

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

rnf :: ListObjectChildrenResponse -> ()

Eq ListObjectChildrenResponse

Defined in Amazonka.CloudDirectory.ListObjectChildren

Methods

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

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

type Rep ListObjectChildrenResponse

Defined in Amazonka.CloudDirectory.ListObjectChildren

type Rep ListObjectChildrenResponse = D1 ('MetaData "ListObjectChildrenResponse" "Amazonka.CloudDirectory.ListObjectChildren" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" '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

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:

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

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))

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

listObjectChildrenResponse_nextToken :: Lens' ListObjectChildrenResponse (Maybe Text)

The pagination token.

listObjectChildrenResponse_httpStatus :: Lens' ListObjectChildrenResponse Int

The response's http status code.