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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

Synopsis

data GetResources = GetResources' {
- authenticationToken :: Maybe (Sensitive Text)
- collectionType :: Maybe ResourceCollectionType
- limit :: Maybe Natural
- marker :: Maybe Text
- userId :: Maybe Text
}
newGetResources :: GetResources
getResources_authenticationToken :: Lens' GetResources (Maybe Text)
getResources_collectionType :: Lens' GetResources (Maybe ResourceCollectionType)
getResources_limit :: Lens' GetResources (Maybe Natural)
getResources_marker :: Lens' GetResources (Maybe Text)
getResources_userId :: Lens' GetResources (Maybe Text)
data GetResourcesResponse = GetResourcesResponse' {
- documents :: Maybe [DocumentMetadata]
- folders :: Maybe [FolderMetadata]
- marker :: Maybe Text
- httpStatus :: Int
}
newGetResourcesResponse :: Int -> GetResourcesResponse
getResourcesResponse_documents :: Lens' GetResourcesResponse (Maybe [DocumentMetadata])
getResourcesResponse_folders :: Lens' GetResourcesResponse (Maybe [FolderMetadata])
getResourcesResponse_marker :: Lens' GetResourcesResponse (Maybe Text)
getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int

Creating a Request

data GetResources Source #

See: newGetResources smart constructor.

Constructors

GetResources'

Fields

authenticationToken :: Maybe (Sensitive Text)
The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
collectionType :: Maybe ResourceCollectionType
The collection type.
limit :: Maybe Natural
The maximum number of resources to return.
marker :: Maybe Text
The marker for the next set of results. This marker was received from a previous call.
userId :: Maybe Text
The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Instances

Instances details

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

newGetResources :: GetResources Source #

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

$sel:collectionType:GetResources', getResources_collectionType - The collection type.

$sel:limit:GetResources', getResources_limit - The maximum number of resources to return.

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

$sel:userId:GetResources', getResources_userId - The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Request Lenses

getResources_authenticationToken :: Lens' GetResources (Maybe Text) Source #

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

getResources_collectionType :: Lens' GetResources (Maybe ResourceCollectionType) Source #

The collection type.

getResources_limit :: Lens' GetResources (Maybe Natural) Source #

The maximum number of resources to return.

getResources_marker :: Lens' GetResources (Maybe Text) Source #

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

getResources_userId :: Lens' GetResources (Maybe Text) Source #

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Destructuring the Response

data GetResourcesResponse Source #

See: newGetResourcesResponse smart constructor.

Constructors

GetResourcesResponse'
Fields documents :: Maybe [DocumentMetadata] The documents in the specified collection. folders :: Maybe [FolderMetadata] The folders 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 GetResourcesResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetResources Associated Types type Rep GetResourcesResponse :: Type -> Type # Methods from :: GetResourcesResponse -> Rep GetResourcesResponse x # to :: Rep GetResourcesResponse x -> GetResourcesResponse #
Show GetResourcesResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetResources Methods showsPrec :: Int -> GetResourcesResponse -> ShowS # show :: GetResourcesResponse -> String # showList :: [GetResourcesResponse] -> ShowS #
NFData GetResourcesResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetResources Methods rnf :: GetResourcesResponse -> () #
Eq GetResourcesResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetResources Methods (==) :: GetResourcesResponse -> GetResourcesResponse -> Bool # (/=) :: GetResourcesResponse -> GetResourcesResponse -> Bool #
type Rep GetResourcesResponse Source #
Instance details Defined in Amazonka.WorkDocs.GetResources type Rep GetResourcesResponse = D1 ('MetaData "GetResourcesResponse" "Amazonka.WorkDocs.GetResources" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "GetResourcesResponse'" '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))))

newGetResourcesResponse Source #

Arguments

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

Create a value of GetResourcesResponse 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:GetResourcesResponse', getResourcesResponse_documents - The documents in the specified collection.

$sel:folders:GetResourcesResponse', getResourcesResponse_folders - The folders in the specified folder.

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

$sel:httpStatus:GetResourcesResponse', getResourcesResponse_httpStatus - The response's http status code.

Response Lenses

getResourcesResponse_documents :: Lens' GetResourcesResponse (Maybe [DocumentMetadata]) Source #

The documents in the specified collection.

getResourcesResponse_folders :: Lens' GetResourcesResponse (Maybe [FolderMetadata]) Source #

The folders in the specified folder.

getResourcesResponse_marker :: Lens' GetResourcesResponse (Maybe Text) Source #

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

getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int Source #

The response's http status code.