ExAws.ImportExport.Core

AWS Import/Export

AWS Import/Export Service

AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon’s high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity.

Source

Summary

cancel_job!(client, input)

Same as cancel_job/2 but raise on error

cancel_job(client, input)

CancelJob

create_job!(client, input)

Same as create_job/2 but raise on error

create_job(client, input)

CreateJob

get_shipping_label!(client, input)

Same as get_shipping_label/2 but raise on error

get_shipping_label(client, input)

GetShippingLabel

get_status!(client, input)

Same as get_status/2 but raise on error

get_status(client, input)

GetStatus

list_jobs!(client, input)

Same as list_jobs/2 but raise on error

list_jobs(client, input)

ListJobs

update_job!(client, input)

Same as update_job/2 but raise on error

update_job(client, input)

UpdateJob

Types

job :: [creation_date: creation_date, is_canceled: is_canceled, job_id: job_id, job_type: job_type]

manifest :: binary

generic_string :: binary

error_message :: binary

creation_date :: integer

list_jobs_output :: [is_truncated: is_truncated, jobs: jobs_list]

artifact :: [description: description, url: url]

progress_message :: binary

location_code :: binary

tracking_number :: binary

description :: binary

cancel_job_input :: [api_version: api_version, job_id: job_id]

get_shipping_label_output :: [shipping_label_url: generic_string, warning: generic_string]

job_type :: binary

jobs_list :: [job]

success :: boolean

create_job_input :: [api_version: api_version, job_type: job_type, manifest: manifest, manifest_addendum: manifest_addendum, validate_only: validate_only]

update_job_input :: [api_version: api_version, job_id: job_id, job_type: job_type, manifest: manifest, validate_only: validate_only]

carrier :: binary

location_message :: binary

current_manifest :: binary

log_bucket :: binary

get_status_input :: [api_version: api_version, job_id: job_id]

is_truncated :: boolean

cancel_job_output :: [{:success, success}]

log_key :: binary

get_shipping_label_input :: [api_version: generic_string, city: generic_string, company: generic_string, country: generic_string, job_ids: job_id_list, name: generic_string, phone_number: generic_string, postal_code: generic_string, state_or_province: generic_string, street1: generic_string, street2: generic_string, street3: generic_string]

api_version :: binary

marker :: binary

warning_message :: binary

manifest_addendum :: binary

list_jobs_input :: [api_version: api_version, marker: marker, max_jobs: max_jobs]

signature :: binary

progress_code :: binary

max_jobs :: integer

is_canceled :: boolean

update_job_output :: [artifact_list: artifact_list, success: success, warning_message: warning_message]

job_id :: binary

create_job_output :: [artifact_list: artifact_list, job_id: job_id, job_type: job_type, signature: signature, signature_file_contents: signature_file_contents, warning_message: warning_message]

url :: binary

get_status_output :: [artifact_list: artifact_list, carrier: carrier, creation_date: creation_date, current_manifest: current_manifest, error_count: error_count, job_id: job_id, job_type: job_type, location_code: location_code, location_message: location_message, log_bucket: log_bucket, log_key: log_key, progress_code: progress_code, progress_message: progress_message, signature: signature, signature_file_contents: signature, tracking_number: tracking_number]

validate_only :: boolean

error_count :: integer

Functions

cancel_job(client, input)

Specs:

  • cancel_job(client :: ExAws.ImportExport.t, input :: cancel_job_input) :: ExAws.Request.Query.response_t

CancelJob

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

Source
cancel_job!(client, input)

Specs:

  • cancel_job!(client :: ExAws.ImportExport.t, input :: cancel_job_input) :: ExAws.Request.Query.success_t | no_return

Same as cancel_job/2 but raise on error.

Source
create_job(client, input)

Specs:

  • create_job(client :: ExAws.ImportExport.t, input :: create_job_input) :: ExAws.Request.Query.response_t

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.

Source
create_job!(client, input)

Specs:

  • create_job!(client :: ExAws.ImportExport.t, input :: create_job_input) :: ExAws.Request.Query.success_t | no_return

Same as create_job/2 but raise on error.

Source
get_shipping_label(client, input)

Specs:

  • get_shipping_label(client :: ExAws.ImportExport.t, input :: get_shipping_label_input) :: ExAws.Request.Query.response_t

GetShippingLabel

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

Source
get_shipping_label!(client, input)

Specs:

  • get_shipping_label!(client :: ExAws.ImportExport.t, input :: get_shipping_label_input) :: ExAws.Request.Query.success_t | no_return

Same as get_shipping_label/2 but raise on error.

Source
get_status(client, input)

Specs:

  • get_status(client :: ExAws.ImportExport.t, input :: get_status_input) :: ExAws.Request.Query.response_t

GetStatus

This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.

Source
get_status!(client, input)

Specs:

  • get_status!(client :: ExAws.ImportExport.t, input :: get_status_input) :: ExAws.Request.Query.success_t | no_return

Same as get_status/2 but raise on error.

Source
list_jobs(client, input)

Specs:

  • list_jobs(client :: ExAws.ImportExport.t, input :: list_jobs_input) :: ExAws.Request.Query.response_t

ListJobs

This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

Source
list_jobs!(client, input)

Specs:

  • list_jobs!(client :: ExAws.ImportExport.t, input :: list_jobs_input) :: ExAws.Request.Query.success_t | no_return

Same as list_jobs/2 but raise on error.

Source
update_job(client, input)

Specs:

  • update_job(client :: ExAws.ImportExport.t, input :: update_job_input) :: ExAws.Request.Query.response_t

UpdateJob

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

Source
update_job!(client, input)

Specs:

  • update_job!(client :: ExAws.ImportExport.t, input :: update_job_input) :: ExAws.Request.Query.success_t | no_return

Same as update_job/2 but raise on error.

Source