Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkDocs.DescribeFolderContents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the contents of the specified folder, including its documents and subfolders.

By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeFolderContents Source #

See: newDescribeFolderContents smart constructor.

Constructors

DescribeFolderContents'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
include :: Maybe Text
The contents to include. Specify "INITIALIZED" to include initialized documents.
limit :: Maybe Natural
The maximum number of items to return with this call.
marker :: Maybe Text
The marker for the next set of results. This marker was received from a previous call.
order :: Maybe OrderType
The order for the contents of the folder.
sort :: Maybe ResourceSortType
The sorting criteria.
type' :: Maybe FolderContentType
The type of items.
folderId :: Text
The ID of the folder.

Instances

Instances details

ToHeaders DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods toHeaders :: DescribeFolderContents -> [Header] #
ToPath DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods toPath :: DescribeFolderContents -> ByteString #
ToQuery DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods toQuery :: DescribeFolderContents -> QueryString #
AWSPager DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods page :: DescribeFolderContents -> AWSResponse DescribeFolderContents -> Maybe DescribeFolderContents #
AWSRequest DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Associated Types type AWSResponse DescribeFolderContents # Methods request :: (Service -> Service) -> DescribeFolderContents -> Request DescribeFolderContents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFolderContents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFolderContents))) #
Generic DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Associated Types type Rep DescribeFolderContents :: Type -> Type # Methods from :: DescribeFolderContents -> Rep DescribeFolderContents x # to :: Rep DescribeFolderContents x -> DescribeFolderContents #
Show DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods showsPrec :: Int -> DescribeFolderContents -> ShowS # show :: DescribeFolderContents -> String # showList :: [DescribeFolderContents] -> ShowS #
NFData DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods rnf :: DescribeFolderContents -> () #
Eq DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods (==) :: DescribeFolderContents -> DescribeFolderContents -> Bool # (/=) :: DescribeFolderContents -> DescribeFolderContents -> Bool #
Hashable DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods hashWithSalt :: Int -> DescribeFolderContents -> Int # hash :: DescribeFolderContents -> Int #
type AWSResponse DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents type AWSResponse DescribeFolderContents = DescribeFolderContentsResponse
type Rep DescribeFolderContents Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents type Rep DescribeFolderContents = D1 ('MetaData "DescribeFolderContents" "Amazonka.WorkDocs.DescribeFolderContents" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeFolderContents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "include") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrderType)) :: S1 ('MetaSel ('Just "sort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceSortType))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FolderContentType)) :*: S1 ('MetaSel ('Just "folderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeFolderContents Source #

Arguments

:: Text	`$sel:folderId:DescribeFolderContents'`
-> DescribeFolderContents

Create a value of DescribeFolderContents 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:authenticationToken:DescribeFolderContents', describeFolderContents_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:include:DescribeFolderContents', describeFolderContents_include - The contents to include. Specify "INITIALIZED" to include initialized documents.

$sel:limit:DescribeFolderContents', describeFolderContents_limit - The maximum number of items to return with this call.

DescribeFolderContents, describeFolderContents_marker - The marker for the next set of results. This marker was received from a previous call.

$sel:order:DescribeFolderContents', describeFolderContents_order - The order for the contents of the folder.

$sel:sort:DescribeFolderContents', describeFolderContents_sort - The sorting criteria.

DescribeFolderContents, describeFolderContents_type - The type of items.

$sel:folderId:DescribeFolderContents', describeFolderContents_folderId - The ID of the folder.

Request Lenses

describeFolderContents_authenticationToken :: Lens' DescribeFolderContents (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

describeFolderContents_include :: Lens' DescribeFolderContents (Maybe Text) Source #

The contents to include. Specify "INITIALIZED" to include initialized documents.

describeFolderContents_limit :: Lens' DescribeFolderContents (Maybe Natural) Source #

The maximum number of items to return with this call.

describeFolderContents_marker :: Lens' DescribeFolderContents (Maybe Text) Source #

The marker for the next set of results. This marker was received from a previous call.

describeFolderContents_order :: Lens' DescribeFolderContents (Maybe OrderType) Source #

The order for the contents of the folder.

describeFolderContents_sort :: Lens' DescribeFolderContents (Maybe ResourceSortType) Source #

The sorting criteria.

describeFolderContents_type :: Lens' DescribeFolderContents (Maybe FolderContentType) Source #

The type of items.

describeFolderContents_folderId :: Lens' DescribeFolderContents Text Source #

The ID of the folder.

Destructuring the Response

data DescribeFolderContentsResponse Source #

See: newDescribeFolderContentsResponse smart constructor.

Constructors

DescribeFolderContentsResponse'
Fields documents :: Maybe [DocumentMetadata] The documents in the specified folder. folders :: Maybe [FolderMetadata] The subfolders in the specified folder. marker :: Maybe Text The marker to use when requesting the next set of results. If there are no additional results, the string is empty. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeFolderContentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Associated Types type Rep DescribeFolderContentsResponse :: Type -> Type # Methods from :: DescribeFolderContentsResponse -> Rep DescribeFolderContentsResponse x # to :: Rep DescribeFolderContentsResponse x -> DescribeFolderContentsResponse #
Show DescribeFolderContentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods showsPrec :: Int -> DescribeFolderContentsResponse -> ShowS # show :: DescribeFolderContentsResponse -> String # showList :: [DescribeFolderContentsResponse] -> ShowS #
NFData DescribeFolderContentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods rnf :: DescribeFolderContentsResponse -> () #
Eq DescribeFolderContentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents Methods (==) :: DescribeFolderContentsResponse -> DescribeFolderContentsResponse -> Bool # (/=) :: DescribeFolderContentsResponse -> DescribeFolderContentsResponse -> Bool #
type Rep DescribeFolderContentsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeFolderContents type Rep DescribeFolderContentsResponse = D1 ('MetaData "DescribeFolderContentsResponse" "Amazonka.WorkDocs.DescribeFolderContents" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeFolderContentsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentMetadata])) :: S1 ('MetaSel ('Just "folders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FolderMetadata]))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeFolderContentsResponse Source #

Arguments

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

Create a value of DescribeFolderContentsResponse 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:documents:DescribeFolderContentsResponse', describeFolderContentsResponse_documents - The documents in the specified folder.

$sel:folders:DescribeFolderContentsResponse', describeFolderContentsResponse_folders - The subfolders in the specified folder.

DescribeFolderContents, describeFolderContentsResponse_marker - The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

$sel:httpStatus:DescribeFolderContentsResponse', describeFolderContentsResponse_httpStatus - The response's http status code.

Response Lenses

describeFolderContentsResponse_documents :: Lens' DescribeFolderContentsResponse (Maybe [DocumentMetadata]) Source #

The documents in the specified folder.

describeFolderContentsResponse_folders :: Lens' DescribeFolderContentsResponse (Maybe [FolderMetadata]) Source #

The subfolders in the specified folder.

describeFolderContentsResponse_marker :: Lens' DescribeFolderContentsResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

describeFolderContentsResponse_httpStatus :: Lens' DescribeFolderContentsResponse Int Source #

The response's http status code.