importexport.d.ts
  1  import {Request} from '../lib/request';
  2  import {Response} from '../lib/response';
  3  import {AWSError} from '../lib/error';
  4  import {Service} from '../lib/service';
  5  import {ServiceConfigurationOptions} from '../lib/service';
  6  import {ConfigBase as Config} from '../lib/config-base';
  7  interface Blob {}
  8  declare class ImportExport extends Service {
  9    /**
 10     * Constructs a service object. This object has one method for each API operation.
 11     */
 12    constructor(options?: ImportExport.Types.ClientConfiguration)
 13    config: Config & ImportExport.Types.ClientConfiguration;
 14    /**
 15     * 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.
 16     */
 17    cancelJob(params: ImportExport.Types.CancelJobInput, callback?: (err: AWSError, data: ImportExport.Types.CancelJobOutput) => void): Request<ImportExport.Types.CancelJobOutput, AWSError>;
 18    /**
 19     * 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.
 20     */
 21    cancelJob(callback?: (err: AWSError, data: ImportExport.Types.CancelJobOutput) => void): Request<ImportExport.Types.CancelJobOutput, AWSError>;
 22    /**
 23     * 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.
 24     */
 25    createJob(params: ImportExport.Types.CreateJobInput, callback?: (err: AWSError, data: ImportExport.Types.CreateJobOutput) => void): Request<ImportExport.Types.CreateJobOutput, AWSError>;
 26    /**
 27     * 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.
 28     */
 29    createJob(callback?: (err: AWSError, data: ImportExport.Types.CreateJobOutput) => void): Request<ImportExport.Types.CreateJobOutput, AWSError>;
 30    /**
 31     * This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
 32     */
 33    getShippingLabel(params: ImportExport.Types.GetShippingLabelInput, callback?: (err: AWSError, data: ImportExport.Types.GetShippingLabelOutput) => void): Request<ImportExport.Types.GetShippingLabelOutput, AWSError>;
 34    /**
 35     * This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
 36     */
 37    getShippingLabel(callback?: (err: AWSError, data: ImportExport.Types.GetShippingLabelOutput) => void): Request<ImportExport.Types.GetShippingLabelOutput, AWSError>;
 38    /**
 39     * 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.
 40     */
 41    getStatus(params: ImportExport.Types.GetStatusInput, callback?: (err: AWSError, data: ImportExport.Types.GetStatusOutput) => void): Request<ImportExport.Types.GetStatusOutput, AWSError>;
 42    /**
 43     * 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.
 44     */
 45    getStatus(callback?: (err: AWSError, data: ImportExport.Types.GetStatusOutput) => void): Request<ImportExport.Types.GetStatusOutput, AWSError>;
 46    /**
 47     * 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.
 48     */
 49    listJobs(params: ImportExport.Types.ListJobsInput, callback?: (err: AWSError, data: ImportExport.Types.ListJobsOutput) => void): Request<ImportExport.Types.ListJobsOutput, AWSError>;
 50    /**
 51     * 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.
 52     */
 53    listJobs(callback?: (err: AWSError, data: ImportExport.Types.ListJobsOutput) => void): Request<ImportExport.Types.ListJobsOutput, AWSError>;
 54    /**
 55     * 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.
 56     */
 57    updateJob(params: ImportExport.Types.UpdateJobInput, callback?: (err: AWSError, data: ImportExport.Types.UpdateJobOutput) => void): Request<ImportExport.Types.UpdateJobOutput, AWSError>;
 58    /**
 59     * 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.
 60     */
 61    updateJob(callback?: (err: AWSError, data: ImportExport.Types.UpdateJobOutput) => void): Request<ImportExport.Types.UpdateJobOutput, AWSError>;
 62  }
 63  declare namespace ImportExport {
 64    export type APIVersion = string;
 65    export interface Artifact {
 66      Description?: Description;
 67      URL?: URL;
 68    }
 69    export type ArtifactList = Artifact[];
 70    export interface CancelJobInput {
 71      JobId: JobId;
 72      APIVersion?: APIVersion;
 73    }
 74    export interface CancelJobOutput {
 75      Success?: Success;
 76    }
 77    export type Carrier = string;
 78    export interface CreateJobInput {
 79      JobType: JobType;
 80      Manifest: Manifest;
 81      ManifestAddendum?: ManifestAddendum;
 82      ValidateOnly: ValidateOnly;
 83      APIVersion?: APIVersion;
 84    }
 85    export interface CreateJobOutput {
 86      JobId?: JobId;
 87      JobType?: JobType;
 88      Signature?: Signature;
 89      SignatureFileContents?: SignatureFileContents;
 90      WarningMessage?: WarningMessage;
 91      ArtifactList?: ArtifactList;
 92    }
 93    export type CreationDate = Date;
 94    export type CurrentManifest = string;
 95    export type Description = string;
 96    export type ErrorCount = number;
 97    export type GenericString = string;
 98    export interface GetShippingLabelInput {
 99      jobIds: JobIdList;
100      name?: name;
101      company?: company;
102      phoneNumber?: phoneNumber;
103      country?: country;
104      stateOrProvince?: stateOrProvince;
105      city?: city;
106      postalCode?: postalCode;
107      street1?: street1;
108      street2?: street2;
109      street3?: street3;
110      APIVersion?: APIVersion;
111    }
112    export interface GetShippingLabelOutput {
113      ShippingLabelURL?: GenericString;
114      Warning?: GenericString;
115    }
116    export interface GetStatusInput {
117      JobId: JobId;
118      APIVersion?: APIVersion;
119    }
120    export interface GetStatusOutput {
121      JobId?: JobId;
122      JobType?: JobType;
123      LocationCode?: LocationCode;
124      LocationMessage?: LocationMessage;
125      ProgressCode?: ProgressCode;
126      ProgressMessage?: ProgressMessage;
127      Carrier?: Carrier;
128      TrackingNumber?: TrackingNumber;
129      LogBucket?: LogBucket;
130      LogKey?: LogKey;
131      ErrorCount?: ErrorCount;
132      Signature?: Signature;
133      SignatureFileContents?: Signature;
134      CurrentManifest?: CurrentManifest;
135      CreationDate?: CreationDate;
136      ArtifactList?: ArtifactList;
137    }
138    export type IsCanceled = boolean;
139    export type IsTruncated = boolean;
140    export interface Job {
141      JobId?: JobId;
142      CreationDate?: CreationDate;
143      IsCanceled?: IsCanceled;
144      JobType?: JobType;
145    }
146    export type JobId = string;
147    export type JobIdList = GenericString[];
148    export type JobType = "Import"|"Export"|string;
149    export type JobsList = Job[];
150    export interface ListJobsInput {
151      MaxJobs?: MaxJobs;
152      Marker?: Marker;
153      APIVersion?: APIVersion;
154    }
155    export interface ListJobsOutput {
156      Jobs?: JobsList;
157      IsTruncated?: IsTruncated;
158    }
159    export type LocationCode = string;
160    export type LocationMessage = string;
161    export type LogBucket = string;
162    export type LogKey = string;
163    export type Manifest = string;
164    export type ManifestAddendum = string;
165    export type Marker = string;
166    export type MaxJobs = number;
167    export type ProgressCode = string;
168    export type ProgressMessage = string;
169    export type Signature = string;
170    export type SignatureFileContents = string;
171    export type Success = boolean;
172    export type TrackingNumber = string;
173    export type URL = string;
174    export interface UpdateJobInput {
175      JobId: JobId;
176      Manifest: Manifest;
177      JobType: JobType;
178      ValidateOnly: ValidateOnly;
179      APIVersion?: APIVersion;
180    }
181    export interface UpdateJobOutput {
182      Success?: Success;
183      WarningMessage?: WarningMessage;
184      ArtifactList?: ArtifactList;
185    }
186    export type ValidateOnly = boolean;
187    export type WarningMessage = string;
188    export type city = string;
189    export type company = string;
190    export type country = string;
191    export type name = string;
192    export type phoneNumber = string;
193    export type postalCode = string;
194    export type stateOrProvince = string;
195    export type street1 = string;
196    export type street2 = string;
197    export type street3 = string;
198    /**
199     * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
200     */
201    export type apiVersion = "2010-06-01"|"latest"|string;
202    export interface ClientApiVersions {
203      /**
204       * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
205       */
206      apiVersion?: apiVersion;
207    }
208    export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
209    /**
210     * Contains interfaces for use with the ImportExport client.
211     */
212    export import Types = ImportExport;
213  }
214  export = ImportExport;