Network.AWS.WorkDocs.InitiateDocumentVersionUpload

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 .

Creating a Request

initiateDocumentVersionUpload

Arguments

:: Text

idvuParentFolderId

-> InitiateDocumentVersionUpload

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

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

• idvuDocumentSizeInBytes - The size of the document, in bytes.
• idvuContentCreatedTimestamp - The time stamp when the content of the document was originally created.
• idvuAuthenticationToken - Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.
• idvuName - The name of the document.
• idvuId - The ID of the document.
• idvuContentModifiedTimestamp - The time stamp when the content of the document was modified.
• idvuContentType - The content type of the document.
• idvuParentFolderId - The ID of the parent folder.

data InitiateDocumentVersionUpload

See: initiateDocumentVersionUpload smart constructor.

Instances

Eq InitiateDocumentVersionUpload

Methods

(==) :: InitiateDocumentVersionUpload -> InitiateDocumentVersionUpload -> Bool

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

Data InitiateDocumentVersionUpload

Methods

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

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

toConstr :: InitiateDocumentVersionUpload -> Constr

dataTypeOf :: InitiateDocumentVersionUpload -> DataType

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

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

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

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

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

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

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

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

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

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

Show InitiateDocumentVersionUpload

Methods

showsPrec :: Int -> InitiateDocumentVersionUpload -> ShowS

show :: InitiateDocumentVersionUpload -> String

showList :: [InitiateDocumentVersionUpload] -> ShowS

Generic InitiateDocumentVersionUpload

Associated Types

type Rep InitiateDocumentVersionUpload :: * -> *

Methods

from :: InitiateDocumentVersionUpload -> Rep InitiateDocumentVersionUpload x

to :: Rep InitiateDocumentVersionUpload x -> InitiateDocumentVersionUpload

Hashable InitiateDocumentVersionUpload

Methods

hashWithSalt :: Int -> InitiateDocumentVersionUpload -> Int

hash :: InitiateDocumentVersionUpload -> Int

ToJSON InitiateDocumentVersionUpload

Methods

toJSON :: InitiateDocumentVersionUpload -> Value

toEncoding :: InitiateDocumentVersionUpload -> Encoding

toJSONList :: [InitiateDocumentVersionUpload] -> Value

toEncodingList :: [InitiateDocumentVersionUpload] -> Encoding

NFData InitiateDocumentVersionUpload

Methods

rnf :: InitiateDocumentVersionUpload -> ()

AWSRequest InitiateDocumentVersionUpload

Associated Types

type Rs InitiateDocumentVersionUpload :: *

Methods

request :: InitiateDocumentVersionUpload -> Request InitiateDocumentVersionUpload

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

ToQuery InitiateDocumentVersionUpload

Methods

toQuery :: InitiateDocumentVersionUpload -> QueryString

ToPath InitiateDocumentVersionUpload

Methods

toPath :: InitiateDocumentVersionUpload -> ByteString

ToHeaders InitiateDocumentVersionUpload

Methods

toHeaders :: InitiateDocumentVersionUpload -> [Header]

type Rep InitiateDocumentVersionUpload

type Rep InitiateDocumentVersionUpload = D1 (MetaData "InitiateDocumentVersionUpload" "Network.AWS.WorkDocs.InitiateDocumentVersionUpload" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "InitiateDocumentVersionUpload'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_idvuDocumentSizeInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_idvuContentCreatedTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_idvuAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_idvuName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_idvuId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_idvuContentModifiedTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_idvuContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_idvuParentFolderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs InitiateDocumentVersionUpload

type Rs InitiateDocumentVersionUpload = InitiateDocumentVersionUploadResponse

Request Lenses

idvuDocumentSizeInBytes :: Lens' InitiateDocumentVersionUpload (Maybe Integer)

The size of the document, in bytes.

idvuContentCreatedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)

The time stamp when the content of the document was originally created.

idvuAuthenticationToken :: Lens' InitiateDocumentVersionUpload (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.

idvuName :: Lens' InitiateDocumentVersionUpload (Maybe Text)

The name of the document.

idvuId :: Lens' InitiateDocumentVersionUpload (Maybe Text)

The ID of the document.

idvuContentModifiedTimestamp :: Lens' InitiateDocumentVersionUpload (Maybe UTCTime)

The time stamp when the content of the document was modified.

idvuContentType :: Lens' InitiateDocumentVersionUpload (Maybe Text)

The content type of the document.

idvuParentFolderId :: Lens' InitiateDocumentVersionUpload Text

The ID of the parent folder.

Destructuring the Response

initiateDocumentVersionUploadResponse

Arguments

:: Int

idvursResponseStatus

-> InitiateDocumentVersionUploadResponse

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

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

• idvursMetadata - The document metadata.
• idvursUploadMetadata - The upload metadata.
• idvursResponseStatus - -- | The response status code.

data InitiateDocumentVersionUploadResponse

See: initiateDocumentVersionUploadResponse smart constructor.

Instances

Eq InitiateDocumentVersionUploadResponse

Methods

(==) :: InitiateDocumentVersionUploadResponse -> InitiateDocumentVersionUploadResponse -> Bool

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

Data InitiateDocumentVersionUploadResponse

Methods

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

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

toConstr :: InitiateDocumentVersionUploadResponse -> Constr

dataTypeOf :: InitiateDocumentVersionUploadResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show InitiateDocumentVersionUploadResponse

Methods

showsPrec :: Int -> InitiateDocumentVersionUploadResponse -> ShowS

show :: InitiateDocumentVersionUploadResponse -> String

showList :: [InitiateDocumentVersionUploadResponse] -> ShowS

Generic InitiateDocumentVersionUploadResponse

Associated Types

type Rep InitiateDocumentVersionUploadResponse :: * -> *

Methods

from :: InitiateDocumentVersionUploadResponse -> Rep InitiateDocumentVersionUploadResponse x

to :: Rep InitiateDocumentVersionUploadResponse x -> InitiateDocumentVersionUploadResponse

NFData InitiateDocumentVersionUploadResponse

Methods

rnf :: InitiateDocumentVersionUploadResponse -> ()

type Rep InitiateDocumentVersionUploadResponse

type Rep InitiateDocumentVersionUploadResponse = D1 (MetaData "InitiateDocumentVersionUploadResponse" "Network.AWS.WorkDocs.InitiateDocumentVersionUpload" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "InitiateDocumentVersionUploadResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_idvursMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentMetadata))) ((:*:) (S1 (MetaSel (Just Symbol "_idvursUploadMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UploadMetadata))) (S1 (MetaSel (Just Symbol "_idvursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

idvursMetadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe DocumentMetadata)

The document metadata.

idvursUploadMetadata :: Lens' InitiateDocumentVersionUploadResponse (Maybe UploadMetadata)

The upload metadata.

idvursResponseStatus :: Lens' InitiateDocumentVersionUploadResponse Int

• - | The response status code.