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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.

Creating a Request

data AbortDocumentVersionUpload Source #

See: newAbortDocumentVersionUpload smart constructor.

Constructors

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

Instances

Instances details

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

newAbortDocumentVersionUpload Source #

Arguments

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

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

$sel:documentId:AbortDocumentVersionUpload', abortDocumentVersionUpload_documentId - The ID of the document.

AbortDocumentVersionUpload, abortDocumentVersionUpload_versionId - The ID of the version.

Request Lenses

abortDocumentVersionUpload_authenticationToken :: Lens' AbortDocumentVersionUpload (Maybe Text) Source #

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

abortDocumentVersionUpload_documentId :: Lens' AbortDocumentVersionUpload Text Source #

The ID of the document.

abortDocumentVersionUpload_versionId :: Lens' AbortDocumentVersionUpload Text Source #

The ID of the version.

Destructuring the Response

data AbortDocumentVersionUploadResponse Source #

See: newAbortDocumentVersionUploadResponse smart constructor.

Constructors

AbortDocumentVersionUploadResponse'

Instances

Instances details

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

newAbortDocumentVersionUploadResponse :: AbortDocumentVersionUploadResponse Source #

Create a value of AbortDocumentVersionUploadResponse with all optional fields omitted.

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