Amazonka.ImportExport.CreateJob

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.

Creating a Request

data CreateJob

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

ToHeaders CreateJob

Defined in Amazonka.ImportExport.CreateJob

Methods

toHeaders :: CreateJob -> [Header]

ToPath CreateJob

Defined in Amazonka.ImportExport.CreateJob

Methods

toPath :: CreateJob -> ByteString

ToQuery CreateJob

Defined in Amazonka.ImportExport.CreateJob

Methods

toQuery :: CreateJob -> QueryString

AWSRequest CreateJob

Defined in Amazonka.ImportExport.CreateJob

Associated Types

type AWSResponse CreateJob

Methods

request :: (Service -> Service) -> CreateJob -> Request CreateJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateJob)))

Generic CreateJob

Defined in Amazonka.ImportExport.CreateJob

Associated Types

type Rep CreateJob :: Type -> Type

Methods

from :: CreateJob -> Rep CreateJob x

to :: Rep CreateJob x -> CreateJob

Read CreateJob

Defined in Amazonka.ImportExport.CreateJob

Methods

readsPrec :: Int -> ReadS CreateJob

readList :: ReadS [CreateJob]

readPrec :: ReadPrec CreateJob

readListPrec :: ReadPrec [CreateJob]

Show CreateJob

Defined in Amazonka.ImportExport.CreateJob

Methods

showsPrec :: Int -> CreateJob -> ShowS

show :: CreateJob -> String

showList :: [CreateJob] -> ShowS

NFData CreateJob

Defined in Amazonka.ImportExport.CreateJob

Methods

rnf :: CreateJob -> ()

Eq CreateJob

Defined in Amazonka.ImportExport.CreateJob

Methods

(==) :: CreateJob -> CreateJob -> Bool

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

Hashable CreateJob

Defined in Amazonka.ImportExport.CreateJob

Methods

hashWithSalt :: Int -> CreateJob -> Int

hash :: CreateJob -> Int

type AWSResponse CreateJob

Defined in Amazonka.ImportExport.CreateJob

type AWSResponse CreateJob = CreateJobResponse

type Rep CreateJob

Defined in Amazonka.ImportExport.CreateJob

type Rep CreateJob = D1 ('MetaData "CreateJob" "Amazonka.ImportExport.CreateJob" "amazonka-importexport-2.0-Jy65964a2E2FHiikVjI7dI" '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)))))

newCreateJob

Arguments

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

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)

Undocumented member.

createJob_manifestAddendum :: Lens' CreateJob (Maybe Text)

Undocumented member.

createJob_jobType :: Lens' CreateJob JobType

Undocumented member.

createJob_manifest :: Lens' CreateJob Text

Undocumented member.

createJob_validateOnly :: Lens' CreateJob Bool

Undocumented member.

Destructuring the Response

data CreateJobResponse

Output structure for the CreateJob operation.

See: newCreateJobResponse smart constructor.

Constructors

CreateJobResponse'

Fields

• artifactList :: Maybe [Artifact]
• jobId :: Maybe Text
• jobType :: Maybe JobType
• signature :: Maybe Text
• signatureFileContents :: Maybe Text
• warningMessage :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateJobResponse

Defined in Amazonka.ImportExport.CreateJob

Associated Types

type Rep CreateJobResponse :: Type -> Type

Methods

from :: CreateJobResponse -> Rep CreateJobResponse x

to :: Rep CreateJobResponse x -> CreateJobResponse

Read CreateJobResponse

Defined in Amazonka.ImportExport.CreateJob

Methods

readsPrec :: Int -> ReadS CreateJobResponse

readList :: ReadS [CreateJobResponse]

readPrec :: ReadPrec CreateJobResponse

readListPrec :: ReadPrec [CreateJobResponse]

Show CreateJobResponse

Defined in Amazonka.ImportExport.CreateJob

Methods

showsPrec :: Int -> CreateJobResponse -> ShowS

show :: CreateJobResponse -> String

showList :: [CreateJobResponse] -> ShowS

NFData CreateJobResponse

Defined in Amazonka.ImportExport.CreateJob

Methods

rnf :: CreateJobResponse -> ()

Eq CreateJobResponse

Defined in Amazonka.ImportExport.CreateJob

Methods

(==) :: CreateJobResponse -> CreateJobResponse -> Bool

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

type Rep CreateJobResponse

Defined in Amazonka.ImportExport.CreateJob

type Rep CreateJobResponse = D1 ('MetaData "CreateJobResponse" "Amazonka.ImportExport.CreateJob" "amazonka-importexport-2.0-Jy65964a2E2FHiikVjI7dI" 'False) (C1 ('MetaCons "CreateJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "artifactList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Artifact])) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobType)))) :*: ((S1 ('MetaSel ('Just "signature") '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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateJobResponse

Arguments

:: Int

$sel:httpStatus:CreateJobResponse'

-> CreateJobResponse

Create a value of CreateJobResponse 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:artifactList:CreateJobResponse', createJobResponse_artifactList - Undocumented member.

CreateJobResponse, createJobResponse_jobId - Undocumented member.

CreateJob, createJobResponse_jobType - Undocumented member.

$sel:signature:CreateJobResponse', createJobResponse_signature - Undocumented member.

$sel:signatureFileContents:CreateJobResponse', createJobResponse_signatureFileContents - Undocumented member.

$sel:warningMessage:CreateJobResponse', createJobResponse_warningMessage - Undocumented member.

$sel:httpStatus:CreateJobResponse', createJobResponse_httpStatus - The response's http status code.

Response Lenses

createJobResponse_artifactList :: Lens' CreateJobResponse (Maybe [Artifact])

Undocumented member.

createJobResponse_jobId :: Lens' CreateJobResponse (Maybe Text)

Undocumented member.

createJobResponse_jobType :: Lens' CreateJobResponse (Maybe JobType)

Undocumented member.

createJobResponse_signature :: Lens' CreateJobResponse (Maybe Text)

Undocumented member.

createJobResponse_signatureFileContents :: Lens' CreateJobResponse (Maybe Text)

Undocumented member.

createJobResponse_warningMessage :: Lens' CreateJobResponse (Maybe Text)

Undocumented member.

createJobResponse_httpStatus :: Lens' CreateJobResponse Int

The response's http status code.