Network.AWS.WorkDocs.DescribeDocumentVersions

Retrieves the document versions for the specified document.

By default, only active versions are returned.

This operation returns paginated results.

Creating a Request

describeDocumentVersions

Arguments

:: Text

ddvDocumentId

-> DescribeDocumentVersions

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

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

• ddvInclude - A comma-separated list of values. Specify INITIALIZED to include incomplete versions.
• ddvAuthenticationToken - Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.
• ddvMarker - The marker for the next set of results. (You received this marker from a previous call.)
• ddvLimit - The maximum number of versions to return with this call.
• ddvFields - Specify SOURCE to include initialized versions and a URL for the source document.
• ddvDocumentId - The ID of the document.

data DescribeDocumentVersions

See: describeDocumentVersions smart constructor.

Instances

Eq DescribeDocumentVersions

Methods

(==) :: DescribeDocumentVersions -> DescribeDocumentVersions -> Bool

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

Data DescribeDocumentVersions

Methods

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

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

toConstr :: DescribeDocumentVersions -> Constr

dataTypeOf :: DescribeDocumentVersions -> DataType

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

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

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

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

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

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

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

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

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

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

Show DescribeDocumentVersions

Methods

showsPrec :: Int -> DescribeDocumentVersions -> ShowS

show :: DescribeDocumentVersions -> String

showList :: [DescribeDocumentVersions] -> ShowS

Generic DescribeDocumentVersions

Associated Types

type Rep DescribeDocumentVersions :: * -> *

Methods

from :: DescribeDocumentVersions -> Rep DescribeDocumentVersions x

to :: Rep DescribeDocumentVersions x -> DescribeDocumentVersions

Hashable DescribeDocumentVersions

Methods

hashWithSalt :: Int -> DescribeDocumentVersions -> Int

hash :: DescribeDocumentVersions -> Int

NFData DescribeDocumentVersions

Methods

rnf :: DescribeDocumentVersions -> ()

AWSPager DescribeDocumentVersions

Methods

page :: DescribeDocumentVersions -> Rs DescribeDocumentVersions -> Maybe DescribeDocumentVersions

AWSRequest DescribeDocumentVersions

Associated Types

type Rs DescribeDocumentVersions :: *

Methods

request :: DescribeDocumentVersions -> Request DescribeDocumentVersions

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

ToQuery DescribeDocumentVersions

Methods

toQuery :: DescribeDocumentVersions -> QueryString

ToPath DescribeDocumentVersions

Methods

toPath :: DescribeDocumentVersions -> ByteString

ToHeaders DescribeDocumentVersions

Methods

toHeaders :: DescribeDocumentVersions -> [Header]

type Rep DescribeDocumentVersions

type Rep DescribeDocumentVersions = D1 (MetaData "DescribeDocumentVersions" "Network.AWS.WorkDocs.DescribeDocumentVersions" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "DescribeDocumentVersions'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ddvInclude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ddvAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_ddvMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_ddvLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_ddvFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddvDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs DescribeDocumentVersions

type Rs DescribeDocumentVersions = DescribeDocumentVersionsResponse

Request Lenses

ddvInclude :: Lens' DescribeDocumentVersions (Maybe Text)

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

ddvAuthenticationToken :: Lens' DescribeDocumentVersions (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.

ddvMarker :: Lens' DescribeDocumentVersions (Maybe Text)

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

ddvLimit :: Lens' DescribeDocumentVersions (Maybe Natural)

The maximum number of versions to return with this call.

ddvFields :: Lens' DescribeDocumentVersions (Maybe Text)

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

ddvDocumentId :: Lens' DescribeDocumentVersions Text

The ID of the document.

Destructuring the Response

describeDocumentVersionsResponse

Arguments

:: Int

ddvrsResponseStatus

-> DescribeDocumentVersionsResponse

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

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

• ddvrsDocumentVersions - The document versions.
• ddvrsMarker - The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
• ddvrsResponseStatus - -- | The response status code.

data DescribeDocumentVersionsResponse

See: describeDocumentVersionsResponse smart constructor.

Instances

Eq DescribeDocumentVersionsResponse

Methods

(==) :: DescribeDocumentVersionsResponse -> DescribeDocumentVersionsResponse -> Bool

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

Data DescribeDocumentVersionsResponse

Methods

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

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

toConstr :: DescribeDocumentVersionsResponse -> Constr

dataTypeOf :: DescribeDocumentVersionsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show DescribeDocumentVersionsResponse

Methods

showsPrec :: Int -> DescribeDocumentVersionsResponse -> ShowS

show :: DescribeDocumentVersionsResponse -> String

showList :: [DescribeDocumentVersionsResponse] -> ShowS

Generic DescribeDocumentVersionsResponse

Associated Types

type Rep DescribeDocumentVersionsResponse :: * -> *

Methods

from :: DescribeDocumentVersionsResponse -> Rep DescribeDocumentVersionsResponse x

to :: Rep DescribeDocumentVersionsResponse x -> DescribeDocumentVersionsResponse

NFData DescribeDocumentVersionsResponse

Methods

rnf :: DescribeDocumentVersionsResponse -> ()

type Rep DescribeDocumentVersionsResponse

type Rep DescribeDocumentVersionsResponse = D1 (MetaData "DescribeDocumentVersionsResponse" "Network.AWS.WorkDocs.DescribeDocumentVersions" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "DescribeDocumentVersionsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddvrsDocumentVersions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DocumentVersionMetadata]))) ((:*:) (S1 (MetaSel (Just Symbol "_ddvrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

ddvrsDocumentVersions :: Lens' DescribeDocumentVersionsResponse [DocumentVersionMetadata]

The document versions.

ddvrsMarker :: Lens' DescribeDocumentVersionsResponse (Maybe Text)

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

ddvrsResponseStatus :: Lens' DescribeDocumentVersionsResponse Int

• - | The response status code.