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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new document object and version object.

The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.

To cancel the document upload, call AbortDocumentVersionUpload.

Synopsis

Creating a Request

data InitiateDocumentVersionUpload Source #

See: newInitiateDocumentVersionUpload smart constructor.

Constructors

InitiateDocumentVersionUpload'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
contentCreatedTimestamp :: Maybe POSIX
The timestamp when the content of the document was originally created.
contentModifiedTimestamp :: Maybe POSIX
The timestamp when the content of the document was modified.
contentType :: Maybe Text
The content type of the document.
documentSizeInBytes :: Maybe Integer
The size of the document, in bytes.
id :: Maybe Text
The ID of the document.
name :: Maybe Text
The name of the document.
parentFolderId :: Maybe Text
The ID of the parent folder.

Instances

Instances details

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

newInitiateDocumentVersionUpload :: InitiateDocumentVersionUpload Source #

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

InitiateDocumentVersionUpload, initiateDocumentVersionUpload_contentCreatedTimestamp - The timestamp when the content of the document was originally created.

InitiateDocumentVersionUpload, initiateDocumentVersionUpload_contentModifiedTimestamp - The timestamp when the content of the document was modified.

InitiateDocumentVersionUpload, initiateDocumentVersionUpload_contentType - The content type of the document.

$sel:documentSizeInBytes:InitiateDocumentVersionUpload', initiateDocumentVersionUpload_documentSizeInBytes - The size of the document, in bytes.

InitiateDocumentVersionUpload, initiateDocumentVersionUpload_id - The ID of the document.

InitiateDocumentVersionUpload, initiateDocumentVersionUpload_name - The name of the document.

InitiateDocumentVersionUpload, initiateDocumentVersionUpload_parentFolderId - The ID of the parent folder.

Request Lenses

initiateDocumentVersionUpload_authenticationToken :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #

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

initiateDocumentVersionUpload_contentCreatedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime) Source #

The timestamp when the content of the document was originally created.

initiateDocumentVersionUpload_contentModifiedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime) Source #

The timestamp when the content of the document was modified.

initiateDocumentVersionUpload_contentType :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #

The content type of the document.

initiateDocumentVersionUpload_documentSizeInBytes :: Lens' InitiateDocumentVersionUpload (Maybe Integer) Source #

The size of the document, in bytes.

initiateDocumentVersionUpload_id :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #

The ID of the document.

initiateDocumentVersionUpload_name :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #

The name of the document.

initiateDocumentVersionUpload_parentFolderId :: Lens' InitiateDocumentVersionUpload (Maybe Text) Source #

The ID of the parent folder.

Destructuring the Response

data InitiateDocumentVersionUploadResponse Source #

See: newInitiateDocumentVersionUploadResponse smart constructor.

Constructors

InitiateDocumentVersionUploadResponse'
Fields metadata :: Maybe DocumentMetadata The document metadata. uploadMetadata :: Maybe UploadMetadata The upload metadata. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic InitiateDocumentVersionUploadResponse Source #
Instance details Defined in Amazonka.WorkDocs.InitiateDocumentVersionUpload Associated Types type Rep InitiateDocumentVersionUploadResponse :: Type -> Type # Methods from :: InitiateDocumentVersionUploadResponse -> Rep InitiateDocumentVersionUploadResponse x # to :: Rep InitiateDocumentVersionUploadResponse x -> InitiateDocumentVersionUploadResponse #
Show InitiateDocumentVersionUploadResponse Source #
Instance details Defined in Amazonka.WorkDocs.InitiateDocumentVersionUpload Methods showsPrec :: Int -> InitiateDocumentVersionUploadResponse -> ShowS # show :: InitiateDocumentVersionUploadResponse -> String # showList :: [InitiateDocumentVersionUploadResponse] -> ShowS #
NFData InitiateDocumentVersionUploadResponse Source #
Instance details Defined in Amazonka.WorkDocs.InitiateDocumentVersionUpload Methods rnf :: InitiateDocumentVersionUploadResponse -> () #
Eq InitiateDocumentVersionUploadResponse Source #
Instance details Defined in Amazonka.WorkDocs.InitiateDocumentVersionUpload Methods (==) :: InitiateDocumentVersionUploadResponse -> InitiateDocumentVersionUploadResponse -> Bool # (/=) :: InitiateDocumentVersionUploadResponse -> InitiateDocumentVersionUploadResponse -> Bool #
type Rep InitiateDocumentVersionUploadResponse Source #
Instance details Defined in Amazonka.WorkDocs.InitiateDocumentVersionUpload type Rep InitiateDocumentVersionUploadResponse = D1 ('MetaData "InitiateDocumentVersionUploadResponse" "Amazonka.WorkDocs.InitiateDocumentVersionUpload" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "InitiateDocumentVersionUploadResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :: (S1 ('MetaSel ('Just "uploadMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UploadMetadata)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newInitiateDocumentVersionUploadResponse Source #

Arguments

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

Create a value of InitiateDocumentVersionUploadResponse 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:metadata:InitiateDocumentVersionUploadResponse', initiateDocumentVersionUploadResponse_metadata - The document metadata.

$sel:uploadMetadata:InitiateDocumentVersionUploadResponse', initiateDocumentVersionUploadResponse_uploadMetadata - The upload metadata.

$sel:httpStatus:InitiateDocumentVersionUploadResponse', initiateDocumentVersionUploadResponse_httpStatus - The response's http status code.

Response Lenses

initiateDocumentVersionUploadResponse_metadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe DocumentMetadata) Source #

The document metadata.

initiateDocumentVersionUploadResponse_uploadMetadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe UploadMetadata) Source #

The upload metadata.

initiateDocumentVersionUploadResponse_httpStatus :: Lens' InitiateDocumentVersionUploadResponse Int Source #

The response's http status code.