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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Changes the status of the document version to ACTIVE.

Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.

Creating a Request

data UpdateDocumentVersion Source #

See: newUpdateDocumentVersion smart constructor.

Constructors

UpdateDocumentVersion'
Fields authenticationToken :: Maybe (Sensitive Text) Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. versionStatus :: Maybe DocumentVersionStatus The status of the version. documentId :: Text The ID of the document. versionId :: Text The version ID of the document.

Instances

Instances details

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

newUpdateDocumentVersion Source #

Arguments

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

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

$sel:versionStatus:UpdateDocumentVersion', updateDocumentVersion_versionStatus - The status of the version.

$sel:documentId:UpdateDocumentVersion', updateDocumentVersion_documentId - The ID of the document.

UpdateDocumentVersion, updateDocumentVersion_versionId - The version ID of the document.

Request Lenses

updateDocumentVersion_authenticationToken :: Lens' UpdateDocumentVersion (Maybe Text) Source #

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

updateDocumentVersion_versionStatus :: Lens' UpdateDocumentVersion (Maybe DocumentVersionStatus) Source #

The status of the version.

updateDocumentVersion_documentId :: Lens' UpdateDocumentVersion Text Source #

The ID of the document.

updateDocumentVersion_versionId :: Lens' UpdateDocumentVersion Text Source #

The version ID of the document.

Destructuring the Response

data UpdateDocumentVersionResponse Source #

See: newUpdateDocumentVersionResponse smart constructor.

Constructors

UpdateDocumentVersionResponse'

Instances

Instances details

Generic UpdateDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocumentVersion Associated Types type Rep UpdateDocumentVersionResponse :: Type -> Type # Methods from :: UpdateDocumentVersionResponse -> Rep UpdateDocumentVersionResponse x # to :: Rep UpdateDocumentVersionResponse x -> UpdateDocumentVersionResponse #
Read UpdateDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocumentVersion Methods readsPrec :: Int -> ReadS UpdateDocumentVersionResponse # readList :: ReadS [UpdateDocumentVersionResponse] # readPrec :: ReadPrec UpdateDocumentVersionResponse # readListPrec :: ReadPrec [UpdateDocumentVersionResponse] #
Show UpdateDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocumentVersion Methods showsPrec :: Int -> UpdateDocumentVersionResponse -> ShowS # show :: UpdateDocumentVersionResponse -> String # showList :: [UpdateDocumentVersionResponse] -> ShowS #
NFData UpdateDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocumentVersion Methods rnf :: UpdateDocumentVersionResponse -> () #
Eq UpdateDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocumentVersion Methods (==) :: UpdateDocumentVersionResponse -> UpdateDocumentVersionResponse -> Bool # (/=) :: UpdateDocumentVersionResponse -> UpdateDocumentVersionResponse -> Bool #
type Rep UpdateDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateDocumentVersion type Rep UpdateDocumentVersionResponse = D1 ('MetaData "UpdateDocumentVersionResponse" "Amazonka.WorkDocs.UpdateDocumentVersion" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "UpdateDocumentVersionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateDocumentVersionResponse :: UpdateDocumentVersionResponse Source #

Create a value of UpdateDocumentVersionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.