importexport.d.ts (10321B)
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'; 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.Types { 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 ErrorMessage = string; 98 export type GenericString = string; 99 export interface GetShippingLabelInput { 100 jobIds: JobIdList; 101 name?: name; 102 company?: company; 103 phoneNumber?: phoneNumber; 104 country?: country; 105 stateOrProvince?: stateOrProvince; 106 city?: city; 107 postalCode?: postalCode; 108 street1?: street1; 109 street2?: street2; 110 street3?: street3; 111 APIVersion?: APIVersion; 112 } 113 export interface GetShippingLabelOutput { 114 ShippingLabelURL?: GenericString; 115 Warning?: GenericString; 116 } 117 export interface GetStatusInput { 118 JobId: JobId; 119 APIVersion?: APIVersion; 120 } 121 export interface GetStatusOutput { 122 JobId?: JobId; 123 JobType?: JobType; 124 LocationCode?: LocationCode; 125 LocationMessage?: LocationMessage; 126 ProgressCode?: ProgressCode; 127 ProgressMessage?: ProgressMessage; 128 Carrier?: Carrier; 129 TrackingNumber?: TrackingNumber; 130 LogBucket?: LogBucket; 131 LogKey?: LogKey; 132 ErrorCount?: ErrorCount; 133 Signature?: Signature; 134 SignatureFileContents?: Signature; 135 CurrentManifest?: CurrentManifest; 136 CreationDate?: CreationDate; 137 ArtifactList?: ArtifactList; 138 } 139 export type IsCanceled = boolean; 140 export type IsTruncated = boolean; 141 export interface Job { 142 JobId?: JobId; 143 CreationDate?: CreationDate; 144 IsCanceled?: IsCanceled; 145 JobType?: JobType; 146 } 147 export type JobId = string; 148 export type JobIdList = GenericString[]; 149 export type JobType = "Import"|"Export"|string; 150 export type JobsList = Job[]; 151 export interface ListJobsInput { 152 MaxJobs?: MaxJobs; 153 Marker?: Marker; 154 APIVersion?: APIVersion; 155 } 156 export interface ListJobsOutput { 157 Jobs?: JobsList; 158 IsTruncated?: IsTruncated; 159 } 160 export type LocationCode = string; 161 export type LocationMessage = string; 162 export type LogBucket = string; 163 export type LogKey = string; 164 export type Manifest = string; 165 export type ManifestAddendum = string; 166 export type Marker = string; 167 export type MaxJobs = number; 168 export type ProgressCode = string; 169 export type ProgressMessage = string; 170 export type Signature = string; 171 export type SignatureFileContents = string; 172 export type Success = boolean; 173 export type TrackingNumber = string; 174 export type URL = string; 175 export interface UpdateJobInput { 176 JobId: JobId; 177 Manifest: Manifest; 178 JobType: JobType; 179 ValidateOnly: ValidateOnly; 180 APIVersion?: APIVersion; 181 } 182 export interface UpdateJobOutput { 183 Success?: Success; 184 WarningMessage?: WarningMessage; 185 ArtifactList?: ArtifactList; 186 } 187 export type ValidateOnly = boolean; 188 export type WarningMessage = string; 189 export type city = string; 190 export type company = string; 191 export type country = string; 192 export type name = string; 193 export type phoneNumber = string; 194 export type postalCode = string; 195 export type stateOrProvince = string; 196 export type street1 = string; 197 export type street2 = string; 198 export type street3 = string; 199 /** 200 * 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. 201 */ 202 export type apiVersion = "2010-06-01"|"latest"|string; 203 export interface ClientApiVersions { 204 /** 205 * 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. 206 */ 207 apiVersion?: apiVersion; 208 } 209 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 210 } 211 export = ImportExport;