snowball.d.ts (31480B)
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 Snowball extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: Snowball.Types.ClientConfiguration) 13 config: Config & Snowball.Types.ClientConfiguration; 14 /** 15 * Cancels the specified job. Note that you can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action will return a job's JobState as part of the response element data returned. 16 */ 17 cancelJob(params: Snowball.Types.CancelJobRequest, callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request<Snowball.Types.CancelJobResult, AWSError>; 18 /** 19 * Cancels the specified job. Note that you can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action will return a job's JobState as part of the response element data returned. 20 */ 21 cancelJob(callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request<Snowball.Types.CancelJobResult, AWSError>; 22 /** 23 * Creates an address for a Snowball to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. 24 */ 25 createAddress(params: Snowball.Types.CreateAddressRequest, callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request<Snowball.Types.CreateAddressResult, AWSError>; 26 /** 27 * Creates an address for a Snowball to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. 28 */ 29 createAddress(callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request<Snowball.Types.CreateAddressResult, AWSError>; 30 /** 31 * Creates a job to import or export data between Amazon S3 and your on-premises data center. Note that your AWS account must have the right trust policies and permissions in place to create a job for Snowball. For more information, see api-reference-policies. 32 */ 33 createJob(params: Snowball.Types.CreateJobRequest, callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request<Snowball.Types.CreateJobResult, AWSError>; 34 /** 35 * Creates a job to import or export data between Amazon S3 and your on-premises data center. Note that your AWS account must have the right trust policies and permissions in place to create a job for Snowball. For more information, see api-reference-policies. 36 */ 37 createJob(callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request<Snowball.Types.CreateJobResult, AWSError>; 38 /** 39 * Takes an AddressId and returns specific details about that address in the form of an Address object. 40 */ 41 describeAddress(params: Snowball.Types.DescribeAddressRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request<Snowball.Types.DescribeAddressResult, AWSError>; 42 /** 43 * Takes an AddressId and returns specific details about that address in the form of an Address object. 44 */ 45 describeAddress(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request<Snowball.Types.DescribeAddressResult, AWSError>; 46 /** 47 * Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions. 48 */ 49 describeAddresses(params: Snowball.Types.DescribeAddressesRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request<Snowball.Types.DescribeAddressesResult, AWSError>; 50 /** 51 * Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions. 52 */ 53 describeAddresses(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request<Snowball.Types.DescribeAddressesResult, AWSError>; 54 /** 55 * Returns information about a specific job including shipping information, job status, and other important metadata. 56 */ 57 describeJob(params: Snowball.Types.DescribeJobRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request<Snowball.Types.DescribeJobResult, AWSError>; 58 /** 59 * Returns information about a specific job including shipping information, job status, and other important metadata. 60 */ 61 describeJob(callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request<Snowball.Types.DescribeJobResult, AWSError>; 62 /** 63 * Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. Note that the credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created. 64 */ 65 getJobManifest(params: Snowball.Types.GetJobManifestRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request<Snowball.Types.GetJobManifestResult, AWSError>; 66 /** 67 * Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. Note that the credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created. 68 */ 69 getJobManifest(callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request<Snowball.Types.GetJobManifestResult, AWSError>; 70 /** 71 * Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. 72 */ 73 getJobUnlockCode(params: Snowball.Types.GetJobUnlockCodeRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request<Snowball.Types.GetJobUnlockCodeResult, AWSError>; 74 /** 75 * Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. 76 */ 77 getJobUnlockCode(callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request<Snowball.Types.GetJobUnlockCodeResult, AWSError>; 78 /** 79 * Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use. Note that the default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support. 80 */ 81 getSnowballUsage(params: Snowball.Types.GetSnowballUsageRequest, callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request<Snowball.Types.GetSnowballUsageResult, AWSError>; 82 /** 83 * Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use. Note that the default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support. 84 */ 85 getSnowballUsage(callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request<Snowball.Types.GetSnowballUsageResult, AWSError>; 86 /** 87 * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions. 88 */ 89 listJobs(params: Snowball.Types.ListJobsRequest, callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request<Snowball.Types.ListJobsResult, AWSError>; 90 /** 91 * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions. 92 */ 93 listJobs(callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request<Snowball.Types.ListJobsResult, AWSError>; 94 /** 95 * While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available. 96 */ 97 updateJob(params: Snowball.Types.UpdateJobRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request<Snowball.Types.UpdateJobResult, AWSError>; 98 /** 99 * While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available. 100 */ 101 updateJob(callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request<Snowball.Types.UpdateJobResult, AWSError>; 102 } 103 declare namespace Snowball.Types { 104 export interface Address { 105 /** 106 * The unique ID for an address. 107 */ 108 AddressId?: AddressId; 109 /** 110 * The name of a person to receive a Snowball at an address. 111 */ 112 Name?: String; 113 /** 114 * The name of the company to receive a Snowball at an address. 115 */ 116 Company?: String; 117 /** 118 * The first line in a street address that a Snowball is to be delivered to. 119 */ 120 Street1?: String; 121 /** 122 * The second line in a street address that a Snowball is to be delivered to. 123 */ 124 Street2?: String; 125 /** 126 * The third line in a street address that a Snowball is to be delivered to. 127 */ 128 Street3?: String; 129 /** 130 * The city in an address that a Snowball is to be delivered to. 131 */ 132 City?: String; 133 /** 134 * The state or province in an address that a Snowball is to be delivered to. 135 */ 136 StateOrProvince?: String; 137 /** 138 * The prefecture or district in an address that a Snowball is to be delivered to. 139 */ 140 PrefectureOrDistrict?: String; 141 /** 142 * A landmark listed in an address that a Snowball is to be delivered to. 143 */ 144 Landmark?: String; 145 /** 146 * The country in an address that a Snowball is to be delivered to. 147 */ 148 Country?: String; 149 /** 150 * The postal code in an address that a Snowball is to be delivered to. 151 */ 152 PostalCode?: String; 153 /** 154 * The phone number associated with an address that a Snowball is to be delivered to. 155 */ 156 PhoneNumber?: String; 157 } 158 export type AddressId = string; 159 export type AddressList = Address[]; 160 export type Boolean = boolean; 161 export interface CancelJobRequest { 162 /** 163 * The 39 character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000. 164 */ 165 JobId: JobId; 166 } 167 export interface CancelJobResult { 168 } 169 export interface CreateAddressRequest { 170 /** 171 * The address that you want the Snowball shipped to. 172 */ 173 Address: Address; 174 } 175 export interface CreateAddressResult { 176 /** 177 * The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snowball for that job shipped to. 178 */ 179 AddressId?: String; 180 } 181 export interface CreateJobRequest { 182 /** 183 * Defines the type of job that you're creating. 184 */ 185 JobType: JobType; 186 /** 187 * Defines the Amazon S3 buckets associated with this job. With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into. With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted. 188 */ 189 Resources: JobResource; 190 /** 191 * Defines an optional description of this specific job, for example Important Photos 2016-08-11. 192 */ 193 Description?: String; 194 /** 195 * The ID for the address that you want the Snowball shipped to. 196 */ 197 AddressId: AddressId; 198 /** 199 * The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action. 200 */ 201 KmsKeyARN?: KmsKeyARN; 202 /** 203 * The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action. 204 */ 205 RoleARN: RoleARN; 206 /** 207 * If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity. 208 */ 209 SnowballCapacityPreference?: SnowballCapacity; 210 /** 211 * The shipping speed for this job. Note that this speed does not dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, Snowballs are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping. 212 */ 213 ShippingOption: ShippingOption; 214 /** 215 * Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job. 216 */ 217 Notification?: Notification; 218 } 219 export interface CreateJobResult { 220 /** 221 * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 222 */ 223 JobId?: JobId; 224 } 225 export interface DataTransfer { 226 /** 227 * The number of bytes transferred between a Snowball and Amazon S3. 228 */ 229 BytesTransferred?: Long; 230 /** 231 * The number of objects transferred between a Snowball and Amazon S3. 232 */ 233 ObjectsTransferred?: Long; 234 /** 235 * The total bytes of data for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed. 236 */ 237 TotalBytes?: Long; 238 /** 239 * The total number of objects for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed. 240 */ 241 TotalObjects?: Long; 242 } 243 export interface DescribeAddressRequest { 244 /** 245 * The automatically generated ID for a specific address. 246 */ 247 AddressId: AddressId; 248 } 249 export interface DescribeAddressResult { 250 /** 251 * The address that you want the Snowball or Snowballs associated with a specific job to be shipped to. 252 */ 253 Address?: Address; 254 } 255 export interface DescribeAddressesRequest { 256 /** 257 * The number of ADDRESS objects to return. 258 */ 259 MaxResults?: ListLimit; 260 /** 261 * HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses. 262 */ 263 NextToken?: String; 264 } 265 export interface DescribeAddressesResult { 266 /** 267 * The Snowball shipping addresses that were created for this account. 268 */ 269 Addresses?: AddressList; 270 /** 271 * HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array. 272 */ 273 NextToken?: String; 274 } 275 export interface DescribeJobRequest { 276 /** 277 * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 278 */ 279 JobId: JobId; 280 } 281 export interface DescribeJobResult { 282 /** 283 * Information about a specific job, including shipping information, job status, and other important metadata. 284 */ 285 JobMetadata?: JobMetadata; 286 /** 287 * Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata. 288 */ 289 SubJobMetadata?: JobMetadataList; 290 } 291 export interface GetJobManifestRequest { 292 /** 293 * The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000. 294 */ 295 JobId: JobId; 296 } 297 export interface GetJobManifestResult { 298 /** 299 * The Amazon S3 presigned URL for the manifest file associated with the specified JobId value. 300 */ 301 ManifestURI?: String; 302 } 303 export interface GetJobUnlockCodeRequest { 304 /** 305 * The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000. 306 */ 307 JobId: JobId; 308 } 309 export interface GetJobUnlockCodeResult { 310 /** 311 * The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 90 days after the job has been created. 312 */ 313 UnlockCode?: String; 314 } 315 export interface GetSnowballUsageRequest { 316 } 317 export interface GetSnowballUsageResult { 318 /** 319 * The service limit for number of Snowballs this account can have at once. The default service limit is 1 (one). 320 */ 321 SnowballLimit?: Integer; 322 /** 323 * The number of Snowballs that this account is currently using. 324 */ 325 SnowballsInUse?: Integer; 326 } 327 export type Integer = number; 328 export type JobId = string; 329 export interface JobListEntry { 330 /** 331 * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 332 */ 333 JobId?: String; 334 /** 335 * The current state of this job. 336 */ 337 JobState?: JobState; 338 /** 339 * A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular master job are listed, because they are created after the master job is created. 340 */ 341 IsMaster?: Boolean; 342 } 343 export type JobListEntryList = JobListEntry[]; 344 export interface JobLogs { 345 /** 346 * A link to an Amazon S3 presigned URL where the job completion report is located. 347 */ 348 JobCompletionReportURI?: String; 349 /** 350 * A link to an Amazon S3 presigned URL where the job success log is located. 351 */ 352 JobSuccessLogURI?: String; 353 /** 354 * A link to an Amazon S3 presigned URL where the job failure log is located. 355 */ 356 JobFailureLogURI?: String; 357 } 358 export interface JobMetadata { 359 /** 360 * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 361 */ 362 JobId?: String; 363 /** 364 * The current state of the jobs. 365 */ 366 JobState?: JobState; 367 /** 368 * The type of job. 369 */ 370 JobType?: JobType; 371 /** 372 * The creation date for this job. 373 */ 374 CreationDate?: Timestamp; 375 /** 376 * An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. 377 */ 378 Resources?: JobResource; 379 /** 380 * The description of the job, provided at job creation. 381 */ 382 Description?: String; 383 /** 384 * The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS. 385 */ 386 KmsKeyARN?: KmsKeyARN; 387 /** 388 * The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM). 389 */ 390 RoleARN?: RoleARN; 391 /** 392 * The ID for the address that you want the Snowball shipped to. 393 */ 394 AddressId?: AddressId; 395 /** 396 * A job's shipping information, including inbound and outbound tracking numbers and shipping speed options. 397 */ 398 ShippingDetails?: ShippingDetails; 399 /** 400 * The Snowball capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs. 401 */ 402 SnowballCapacityPreference?: SnowballCapacity; 403 /** 404 * The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type. 405 */ 406 Notification?: Notification; 407 /** 408 * A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. Note that this data is only available while a job has a JobState value of InProgress, for both import and export jobs. 409 */ 410 DataTransferProgress?: DataTransfer; 411 /** 412 * Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you. 413 */ 414 JobLogInfo?: JobLogs; 415 } 416 export type JobMetadataList = JobMetadata[]; 417 export interface JobResource { 418 /** 419 * An array of S3Resource objects. 420 */ 421 S3Resources?: S3ResourceList; 422 } 423 export type JobState = "New"|"PreparingAppliance"|"PreparingShipment"|"InTransitToCustomer"|"WithCustomer"|"InTransitToAWS"|"WithAWS"|"InProgress"|"Complete"|"Cancelled"|"Listing"|"Pending"|string; 424 export type JobStateList = JobState[]; 425 export type JobType = "IMPORT"|"EXPORT"|string; 426 export interface KeyRange { 427 /** 428 * The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted. 429 */ 430 BeginMarker?: String; 431 /** 432 * The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted. 433 */ 434 EndMarker?: String; 435 } 436 export type KmsKeyARN = string; 437 export interface ListJobsRequest { 438 /** 439 * The number of JobListEntry objects to return. 440 */ 441 MaxResults?: ListLimit; 442 /** 443 * HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list. 444 */ 445 NextToken?: String; 446 } 447 export interface ListJobsResult { 448 /** 449 * Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. 450 */ 451 JobListEntries?: JobListEntryList; 452 /** 453 * HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array. 454 */ 455 NextToken?: String; 456 } 457 export type ListLimit = number; 458 export type Long = number; 459 export interface Notification { 460 /** 461 * The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action. Note that you can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action. 462 */ 463 SnsTopicARN?: SnsTopicARN; 464 /** 465 * The list of job states that will trigger a notification for this job. 466 */ 467 JobStatesToNotify?: JobStateList; 468 /** 469 * Any change in job state will trigger a notification for this job. 470 */ 471 NotifyAll?: Boolean; 472 } 473 export type ResourceARN = string; 474 export type RoleARN = string; 475 export interface S3Resource { 476 /** 477 * The Amazon Resource Name (ARN) of an Amazon S3 bucket. 478 */ 479 BucketArn?: ResourceARN; 480 /** 481 * For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted. 482 */ 483 KeyRange?: KeyRange; 484 } 485 export type S3ResourceList = S3Resource[]; 486 export interface Shipment { 487 /** 488 * Status information for a shipment. Valid statuses include NEW, IN_TRANSIT, and DELIVERED. 489 */ 490 Status?: String; 491 /** 492 * The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snowball as the carrier transports it. For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier. 493 */ 494 TrackingNumber?: String; 495 } 496 export interface ShippingDetails { 497 /** 498 * The shipping speed for a particular job. Note that this speed does not dictate how soon you'll get the Snowball from the job's creation date. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, Snowballs are delivered in one to seven days. In the United States of America (US), you have access to one-day shipping and two-day shipping. 499 */ 500 ShippingOption?: ShippingOption; 501 /** 502 * The Status and TrackingNumber values for a Snowball being delivered to the address that you specified for a particular job. 503 */ 504 InboundShipment?: Shipment; 505 /** 506 * The Status and TrackingNumber values for a Snowball being returned to AWS for a particular job. 507 */ 508 OutboundShipment?: Shipment; 509 } 510 export type ShippingOption = "SECOND_DAY"|"NEXT_DAY"|"EXPRESS"|"STANDARD"|string; 511 export type SnowballCapacity = "T50"|"T80"|"NoPreference"|string; 512 export type SnsTopicARN = string; 513 export type String = string; 514 export type Timestamp = Date; 515 export interface UpdateJobRequest { 516 /** 517 * The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000. 518 */ 519 JobId: JobId; 520 /** 521 * The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRole AWS Identity and Access Management (IAM) API action. 522 */ 523 RoleARN?: RoleARN; 524 /** 525 * The new or updated Notification object. 526 */ 527 Notification?: Notification; 528 /** 529 * The updated S3Resource object (for a single Amazon S3 bucket or key range), or the updated JobResource object (for multiple buckets or key ranges). 530 */ 531 Resources?: JobResource; 532 /** 533 * The ID of the updated Address object. 534 */ 535 AddressId?: AddressId; 536 /** 537 * The updated shipping option value of this job's ShippingDetails object. 538 */ 539 ShippingOption?: ShippingOption; 540 /** 541 * The updated description of this job's JobMetadata object. 542 */ 543 Description?: String; 544 /** 545 * The updated SnowballCapacityPreference of this job's JobMetadata object. Note that the 50 TB Snowballs are only available in the US regions. 546 */ 547 SnowballCapacityPreference?: SnowballCapacity; 548 } 549 export interface UpdateJobResult { 550 } 551 /** 552 * 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. 553 */ 554 export type apiVersion = "2016-06-30"|"latest"|string; 555 export interface ClientApiVersions { 556 /** 557 * 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. 558 */ 559 apiVersion?: apiVersion; 560 } 561 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 562 } 563 export = Snowball;