package awso-async

  1. Overview
  2. Docs

Module Awso_importexport_asyncSource

include module type of struct include Awso_importexport.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval xmlNamespace : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

The associated description for this object.

The URL for a given Artifact.

Timestamp of the CreateJob request in ISO8601 date format. For example "2010-03-28T20:27:35Z".

Indicates whether the job was canceled.

A unique identifier which refers to a particular job.

A discrete item that contains the description and URL of an artifact (such as a PDF).

The human-readable description of a particular error.

Representation of a job returned by the ListJobs operation.

The account specified does not have the appropriate bucket permissions.

The specified job ID has been canceled and is no longer valid.

Indicates that the specified job has expired out of the system.

The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.

The address specified in the manifest is invalid.

One or more customs parameters was invalid. Please correct and resubmit.

File system specified in export manifest is invalid.

The JOBID was missing, not found, or not associated with the AWS account.

One or more manifest fields was invalid. Please correct and resubmit.

One or more parameters had an invalid value.

The client tool version is invalid.

Your manifest is not well-formed.

One or more required customs parameters was missing from the manifest.

One or more required fields were missing from the manifest file. Please correct and resubmit.

One or more required parameters was missing from the request.

Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.

The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to.

Specifies whether (true) or not (false) AWS Import/Export updated your job.

AWS Import/Export cannot update the job

An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.

Specifies the version of the client tool.

The UTF-8 encoded text of the manifest file.

Validate the manifest and parameter values in the request but do not actually create a job.

Indicates whether the list of jobs was truncated. If true, then call ListJobs again using the last JobId element as the marker.

Specifies the JOBID to start after when listing the jobs created with your account. AWS Import/Export lists your jobs in reverse chronological order. See MaxJobs.

Sets the maximum number of jobs returned in the response. If there are additional jobs that were not returned because MaxJobs was exceeded, the response contains <IsTruncated>true</IsTruncated>. To return the additional jobs, see Marker.

Name of the shipping company. This value is included when the LocationCode is "Returned".

The last manifest submitted, which will be used to process the job.

Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors.

A token representing the location of the storage device, such as "AtAWS".

A more human readable form of the physical location of the storage device.

Amazon S3 bucket for user logs.

The key where the user logs were stored.

A token representing the state of the job, such as "Started".

A more human readable form of the job status.

An encrypted code used to authenticate the request and response, for example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value.

The shipping tracking number assigned by AWS Import/Export to the storage device when it's returned to you. We return this value when the LocationCode is "Returned".

Specifies the name of your city for the return address.

Specifies the name of the company that will ship this package.

Specifies the name of your country for the return address.

Specifies the name of the person responsible for shipping this package.

Specifies the phone number of the person responsible for shipping this package.

Specifies the postal code for the return address.

Specifies the name of your state or your province for the return address.

Specifies the first part of the street address for the return address, for example 1234 Main Street.

Specifies the optional second part of the street address for the return address, for example Suite 100.

Specifies the optional third part of the street address for the return address, for example c/o Jane Doe.

Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case.

The actual text of the SIGNATURE file to be written to disk.

For internal use only.

AWS Import/Export cannot cancel the job

Output structure for the UpateJob operation.

Input structure for the UpateJob operation.

Output structure for the ListJobs operation.

Input structure for the ListJobs operation.

Output structure for the GetStatus operation.

Input structure for the GetStatus operation.

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

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

Output structure for the CreateJob operation.

Input structure for the CreateJob operation.

Output structure for the CancelJob operation.

Input structure for the CancelJob operation.

Sourcemodule Cli : sig ... end