Network.AWS.WorkDocs.DescribeFolderContents

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.

Creating a Request

describeFolderContents

Arguments

:: Text

dfcsFolderId

-> DescribeFolderContents

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

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

• dfcsInclude - The contents to include. Specify INITIALIZED to include initialized documents.
• dfcsAuthenticationToken - Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.
• dfcsSort - The sorting criteria.
• dfcsMarker - The marker for the next set of results. This marker was received from a previous call.
• dfcsLimit - The maximum number of items to return with this call.
• dfcsType - The type of items.
• dfcsOrder - The order for the contents of the folder.
• dfcsFolderId - The ID of the folder.

data DescribeFolderContents

See: describeFolderContents smart constructor.

Instances

Eq DescribeFolderContents

Methods

(==) :: DescribeFolderContents -> DescribeFolderContents -> Bool

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

Data DescribeFolderContents

Methods

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

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

toConstr :: DescribeFolderContents -> Constr

dataTypeOf :: DescribeFolderContents -> DataType

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

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

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

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

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

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

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

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

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

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

Show DescribeFolderContents

Methods

showsPrec :: Int -> DescribeFolderContents -> ShowS

show :: DescribeFolderContents -> String

showList :: [DescribeFolderContents] -> ShowS

Generic DescribeFolderContents

Associated Types

type Rep DescribeFolderContents :: * -> *

Methods

from :: DescribeFolderContents -> Rep DescribeFolderContents x

to :: Rep DescribeFolderContents x -> DescribeFolderContents

Hashable DescribeFolderContents

Methods

hashWithSalt :: Int -> DescribeFolderContents -> Int

hash :: DescribeFolderContents -> Int

NFData DescribeFolderContents

Methods

rnf :: DescribeFolderContents -> ()

AWSPager DescribeFolderContents

Methods

page :: DescribeFolderContents -> Rs DescribeFolderContents -> Maybe DescribeFolderContents

AWSRequest DescribeFolderContents

Associated Types

type Rs DescribeFolderContents :: *

Methods

request :: DescribeFolderContents -> Request DescribeFolderContents

response :: MonadResource m => Logger -> Service -> Proxy * DescribeFolderContents -> ClientResponse -> m (Response DescribeFolderContents)

ToQuery DescribeFolderContents

Methods

toQuery :: DescribeFolderContents -> QueryString

ToPath DescribeFolderContents

Methods

toPath :: DescribeFolderContents -> ByteString

ToHeaders DescribeFolderContents

Methods

toHeaders :: DescribeFolderContents -> [Header]

type Rep DescribeFolderContents

type Rep DescribeFolderContents = D1 (MetaData "DescribeFolderContents" "Network.AWS.WorkDocs.DescribeFolderContents" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "DescribeFolderContents'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dfcsInclude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dfcsAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_dfcsSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ResourceSortType))) (S1 (MetaSel (Just Symbol "_dfcsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dfcsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dfcsType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FolderContentType)))) ((:*:) (S1 (MetaSel (Just Symbol "_dfcsOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OrderType))) (S1 (MetaSel (Just Symbol "_dfcsFolderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs DescribeFolderContents

type Rs DescribeFolderContents = DescribeFolderContentsResponse

Request Lenses

dfcsInclude :: Lens' DescribeFolderContents (Maybe Text)

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

dfcsAuthenticationToken :: Lens' DescribeFolderContents (Maybe Text)

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

dfcsSort :: Lens' DescribeFolderContents (Maybe ResourceSortType)

The sorting criteria.

dfcsMarker :: Lens' DescribeFolderContents (Maybe Text)

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

dfcsLimit :: Lens' DescribeFolderContents (Maybe Natural)

The maximum number of items to return with this call.

dfcsType :: Lens' DescribeFolderContents (Maybe FolderContentType)

The type of items.

dfcsOrder :: Lens' DescribeFolderContents (Maybe OrderType)

The order for the contents of the folder.

dfcsFolderId :: Lens' DescribeFolderContents Text

The ID of the folder.

Destructuring the Response

describeFolderContentsResponse

Arguments

:: Int

dfcrsResponseStatus

-> DescribeFolderContentsResponse

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

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

• dfcrsFolders - The subfolders in the specified folder.
• dfcrsDocuments - The documents in the specified folder.
• dfcrsMarker - The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
• dfcrsResponseStatus - -- | The response status code.

data DescribeFolderContentsResponse

See: describeFolderContentsResponse smart constructor.

Instances

Eq DescribeFolderContentsResponse

Methods

(==) :: DescribeFolderContentsResponse -> DescribeFolderContentsResponse -> Bool

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

Data DescribeFolderContentsResponse

Methods

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

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

toConstr :: DescribeFolderContentsResponse -> Constr

dataTypeOf :: DescribeFolderContentsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show DescribeFolderContentsResponse

Methods

showsPrec :: Int -> DescribeFolderContentsResponse -> ShowS

show :: DescribeFolderContentsResponse -> String

showList :: [DescribeFolderContentsResponse] -> ShowS

Generic DescribeFolderContentsResponse

Associated Types

type Rep DescribeFolderContentsResponse :: * -> *

Methods

from :: DescribeFolderContentsResponse -> Rep DescribeFolderContentsResponse x

to :: Rep DescribeFolderContentsResponse x -> DescribeFolderContentsResponse

NFData DescribeFolderContentsResponse

Methods

rnf :: DescribeFolderContentsResponse -> ()

type Rep DescribeFolderContentsResponse

type Rep DescribeFolderContentsResponse = D1 (MetaData "DescribeFolderContentsResponse" "Network.AWS.WorkDocs.DescribeFolderContents" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "DescribeFolderContentsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dfcrsFolders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FolderMetadata]))) (S1 (MetaSel (Just Symbol "_dfcrsDocuments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DocumentMetadata])))) ((:*:) (S1 (MetaSel (Just Symbol "_dfcrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dfcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

dfcrsFolders :: Lens' DescribeFolderContentsResponse [FolderMetadata]

The subfolders in the specified folder.

dfcrsDocuments :: Lens' DescribeFolderContentsResponse [DocumentMetadata]

The documents in the specified folder.

dfcrsMarker :: Lens' DescribeFolderContentsResponse (Maybe Text)

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

dfcrsResponseStatus :: Lens' DescribeFolderContentsResponse Int

• - | The response status code.