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

Contents

Description

Retrieves the document versions for the specified document.

By default, only active versions are returned.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDocumentVersions Source #

See: newDescribeDocumentVersions smart constructor.

Constructors

DescribeDocumentVersions'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
fields :: Maybe Text
Specify "SOURCE" to include initialized versions and a URL for the source document.
include :: Maybe Text
A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.
limit :: Maybe Natural
The maximum number of versions to return with this call.
marker :: Maybe Text
The marker for the next set of results. (You received this marker from a previous call.)
documentId :: Text
The ID of the document.

Instances

Instances details

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

newDescribeDocumentVersions Source #

Arguments

:: Text	`$sel:documentId:DescribeDocumentVersions'`
-> DescribeDocumentVersions

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

$sel:fields:DescribeDocumentVersions', describeDocumentVersions_fields - Specify "SOURCE" to include initialized versions and a URL for the source document.

$sel:include:DescribeDocumentVersions', describeDocumentVersions_include - A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

$sel:limit:DescribeDocumentVersions', describeDocumentVersions_limit - The maximum number of versions to return with this call.

DescribeDocumentVersions, describeDocumentVersions_marker - The marker for the next set of results. (You received this marker from a previous call.)

$sel:documentId:DescribeDocumentVersions', describeDocumentVersions_documentId - The ID of the document.

Request Lenses

describeDocumentVersions_authenticationToken :: Lens' DescribeDocumentVersions (Maybe Text) Source #

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

describeDocumentVersions_fields :: Lens' DescribeDocumentVersions (Maybe Text) Source #

Specify "SOURCE" to include initialized versions and a URL for the source document.

describeDocumentVersions_include :: Lens' DescribeDocumentVersions (Maybe Text) Source #

A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

describeDocumentVersions_limit :: Lens' DescribeDocumentVersions (Maybe Natural) Source #

The maximum number of versions to return with this call.

describeDocumentVersions_marker :: Lens' DescribeDocumentVersions (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

describeDocumentVersions_documentId :: Lens' DescribeDocumentVersions Text Source #

The ID of the document.

Destructuring the Response

data DescribeDocumentVersionsResponse Source #

See: newDescribeDocumentVersionsResponse smart constructor.

Constructors

DescribeDocumentVersionsResponse'
Fields documentVersions :: Maybe [DocumentVersionMetadata] The document versions. 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 DescribeDocumentVersionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeDocumentVersions Associated Types type Rep DescribeDocumentVersionsResponse :: Type -> Type # Methods from :: DescribeDocumentVersionsResponse -> Rep DescribeDocumentVersionsResponse x # to :: Rep DescribeDocumentVersionsResponse x -> DescribeDocumentVersionsResponse #
Show DescribeDocumentVersionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeDocumentVersions Methods showsPrec :: Int -> DescribeDocumentVersionsResponse -> ShowS # show :: DescribeDocumentVersionsResponse -> String # showList :: [DescribeDocumentVersionsResponse] -> ShowS #
NFData DescribeDocumentVersionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeDocumentVersions Methods rnf :: DescribeDocumentVersionsResponse -> () #
Eq DescribeDocumentVersionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeDocumentVersions Methods (==) :: DescribeDocumentVersionsResponse -> DescribeDocumentVersionsResponse -> Bool # (/=) :: DescribeDocumentVersionsResponse -> DescribeDocumentVersionsResponse -> Bool #
type Rep DescribeDocumentVersionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeDocumentVersions type Rep DescribeDocumentVersionsResponse = D1 ('MetaData "DescribeDocumentVersionsResponse" "Amazonka.WorkDocs.DescribeDocumentVersions" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeDocumentVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentVersionMetadata])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDocumentVersionsResponse Source #

Arguments

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

Create a value of DescribeDocumentVersionsResponse 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:documentVersions:DescribeDocumentVersionsResponse', describeDocumentVersionsResponse_documentVersions - The document versions.

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

$sel:httpStatus:DescribeDocumentVersionsResponse', describeDocumentVersionsResponse_httpStatus - The response's http status code.

Response Lenses

describeDocumentVersionsResponse_documentVersions :: Lens' DescribeDocumentVersionsResponse (Maybe [DocumentVersionMetadata]) Source #

The document versions.

describeDocumentVersionsResponse_marker :: Lens' DescribeDocumentVersionsResponse (Maybe Text) Source #

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

describeDocumentVersionsResponse_httpStatus :: Lens' DescribeDocumentVersionsResponse Int Source #

The response's http status code.