Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ImportExport.CreateJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.

Synopsis

data CreateJob = CreateJob' {
- aPIVersion :: Maybe Text
- manifestAddendum :: Maybe Text
- jobType :: JobType
- manifest :: Text
- validateOnly :: Bool
}
newCreateJob :: JobType -> Text -> Bool -> CreateJob
createJob_aPIVersion :: Lens' CreateJob (Maybe Text)
createJob_manifestAddendum :: Lens' CreateJob (Maybe Text)
createJob_jobType :: Lens' CreateJob JobType
createJob_manifest :: Lens' CreateJob Text
createJob_validateOnly :: Lens' CreateJob Bool
data CreateJobResponse = CreateJobResponse' {
- signature :: Maybe Text
- jobType :: Maybe JobType
- jobId :: Maybe Text
- signatureFileContents :: Maybe Text
- warningMessage :: Maybe Text
- artifactList :: Maybe [Artifact]
- httpStatus :: Int
}
newCreateJobResponse :: Int -> CreateJobResponse
createJobResponse_signature :: Lens' CreateJobResponse (Maybe Text)
createJobResponse_jobType :: Lens' CreateJobResponse (Maybe JobType)
createJobResponse_jobId :: Lens' CreateJobResponse (Maybe Text)
createJobResponse_signatureFileContents :: Lens' CreateJobResponse (Maybe Text)
createJobResponse_warningMessage :: Lens' CreateJobResponse (Maybe Text)
createJobResponse_artifactList :: Lens' CreateJobResponse (Maybe [Artifact])
createJobResponse_httpStatus :: Lens' CreateJobResponse Int

Creating a Request

data CreateJob Source #

Input structure for the CreateJob operation.

See: newCreateJob smart constructor.

Constructors

CreateJob'
Fields aPIVersion :: Maybe Text manifestAddendum :: Maybe Text jobType :: JobType manifest :: Text validateOnly :: Bool

Instances

Instances details

Eq CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods (==) :: CreateJob -> CreateJob -> Bool # (/=) :: CreateJob -> CreateJob -> Bool #
Read CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods readsPrec :: Int -> ReadS CreateJob # readList :: ReadS [CreateJob] # readPrec :: ReadPrec CreateJob # readListPrec :: ReadPrec [CreateJob] #
Show CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods showsPrec :: Int -> CreateJob -> ShowS # show :: CreateJob -> String # showList :: [CreateJob] -> ShowS #
Generic CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Associated Types type Rep CreateJob :: Type -> Type # Methods from :: CreateJob -> Rep CreateJob x # to :: Rep CreateJob x -> CreateJob #
NFData CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods rnf :: CreateJob -> () #
Hashable CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods hashWithSalt :: Int -> CreateJob -> Int # hash :: CreateJob -> Int #
AWSRequest CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Associated Types type AWSResponse CreateJob # Methods request :: CreateJob -> Request CreateJob # response :: MonadResource m => Logger -> Service -> Proxy CreateJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateJob))) #
ToHeaders CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods toHeaders :: CreateJob -> [Header] #
ToPath CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods toPath :: CreateJob -> ByteString #
ToQuery CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods toQuery :: CreateJob -> QueryString #
type Rep CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob type Rep CreateJob = D1 ('MetaData "CreateJob" "Amazonka.ImportExport.CreateJob" "libZSservicesZSamazonka-importexportZSamazonka-importexport" 'False) (C1 ('MetaCons "CreateJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aPIVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "manifestAddendum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobType) :: (S1 ('MetaSel ('Just "manifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "validateOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))
type AWSResponse CreateJob Source #
Instance details Defined in Amazonka.ImportExport.CreateJob type AWSResponse CreateJob = CreateJobResponse

newCreateJob Source #

Arguments

:: JobType	`$sel:jobType:CreateJob'`
-> Text	`$sel:manifest:CreateJob'`
-> Bool	`$sel:validateOnly:CreateJob'`
-> CreateJob

Create a value of CreateJob 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:aPIVersion:CreateJob', createJob_aPIVersion - Undocumented member.

$sel:manifestAddendum:CreateJob', createJob_manifestAddendum - Undocumented member.

$sel:jobType:CreateJob', createJob_jobType - Undocumented member.

$sel:manifest:CreateJob', createJob_manifest - Undocumented member.

$sel:validateOnly:CreateJob', createJob_validateOnly - Undocumented member.

Request Lenses

createJob_aPIVersion :: Lens' CreateJob (Maybe Text) Source #

Undocumented member.

createJob_manifestAddendum :: Lens' CreateJob (Maybe Text) Source #

Undocumented member.

createJob_jobType :: Lens' CreateJob JobType Source #

Undocumented member.

createJob_manifest :: Lens' CreateJob Text Source #

Undocumented member.

createJob_validateOnly :: Lens' CreateJob Bool Source #

Undocumented member.

Destructuring the Response

data CreateJobResponse Source #

Output structure for the CreateJob operation.

See: newCreateJobResponse smart constructor.

Constructors

CreateJobResponse'
Fields signature :: Maybe Text jobType :: Maybe JobType jobId :: Maybe Text signatureFileContents :: Maybe Text warningMessage :: Maybe Text artifactList :: Maybe [Artifact] httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods (==) :: CreateJobResponse -> CreateJobResponse -> Bool # (/=) :: CreateJobResponse -> CreateJobResponse -> Bool #
Read CreateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods readsPrec :: Int -> ReadS CreateJobResponse # readList :: ReadS [CreateJobResponse] # readPrec :: ReadPrec CreateJobResponse # readListPrec :: ReadPrec [CreateJobResponse] #
Show CreateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods showsPrec :: Int -> CreateJobResponse -> ShowS # show :: CreateJobResponse -> String # showList :: [CreateJobResponse] -> ShowS #
Generic CreateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Associated Types type Rep CreateJobResponse :: Type -> Type # Methods from :: CreateJobResponse -> Rep CreateJobResponse x # to :: Rep CreateJobResponse x -> CreateJobResponse #
NFData CreateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.CreateJob Methods rnf :: CreateJobResponse -> () #
type Rep CreateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.CreateJob type Rep CreateJobResponse = D1 ('MetaData "CreateJobResponse" "Amazonka.ImportExport.CreateJob" "libZSservicesZSamazonka-importexportZSamazonka-importexport" 'False) (C1 ('MetaCons "CreateJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobType)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "signatureFileContents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "warningMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "artifactList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Artifact])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))