/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / snowball.d.ts
snowball.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 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 a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it. 16 */ 17 cancelCluster(params: Snowball.Types.CancelClusterRequest, callback?: (err: AWSError, data: Snowball.Types.CancelClusterResult) => void): Request<Snowball.Types.CancelClusterResult, AWSError>; 18 /** 19 * Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it. 20 */ 21 cancelCluster(callback?: (err: AWSError, data: Snowball.Types.CancelClusterResult) => void): Request<Snowball.Types.CancelClusterResult, AWSError>; 22 /** 23 * Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned. 24 */ 25 cancelJob(params: Snowball.Types.CancelJobRequest, callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request<Snowball.Types.CancelJobResult, AWSError>; 26 /** 27 * Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned. 28 */ 29 cancelJob(callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request<Snowball.Types.CancelJobResult, AWSError>; 30 /** 31 * Creates an address for a Snow device to be shipped to. In most regions, 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. 32 */ 33 createAddress(params: Snowball.Types.CreateAddressRequest, callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request<Snowball.Types.CreateAddressResult, AWSError>; 34 /** 35 * Creates an address for a Snow device to be shipped to. In most regions, 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. 36 */ 37 createAddress(callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request<Snowball.Types.CreateAddressResult, AWSError>; 38 /** 39 * Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created. 40 */ 41 createCluster(params: Snowball.Types.CreateClusterRequest, callback?: (err: AWSError, data: Snowball.Types.CreateClusterResult) => void): Request<Snowball.Types.CreateClusterResult, AWSError>; 42 /** 43 * Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created. 44 */ 45 createCluster(callback?: (err: AWSError, data: Snowball.Types.CreateClusterResult) => void): Request<Snowball.Types.CreateClusterResult, AWSError>; 46 /** 47 * Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster. Only the Snowball; Edge device type is supported when ordering clustered jobs. The device capacity is optional. Availability of device types differ by AWS Region. For more information about Region availability, see AWS Regional Services. AWS Snow Family device types and their capacities. Snow Family device type: SNC1_SSD Capacity: T14 Description: Snowcone Snow Family device type: SNC1_HDD Capacity: T8 Description: Snowcone Device type: EDGE_S Capacity: T98 Description: Snowball Edge Storage Optimized for data transfer only Device type: EDGE_CG Capacity: T42 Description: Snowball Edge Compute Optimized with GPU Device type: EDGE_C Capacity: T42 Description: Snowball Edge Compute Optimized without GPU Device type: EDGE Capacity: T100 Description: Snowball Edge Storage Optimized with EC2 Compute Device type: STANDARD Capacity: T50 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore AWS Regions. Device type: STANDARD Capacity: T80 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore AWS Regions. 48 */ 49 createJob(params: Snowball.Types.CreateJobRequest, callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request<Snowball.Types.CreateJobResult, AWSError>; 50 /** 51 * Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster. Only the Snowball; Edge device type is supported when ordering clustered jobs. The device capacity is optional. Availability of device types differ by AWS Region. For more information about Region availability, see AWS Regional Services. AWS Snow Family device types and their capacities. Snow Family device type: SNC1_SSD Capacity: T14 Description: Snowcone Snow Family device type: SNC1_HDD Capacity: T8 Description: Snowcone Device type: EDGE_S Capacity: T98 Description: Snowball Edge Storage Optimized for data transfer only Device type: EDGE_CG Capacity: T42 Description: Snowball Edge Compute Optimized with GPU Device type: EDGE_C Capacity: T42 Description: Snowball Edge Compute Optimized without GPU Device type: EDGE Capacity: T100 Description: Snowball Edge Storage Optimized with EC2 Compute Device type: STANDARD Capacity: T50 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore AWS Regions. Device type: STANDARD Capacity: T80 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore AWS Regions. 52 */ 53 createJob(callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request<Snowball.Types.CreateJobResult, AWSError>; 54 /** 55 * Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and AWS provides discounts for long-term pricing. 56 */ 57 createLongTermPricing(params: Snowball.Types.CreateLongTermPricingRequest, callback?: (err: AWSError, data: Snowball.Types.CreateLongTermPricingResult) => void): Request<Snowball.Types.CreateLongTermPricingResult, AWSError>; 58 /** 59 * Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and AWS provides discounts for long-term pricing. 60 */ 61 createLongTermPricing(callback?: (err: AWSError, data: Snowball.Types.CreateLongTermPricingResult) => void): Request<Snowball.Types.CreateLongTermPricingResult, AWSError>; 62 /** 63 * Creates a shipping label that will be used to return the Snow device to AWS. 64 */ 65 createReturnShippingLabel(params: Snowball.Types.CreateReturnShippingLabelRequest, callback?: (err: AWSError, data: Snowball.Types.CreateReturnShippingLabelResult) => void): Request<Snowball.Types.CreateReturnShippingLabelResult, AWSError>; 66 /** 67 * Creates a shipping label that will be used to return the Snow device to AWS. 68 */ 69 createReturnShippingLabel(callback?: (err: AWSError, data: Snowball.Types.CreateReturnShippingLabelResult) => void): Request<Snowball.Types.CreateReturnShippingLabelResult, AWSError>; 70 /** 71 * Takes an AddressId and returns specific details about that address in the form of an Address object. 72 */ 73 describeAddress(params: Snowball.Types.DescribeAddressRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request<Snowball.Types.DescribeAddressResult, AWSError>; 74 /** 75 * Takes an AddressId and returns specific details about that address in the form of an Address object. 76 */ 77 describeAddress(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request<Snowball.Types.DescribeAddressResult, AWSError>; 78 /** 79 * 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. 80 */ 81 describeAddresses(params: Snowball.Types.DescribeAddressesRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request<Snowball.Types.DescribeAddressesResult, AWSError>; 82 /** 83 * 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. 84 */ 85 describeAddresses(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request<Snowball.Types.DescribeAddressesResult, AWSError>; 86 /** 87 * Returns information about a specific cluster including shipping information, cluster status, and other important metadata. 88 */ 89 describeCluster(params: Snowball.Types.DescribeClusterRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeClusterResult) => void): Request<Snowball.Types.DescribeClusterResult, AWSError>; 90 /** 91 * Returns information about a specific cluster including shipping information, cluster status, and other important metadata. 92 */ 93 describeCluster(callback?: (err: AWSError, data: Snowball.Types.DescribeClusterResult) => void): Request<Snowball.Types.DescribeClusterResult, AWSError>; 94 /** 95 * Returns information about a specific job including shipping information, job status, and other important metadata. 96 */ 97 describeJob(params: Snowball.Types.DescribeJobRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request<Snowball.Types.DescribeJobResult, AWSError>; 98 /** 99 * Returns information about a specific job including shipping information, job status, and other important metadata. 100 */ 101 describeJob(callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request<Snowball.Types.DescribeJobResult, AWSError>; 102 /** 103 * Information on the shipping label of a Snow device that is being returned to AWS. 104 */ 105 describeReturnShippingLabel(params: Snowball.Types.DescribeReturnShippingLabelRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeReturnShippingLabelResult) => void): Request<Snowball.Types.DescribeReturnShippingLabelResult, AWSError>; 106 /** 107 * Information on the shipping label of a Snow device that is being returned to AWS. 108 */ 109 describeReturnShippingLabel(callback?: (err: AWSError, data: Snowball.Types.DescribeReturnShippingLabelResult) => void): Request<Snowball.Types.DescribeReturnShippingLabelResult, AWSError>; 110 /** 111 * 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 Snow device 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 Snow device associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created. 112 */ 113 getJobManifest(params: Snowball.Types.GetJobManifestRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request<Snowball.Types.GetJobManifestResult, AWSError>; 114 /** 115 * 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 Snow device 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 Snow device associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created. 116 */ 117 getJobManifest(callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request<Snowball.Types.GetJobManifestResult, AWSError>; 118 /** 119 * Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 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 Snow device 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 Snow device associated with that job. 120 */ 121 getJobUnlockCode(params: Snowball.Types.GetJobUnlockCodeRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request<Snowball.Types.GetJobUnlockCodeResult, AWSError>; 122 /** 123 * Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 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 Snow device 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 Snow device associated with that job. 124 */ 125 getJobUnlockCode(callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request<Snowball.Types.GetJobUnlockCodeResult, AWSError>; 126 /** 127 * Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use. The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact AWS Support. 128 */ 129 getSnowballUsage(params: Snowball.Types.GetSnowballUsageRequest, callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request<Snowball.Types.GetSnowballUsageResult, AWSError>; 130 /** 131 * Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use. The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact AWS Support. 132 */ 133 getSnowballUsage(callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request<Snowball.Types.GetSnowballUsageResult, AWSError>; 134 /** 135 * Returns an Amazon S3 presigned URL for an update file associated with a specified JobId. 136 */ 137 getSoftwareUpdates(params: Snowball.Types.GetSoftwareUpdatesRequest, callback?: (err: AWSError, data: Snowball.Types.GetSoftwareUpdatesResult) => void): Request<Snowball.Types.GetSoftwareUpdatesResult, AWSError>; 138 /** 139 * Returns an Amazon S3 presigned URL for an update file associated with a specified JobId. 140 */ 141 getSoftwareUpdates(callback?: (err: AWSError, data: Snowball.Types.GetSoftwareUpdatesResult) => void): Request<Snowball.Types.GetSoftwareUpdatesResult, AWSError>; 142 /** 143 * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information. 144 */ 145 listClusterJobs(params: Snowball.Types.ListClusterJobsRequest, callback?: (err: AWSError, data: Snowball.Types.ListClusterJobsResult) => void): Request<Snowball.Types.ListClusterJobsResult, AWSError>; 146 /** 147 * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information. 148 */ 149 listClusterJobs(callback?: (err: AWSError, data: Snowball.Types.ListClusterJobsResult) => void): Request<Snowball.Types.ListClusterJobsResult, AWSError>; 150 /** 151 * Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. 152 */ 153 listClusters(params: Snowball.Types.ListClustersRequest, callback?: (err: AWSError, data: Snowball.Types.ListClustersResult) => void): Request<Snowball.Types.ListClustersResult, AWSError>; 154 /** 155 * Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. 156 */ 157 listClusters(callback?: (err: AWSError, data: Snowball.Types.ListClustersResult) => void): Request<Snowball.Types.ListClustersResult, AWSError>; 158 /** 159 * This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snow device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace. 160 */ 161 listCompatibleImages(params: Snowball.Types.ListCompatibleImagesRequest, callback?: (err: AWSError, data: Snowball.Types.ListCompatibleImagesResult) => void): Request<Snowball.Types.ListCompatibleImagesResult, AWSError>; 162 /** 163 * This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snow device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace. 164 */ 165 listCompatibleImages(callback?: (err: AWSError, data: Snowball.Types.ListCompatibleImagesResult) => void): Request<Snowball.Types.ListCompatibleImagesResult, AWSError>; 166 /** 167 * 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. 168 */ 169 listJobs(params: Snowball.Types.ListJobsRequest, callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request<Snowball.Types.ListJobsResult, AWSError>; 170 /** 171 * 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. 172 */ 173 listJobs(callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request<Snowball.Types.ListJobsResult, AWSError>; 174 /** 175 * Lists all long-term pricing types. 176 */ 177 listLongTermPricing(params: Snowball.Types.ListLongTermPricingRequest, callback?: (err: AWSError, data: Snowball.Types.ListLongTermPricingResult) => void): Request<Snowball.Types.ListLongTermPricingResult, AWSError>; 178 /** 179 * Lists all long-term pricing types. 180 */ 181 listLongTermPricing(callback?: (err: AWSError, data: Snowball.Types.ListLongTermPricingResult) => void): Request<Snowball.Types.ListLongTermPricingResult, AWSError>; 182 /** 183 * While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available. 184 */ 185 updateCluster(params: Snowball.Types.UpdateClusterRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateClusterResult) => void): Request<Snowball.Types.UpdateClusterResult, AWSError>; 186 /** 187 * While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available. 188 */ 189 updateCluster(callback?: (err: AWSError, data: Snowball.Types.UpdateClusterResult) => void): Request<Snowball.Types.UpdateClusterResult, AWSError>; 190 /** 191 * 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. 192 */ 193 updateJob(params: Snowball.Types.UpdateJobRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request<Snowball.Types.UpdateJobResult, AWSError>; 194 /** 195 * 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. 196 */ 197 updateJob(callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request<Snowball.Types.UpdateJobResult, AWSError>; 198 /** 199 * Updates the state when a shipment state changes to a different state. 200 */ 201 updateJobShipmentState(params: Snowball.Types.UpdateJobShipmentStateRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateJobShipmentStateResult) => void): Request<Snowball.Types.UpdateJobShipmentStateResult, AWSError>; 202 /** 203 * Updates the state when a shipment state changes to a different state. 204 */ 205 updateJobShipmentState(callback?: (err: AWSError, data: Snowball.Types.UpdateJobShipmentStateResult) => void): Request<Snowball.Types.UpdateJobShipmentStateResult, AWSError>; 206 /** 207 * Updates the long-term pricing type. 208 */ 209 updateLongTermPricing(params: Snowball.Types.UpdateLongTermPricingRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateLongTermPricingResult) => void): Request<Snowball.Types.UpdateLongTermPricingResult, AWSError>; 210 /** 211 * Updates the long-term pricing type. 212 */ 213 updateLongTermPricing(callback?: (err: AWSError, data: Snowball.Types.UpdateLongTermPricingResult) => void): Request<Snowball.Types.UpdateLongTermPricingResult, AWSError>; 214 } 215 declare namespace Snowball { 216 export interface Address { 217 /** 218 * The unique ID for an address. 219 */ 220 AddressId?: AddressId; 221 /** 222 * The name of a person to receive a Snow device at an address. 223 */ 224 Name?: String; 225 /** 226 * The name of the company to receive a Snow device at an address. 227 */ 228 Company?: String; 229 /** 230 * The first line in a street address that a Snow device is to be delivered to. 231 */ 232 Street1?: String; 233 /** 234 * The second line in a street address that a Snow device is to be delivered to. 235 */ 236 Street2?: String; 237 /** 238 * The third line in a street address that a Snow device is to be delivered to. 239 */ 240 Street3?: String; 241 /** 242 * The city in an address that a Snow device is to be delivered to. 243 */ 244 City?: String; 245 /** 246 * The state or province in an address that a Snow device is to be delivered to. 247 */ 248 StateOrProvince?: String; 249 /** 250 * This field is no longer used and the value is ignored. 251 */ 252 PrefectureOrDistrict?: String; 253 /** 254 * This field is no longer used and the value is ignored. 255 */ 256 Landmark?: String; 257 /** 258 * The country in an address that a Snow device is to be delivered to. 259 */ 260 Country?: String; 261 /** 262 * The postal code in an address that a Snow device is to be delivered to. 263 */ 264 PostalCode?: String; 265 /** 266 * The phone number associated with an address that a Snow device is to be delivered to. 267 */ 268 PhoneNumber?: String; 269 /** 270 * If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions. 271 */ 272 IsRestricted?: Boolean; 273 } 274 export type AddressId = string; 275 export type AddressList = Address[]; 276 export type AmiId = string; 277 export type Boolean = boolean; 278 export interface CancelClusterRequest { 279 /** 280 * The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000. 281 */ 282 ClusterId: ClusterId; 283 } 284 export interface CancelClusterResult { 285 } 286 export interface CancelJobRequest { 287 /** 288 * The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000. 289 */ 290 JobId: JobId; 291 } 292 export interface CancelJobResult { 293 } 294 export type ClusterId = string; 295 export interface ClusterListEntry { 296 /** 297 * The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000. 298 */ 299 ClusterId?: String; 300 /** 301 * The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState. 302 */ 303 ClusterState?: ClusterState; 304 /** 305 * The creation date for this cluster. 306 */ 307 CreationDate?: Timestamp; 308 /** 309 * Defines an optional description of the cluster, for example Environmental Data Cluster-01. 310 */ 311 Description?: String; 312 } 313 export type ClusterListEntryList = ClusterListEntry[]; 314 export interface ClusterMetadata { 315 /** 316 * The automatically generated ID for a cluster. 317 */ 318 ClusterId?: String; 319 /** 320 * The optional description of the cluster. 321 */ 322 Description?: String; 323 /** 324 * The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS). 325 */ 326 KmsKeyARN?: KmsKeyARN; 327 /** 328 * The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM). 329 */ 330 RoleARN?: RoleARN; 331 /** 332 * The current status of the cluster. 333 */ 334 ClusterState?: ClusterState; 335 /** 336 * The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE. 337 */ 338 JobType?: JobType; 339 /** 340 * The type of AWS Snow device to use for this cluster. For cluster jobs, AWS Snow Family currently supports only the EDGE device type. 341 */ 342 SnowballType?: SnowballType; 343 /** 344 * The creation date for this cluster. 345 */ 346 CreationDate?: Timestamp; 347 /** 348 * The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects. 349 */ 350 Resources?: JobResource; 351 /** 352 * The automatically generated ID for a specific address. 353 */ 354 AddressId?: AddressId; 355 /** 356 * The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping. 357 */ 358 ShippingOption?: ShippingOption; 359 /** 360 * The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster. 361 */ 362 Notification?: Notification; 363 /** 364 * The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions. 365 */ 366 ForwardingAddressId?: AddressId; 367 /** 368 * The tax documents required in your AWS Region. 369 */ 370 TaxDocuments?: TaxDocuments; 371 /** 372 * Represents metadata and configuration settings for services on an AWS Snow Family device. 373 */ 374 OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration; 375 } 376 export type ClusterState = "AwaitingQuorum"|"Pending"|"InUse"|"Complete"|"Cancelled"|string; 377 export interface CompatibleImage { 378 /** 379 * The unique identifier for an individual Snow device AMI. 380 */ 381 AmiId?: String; 382 /** 383 * The optional name of a compatible image. 384 */ 385 Name?: String; 386 } 387 export type CompatibleImageList = CompatibleImage[]; 388 export interface CreateAddressRequest { 389 /** 390 * The address that you want the Snow device shipped to. 391 */ 392 Address: Address; 393 } 394 export interface CreateAddressResult { 395 /** 396 * 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 Snow device for that job shipped to. 397 */ 398 AddressId?: String; 399 } 400 export interface CreateClusterRequest { 401 /** 402 * The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE. For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide. 403 */ 404 JobType: JobType; 405 /** 406 * The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language. 407 */ 408 Resources: JobResource; 409 /** 410 * Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System). 411 */ 412 OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration; 413 /** 414 * An optional description of this specific cluster, for example Environmental Data Cluster-01. 415 */ 416 Description?: String; 417 /** 418 * The ID for the address that you want the cluster shipped to. 419 */ 420 AddressId: AddressId; 421 /** 422 * The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS). 423 */ 424 KmsKeyARN?: KmsKeyARN; 425 /** 426 * The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM). 427 */ 428 RoleARN: RoleARN; 429 /** 430 * The type of AWS Snow Family device to use for this cluster. For cluster jobs, AWS Snow Family currently supports only the EDGE device type. For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide. 431 */ 432 SnowballType: SnowballType; 433 /** 434 * The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices 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. In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping. 435 */ 436 ShippingOption: ShippingOption; 437 /** 438 * The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster. 439 */ 440 Notification?: Notification; 441 /** 442 * The forwarding address ID for a cluster. This field is not supported in most regions. 443 */ 444 ForwardingAddressId?: AddressId; 445 /** 446 * The tax documents required in your AWS Region. 447 */ 448 TaxDocuments?: TaxDocuments; 449 /** 450 * Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device. 451 */ 452 RemoteManagement?: RemoteManagement; 453 } 454 export interface CreateClusterResult { 455 /** 456 * The automatically generated ID for a cluster. 457 */ 458 ClusterId?: ClusterId; 459 } 460 export interface CreateJobRequest { 461 /** 462 * Defines the type of job that you're creating. 463 */ 464 JobType?: JobType; 465 /** 466 * 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. 467 */ 468 Resources?: JobResource; 469 /** 470 * Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System). 471 */ 472 OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration; 473 /** 474 * Defines an optional description of this specific job, for example Important Photos 2016-08-11. 475 */ 476 Description?: String; 477 /** 478 * The ID for the address that you want the Snow device shipped to. 479 */ 480 AddressId?: AddressId; 481 /** 482 * The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action. 483 */ 484 KmsKeyARN?: KmsKeyARN; 485 /** 486 * The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action. 487 */ 488 RoleARN?: RoleARN; 489 /** 490 * If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity. For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide. 491 */ 492 SnowballCapacityPreference?: SnowballCapacity; 493 /** 494 * The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping. 495 */ 496 ShippingOption?: ShippingOption; 497 /** 498 * Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job. 499 */ 500 Notification?: Notification; 501 /** 502 * The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster. 503 */ 504 ClusterId?: ClusterId; 505 /** 506 * The type of AWS Snow Family device to use for this job. For cluster jobs, AWS Snow Family currently supports only the EDGE device type. The type of AWS Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE. For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide. For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide. 507 */ 508 SnowballType?: SnowballType; 509 /** 510 * The forwarding address ID for a job. This field is not supported in most Regions. 511 */ 512 ForwardingAddressId?: AddressId; 513 /** 514 * The tax documents required in your AWS Region. 515 */ 516 TaxDocuments?: TaxDocuments; 517 /** 518 * Defines the device configuration for an AWS Snowcone job. For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide. 519 */ 520 DeviceConfiguration?: DeviceConfiguration; 521 /** 522 * Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device. 523 */ 524 RemoteManagement?: RemoteManagement; 525 /** 526 * The ID of the long-term pricing type for the device. 527 */ 528 LongTermPricingId?: LongTermPricingId; 529 } 530 export interface CreateJobResult { 531 /** 532 * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 533 */ 534 JobId?: JobId; 535 } 536 export interface CreateLongTermPricingRequest { 537 /** 538 * The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing. 539 */ 540 LongTermPricingType: LongTermPricingType; 541 /** 542 * Specifies whether the current long-term pricing type for the device should be renewed. 543 */ 544 IsLongTermPricingAutoRenew?: JavaBoolean; 545 /** 546 * The type of AWS Snow Family device to use for the long-term pricing job. 547 */ 548 SnowballType?: SnowballType; 549 } 550 export interface CreateLongTermPricingResult { 551 /** 552 * The ID of the long-term pricing type for the device. 553 */ 554 LongTermPricingId?: LongTermPricingId; 555 } 556 export interface CreateReturnShippingLabelRequest { 557 /** 558 * The ID for a job that you want to create the return shipping label for; for example, JID123e4567-e89b-12d3-a456-426655440000. 559 */ 560 JobId: JobId; 561 /** 562 * The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to AWS. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows: 563 */ 564 ShippingOption?: ShippingOption; 565 } 566 export interface CreateReturnShippingLabelResult { 567 /** 568 * The status information of the task on a Snow device that is being returned to AWS. 569 */ 570 Status?: ShippingLabelStatus; 571 } 572 export interface DataTransfer { 573 /** 574 * The number of bytes transferred between a Snow device and Amazon S3. 575 */ 576 BytesTransferred?: Long; 577 /** 578 * The number of objects transferred between a Snow device and Amazon S3. 579 */ 580 ObjectsTransferred?: Long; 581 /** 582 * The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed. 583 */ 584 TotalBytes?: Long; 585 /** 586 * The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed. 587 */ 588 TotalObjects?: Long; 589 } 590 export interface DescribeAddressRequest { 591 /** 592 * The automatically generated ID for a specific address. 593 */ 594 AddressId: AddressId; 595 } 596 export interface DescribeAddressResult { 597 /** 598 * The address that you want the Snow device(s) associated with a specific job to be shipped to. 599 */ 600 Address?: Address; 601 } 602 export interface DescribeAddressesRequest { 603 /** 604 * The number of ADDRESS objects to return. 605 */ 606 MaxResults?: ListLimit; 607 /** 608 * 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. 609 */ 610 NextToken?: String; 611 } 612 export interface DescribeAddressesResult { 613 /** 614 * The Snow device shipping addresses that were created for this account. 615 */ 616 Addresses?: AddressList; 617 /** 618 * 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. 619 */ 620 NextToken?: String; 621 } 622 export interface DescribeClusterRequest { 623 /** 624 * The automatically generated ID for a cluster. 625 */ 626 ClusterId: ClusterId; 627 } 628 export interface DescribeClusterResult { 629 /** 630 * Information about a specific cluster, including shipping information, cluster status, and other important metadata. 631 */ 632 ClusterMetadata?: ClusterMetadata; 633 } 634 export interface DescribeJobRequest { 635 /** 636 * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 637 */ 638 JobId: JobId; 639 } 640 export interface DescribeJobResult { 641 /** 642 * Information about a specific job, including shipping information, job status, and other important metadata. 643 */ 644 JobMetadata?: JobMetadata; 645 /** 646 * Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata. 647 */ 648 SubJobMetadata?: JobMetadataList; 649 } 650 export interface DescribeReturnShippingLabelRequest { 651 /** 652 * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 653 */ 654 JobId: JobId; 655 } 656 export interface DescribeReturnShippingLabelResult { 657 /** 658 * The status information of the task on a Snow device that is being returned to AWS. 659 */ 660 Status?: ShippingLabelStatus; 661 /** 662 * The expiration date of the current return shipping label. 663 */ 664 ExpirationDate?: Timestamp; 665 } 666 export interface DeviceConfiguration { 667 /** 668 * Returns information about the device configuration for an AWS Snowcone job. 669 */ 670 SnowconeDeviceConfiguration?: SnowconeDeviceConfiguration; 671 } 672 export type DeviceServiceName = "NFS_ON_DEVICE_SERVICE"|"S3_ON_DEVICE_SERVICE"|string; 673 export interface Ec2AmiResource { 674 /** 675 * The ID of the AMI in Amazon EC2. 676 */ 677 AmiId: AmiId; 678 /** 679 * The ID of the AMI on the Snow device. 680 */ 681 SnowballAmiId?: String; 682 } 683 export type Ec2AmiResourceList = Ec2AmiResource[]; 684 export interface EventTriggerDefinition { 685 /** 686 * The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda function's event trigger associated with this job. 687 */ 688 EventResourceARN?: ResourceARN; 689 } 690 export type EventTriggerDefinitionList = EventTriggerDefinition[]; 691 export type GSTIN = string; 692 export interface GetJobManifestRequest { 693 /** 694 * The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000. 695 */ 696 JobId: JobId; 697 } 698 export interface GetJobManifestResult { 699 /** 700 * The Amazon S3 presigned URL for the manifest file associated with the specified JobId value. 701 */ 702 ManifestURI?: String; 703 } 704 export interface GetJobUnlockCodeRequest { 705 /** 706 * The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000. 707 */ 708 JobId: JobId; 709 } 710 export interface GetJobUnlockCodeResult { 711 /** 712 * The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 360 days after the job has been created. 713 */ 714 UnlockCode?: String; 715 } 716 export interface GetSnowballUsageRequest { 717 } 718 export interface GetSnowballUsageResult { 719 /** 720 * The service limit for number of Snow devices this account can have at once. The default service limit is 1 (one). 721 */ 722 SnowballLimit?: Integer; 723 /** 724 * The number of Snow devices that this account is currently using. 725 */ 726 SnowballsInUse?: Integer; 727 } 728 export interface GetSoftwareUpdatesRequest { 729 /** 730 * The ID for a job that you want to get the software update file for, for example JID123e4567-e89b-12d3-a456-426655440000. 731 */ 732 JobId: JobId; 733 } 734 export interface GetSoftwareUpdatesResult { 735 /** 736 * The Amazon S3 presigned URL for the update file associated with the specified JobId value. The software update will be available for 2 days after this request is made. To access an update after the 2 days have passed, you'll have to make another call to GetSoftwareUpdates. 737 */ 738 UpdatesURI?: String; 739 } 740 export interface INDTaxDocuments { 741 /** 742 * The Goods and Services Tax (GST) documents required in AWS Regions in India. 743 */ 744 GSTIN?: GSTIN; 745 } 746 export type Integer = number; 747 export type JavaBoolean = boolean; 748 export type JobId = string; 749 export interface JobListEntry { 750 /** 751 * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 752 */ 753 JobId?: String; 754 /** 755 * The current state of this job. 756 */ 757 JobState?: JobState; 758 /** 759 * A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main 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 main job are listed, because they are created after the main job is created. 760 */ 761 IsMaster?: Boolean; 762 /** 763 * The type of job. 764 */ 765 JobType?: JobType; 766 /** 767 * The type of device used with this job. 768 */ 769 SnowballType?: SnowballType; 770 /** 771 * The creation date for this job. 772 */ 773 CreationDate?: Timestamp; 774 /** 775 * The optional description of this specific job, for example Important Photos 2016-08-11. 776 */ 777 Description?: String; 778 } 779 export type JobListEntryList = JobListEntry[]; 780 export interface JobLogs { 781 /** 782 * A link to an Amazon S3 presigned URL where the job completion report is located. 783 */ 784 JobCompletionReportURI?: String; 785 /** 786 * A link to an Amazon S3 presigned URL where the job success log is located. 787 */ 788 JobSuccessLogURI?: String; 789 /** 790 * A link to an Amazon S3 presigned URL where the job failure log is located. 791 */ 792 JobFailureLogURI?: String; 793 } 794 export interface JobMetadata { 795 /** 796 * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 797 */ 798 JobId?: String; 799 /** 800 * The current status of the jobs. 801 */ 802 JobState?: JobState; 803 /** 804 * The type of job. 805 */ 806 JobType?: JobType; 807 /** 808 * The type of device used with this job. 809 */ 810 SnowballType?: SnowballType; 811 /** 812 * The creation date for this job. 813 */ 814 CreationDate?: Timestamp; 815 /** 816 * An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. 817 */ 818 Resources?: JobResource; 819 /** 820 * The description of the job, provided at job creation. 821 */ 822 Description?: String; 823 /** 824 * 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. 825 */ 826 KmsKeyARN?: KmsKeyARN; 827 /** 828 * The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM). 829 */ 830 RoleARN?: RoleARN; 831 /** 832 * The ID for the address that you want the Snow device shipped to. 833 */ 834 AddressId?: AddressId; 835 /** 836 * A job's shipping information, including inbound and outbound tracking numbers and shipping speed options. 837 */ 838 ShippingDetails?: ShippingDetails; 839 /** 840 * The Snow device 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. For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide. 841 */ 842 SnowballCapacityPreference?: SnowballCapacity; 843 /** 844 * 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. 845 */ 846 Notification?: Notification; 847 /** 848 * A value that defines the real-time status of a Snow device's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs. 849 */ 850 DataTransferProgress?: DataTransfer; 851 /** 852 * 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 Snow device for your job part is being delivered to you. 853 */ 854 JobLogInfo?: JobLogs; 855 /** 856 * The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000. 857 */ 858 ClusterId?: String; 859 /** 860 * The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions. 861 */ 862 ForwardingAddressId?: AddressId; 863 /** 864 * The metadata associated with the tax documents required in your AWS Region. 865 */ 866 TaxDocuments?: TaxDocuments; 867 DeviceConfiguration?: DeviceConfiguration; 868 /** 869 * Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device. 870 */ 871 RemoteManagement?: RemoteManagement; 872 /** 873 * The ID of the long-term pricing type for the device. 874 */ 875 LongTermPricingId?: LongTermPricingId; 876 /** 877 * Represents metadata and configuration settings for services on an AWS Snow Family device. 878 */ 879 OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration; 880 } 881 export type JobMetadataList = JobMetadata[]; 882 export interface JobResource { 883 /** 884 * An array of S3Resource objects. 885 */ 886 S3Resources?: S3ResourceList; 887 /** 888 * The Python-language Lambda functions for this job. 889 */ 890 LambdaResources?: LambdaResourceList; 891 /** 892 * The Amazon Machine Images (AMIs) associated with this job. 893 */ 894 Ec2AmiResources?: Ec2AmiResourceList; 895 } 896 export type JobState = "New"|"PreparingAppliance"|"PreparingShipment"|"InTransitToCustomer"|"WithCustomer"|"InTransitToAWS"|"WithAWSSortingFacility"|"WithAWS"|"InProgress"|"Complete"|"Cancelled"|"Listing"|"Pending"|string; 897 export type JobStateList = JobState[]; 898 export type JobType = "IMPORT"|"EXPORT"|"LOCAL_USE"|string; 899 export interface KeyRange { 900 /** 901 * The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted. 902 */ 903 BeginMarker?: String; 904 /** 905 * The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted. 906 */ 907 EndMarker?: String; 908 } 909 export type KmsKeyARN = string; 910 export interface LambdaResource { 911 /** 912 * An Amazon Resource Name (ARN) that represents an AWS Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource. 913 */ 914 LambdaArn?: ResourceARN; 915 /** 916 * The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job. 917 */ 918 EventTriggers?: EventTriggerDefinitionList; 919 } 920 export type LambdaResourceList = LambdaResource[]; 921 export interface ListClusterJobsRequest { 922 /** 923 * The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000. 924 */ 925 ClusterId: ClusterId; 926 /** 927 * The number of JobListEntry objects to return. 928 */ 929 MaxResults?: ListLimit; 930 /** 931 * 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. 932 */ 933 NextToken?: String; 934 } 935 export interface ListClusterJobsResult { 936 /** 937 * 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. 938 */ 939 JobListEntries?: JobListEntryList; 940 /** 941 * HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array. 942 */ 943 NextToken?: String; 944 } 945 export interface ListClustersRequest { 946 /** 947 * The number of ClusterListEntry objects to return. 948 */ 949 MaxResults?: ListLimit; 950 /** 951 * HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list. 952 */ 953 NextToken?: String; 954 } 955 export interface ListClustersResult { 956 /** 957 * Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. 958 */ 959 ClusterListEntries?: ClusterListEntryList; 960 /** 961 * HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array. 962 */ 963 NextToken?: String; 964 } 965 export interface ListCompatibleImagesRequest { 966 /** 967 * The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs. 968 */ 969 MaxResults?: ListLimit; 970 /** 971 * HTTP requests are stateless. To identify what object comes "next" in the list of compatible images, you can specify a value for NextToken as the starting point for your list of returned images. 972 */ 973 NextToken?: String; 974 } 975 export interface ListCompatibleImagesResult { 976 /** 977 * A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI. 978 */ 979 CompatibleImages?: CompatibleImageList; 980 /** 981 * Because HTTP requests are stateless, this is the starting point for your next list of returned images. 982 */ 983 NextToken?: String; 984 } 985 export interface ListJobsRequest { 986 /** 987 * The number of JobListEntry objects to return. 988 */ 989 MaxResults?: ListLimit; 990 /** 991 * 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. 992 */ 993 NextToken?: String; 994 } 995 export interface ListJobsResult { 996 /** 997 * 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. 998 */ 999 JobListEntries?: JobListEntryList; 1000 /** 1001 * 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. 1002 */ 1003 NextToken?: String; 1004 } 1005 export type ListLimit = number; 1006 export interface ListLongTermPricingRequest { 1007 /** 1008 * The maximum number of ListLongTermPricing objects to return. 1009 */ 1010 MaxResults?: ListLimit; 1011 /** 1012 * Because HTTP requests are stateless, this is the starting point for your next list of ListLongTermPricing to return. 1013 */ 1014 NextToken?: String; 1015 } 1016 export interface ListLongTermPricingResult { 1017 /** 1018 * Each LongTermPricingEntry object contains a status, ID, and other information about the LongTermPricing type. 1019 */ 1020 LongTermPricingEntries?: LongTermPricingEntryList; 1021 /** 1022 * Because HTTP requests are stateless, this is the starting point for your next list of returned ListLongTermPricing list. 1023 */ 1024 NextToken?: String; 1025 } 1026 export type Long = number; 1027 export type LongTermPricingAssociatedJobIdList = JobId[]; 1028 export type LongTermPricingEntryList = LongTermPricingListEntry[]; 1029 export type LongTermPricingId = string; 1030 export interface LongTermPricingListEntry { 1031 /** 1032 * The ID of the long-term pricing type for the device. 1033 */ 1034 LongTermPricingId?: LongTermPricingId; 1035 /** 1036 * The end date the long-term pricing contract. 1037 */ 1038 LongTermPricingEndDate?: Timestamp; 1039 /** 1040 * The start date of the long-term pricing contract. 1041 */ 1042 LongTermPricingStartDate?: Timestamp; 1043 /** 1044 * The type of long-term pricing that was selected for the device. 1045 */ 1046 LongTermPricingType?: LongTermPricingType; 1047 /** 1048 * The current active jobs on the device the long-term pricing type. 1049 */ 1050 CurrentActiveJob?: JobId; 1051 /** 1052 * A new device that replaces a device that is ordered with long-term pricing. 1053 */ 1054 ReplacementJob?: JobId; 1055 /** 1056 * If set to true, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires. 1057 */ 1058 IsLongTermPricingAutoRenew?: JavaBoolean; 1059 /** 1060 * The status of the long-term pricing type. 1061 */ 1062 LongTermPricingStatus?: String; 1063 /** 1064 * The type of AWS Snow Family device associated with this long-term pricing job. 1065 */ 1066 SnowballType?: SnowballType; 1067 /** 1068 * The IDs of the jobs that are associated with a long-term pricing type. 1069 */ 1070 JobIds?: LongTermPricingAssociatedJobIdList; 1071 } 1072 export type LongTermPricingType = "OneYear"|"ThreeYear"|string; 1073 export interface NFSOnDeviceServiceConfiguration { 1074 /** 1075 * The maximum NFS storage for one Snowball Family device. 1076 */ 1077 StorageLimit?: StorageLimit; 1078 /** 1079 * The scale unit of the NFS storage on the device. Valid values: TB. 1080 */ 1081 StorageUnit?: StorageUnit; 1082 } 1083 export interface Notification { 1084 /** 1085 * 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. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action. 1086 */ 1087 SnsTopicARN?: SnsTopicARN; 1088 /** 1089 * The list of job states that will trigger a notification for this job. 1090 */ 1091 JobStatesToNotify?: JobStateList; 1092 /** 1093 * Any change in job state will trigger a notification for this job. 1094 */ 1095 NotifyAll?: Boolean; 1096 } 1097 export interface OnDeviceServiceConfiguration { 1098 /** 1099 * Represents the NFS service on a Snow Family device. 1100 */ 1101 NFSOnDeviceService?: NFSOnDeviceServiceConfiguration; 1102 } 1103 export type RemoteManagement = "INSTALLED_ONLY"|"INSTALLED_AUTOSTART"|string; 1104 export type ResourceARN = string; 1105 export type RoleARN = string; 1106 export interface S3Resource { 1107 /** 1108 * The Amazon Resource Name (ARN) of an Amazon S3 bucket. 1109 */ 1110 BucketArn?: ResourceARN; 1111 /** 1112 * 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. 1113 */ 1114 KeyRange?: KeyRange; 1115 /** 1116 * Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System). 1117 */ 1118 TargetOnDeviceServices?: TargetOnDeviceServiceList; 1119 } 1120 export type S3ResourceList = S3Resource[]; 1121 export interface Shipment { 1122 /** 1123 * Status information for a shipment. 1124 */ 1125 Status?: String; 1126 /** 1127 * The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it. For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier. 1128 */ 1129 TrackingNumber?: String; 1130 } 1131 export type ShipmentState = "RECEIVED"|"RETURNED"|string; 1132 export interface ShippingDetails { 1133 /** 1134 * The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snow device 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, Snow devices shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices 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. 1135 */ 1136 ShippingOption?: ShippingOption; 1137 /** 1138 * The Status and TrackingNumber values for a Snow device being returned to AWS for a particular job. 1139 */ 1140 InboundShipment?: Shipment; 1141 /** 1142 * The Status and TrackingNumber values for a Snow device being delivered to the address that you specified for a particular job. 1143 */ 1144 OutboundShipment?: Shipment; 1145 } 1146 export type ShippingLabelStatus = "InProgress"|"TimedOut"|"Succeeded"|"Failed"|string; 1147 export type ShippingOption = "SECOND_DAY"|"NEXT_DAY"|"EXPRESS"|"STANDARD"|string; 1148 export type SnowballCapacity = "T50"|"T80"|"T100"|"T42"|"T98"|"T8"|"T14"|"NoPreference"|string; 1149 export type SnowballType = "STANDARD"|"EDGE"|"EDGE_C"|"EDGE_CG"|"EDGE_S"|"SNC1_HDD"|"SNC1_SSD"|string; 1150 export interface SnowconeDeviceConfiguration { 1151 /** 1152 * Configures the wireless connection for the AWS Snowcone device. 1153 */ 1154 WirelessConnection?: WirelessConnection; 1155 } 1156 export type SnsTopicARN = string; 1157 export type StorageLimit = number; 1158 export type StorageUnit = "TB"|string; 1159 export type String = string; 1160 export interface TargetOnDeviceService { 1161 /** 1162 * Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into. 1163 */ 1164 ServiceName?: DeviceServiceName; 1165 /** 1166 * Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device. 1167 */ 1168 TransferOption?: TransferOption; 1169 } 1170 export type TargetOnDeviceServiceList = TargetOnDeviceService[]; 1171 export interface TaxDocuments { 1172 IND?: INDTaxDocuments; 1173 } 1174 export type Timestamp = Date; 1175 export type TransferOption = "IMPORT"|"EXPORT"|"LOCAL_USE"|string; 1176 export interface UpdateClusterRequest { 1177 /** 1178 * The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000. 1179 */ 1180 ClusterId: ClusterId; 1181 /** 1182 * The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM). 1183 */ 1184 RoleARN?: RoleARN; 1185 /** 1186 * The updated description of this cluster. 1187 */ 1188 Description?: String; 1189 /** 1190 * The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects. 1191 */ 1192 Resources?: JobResource; 1193 /** 1194 * Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System). 1195 */ 1196 OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration; 1197 /** 1198 * The ID of the updated Address object. 1199 */ 1200 AddressId?: AddressId; 1201 /** 1202 * The updated shipping option value of this cluster's ShippingDetails object. 1203 */ 1204 ShippingOption?: ShippingOption; 1205 /** 1206 * The new or updated Notification object. 1207 */ 1208 Notification?: Notification; 1209 /** 1210 * The updated ID for the forwarding address for a cluster. This field is not supported in most regions. 1211 */ 1212 ForwardingAddressId?: AddressId; 1213 } 1214 export interface UpdateClusterResult { 1215 } 1216 export interface UpdateJobRequest { 1217 /** 1218 * The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000. 1219 */ 1220 JobId: JobId; 1221 /** 1222 * The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleAWS Identity and Access Management (IAM) API action. 1223 */ 1224 RoleARN?: RoleARN; 1225 /** 1226 * The new or updated Notification object. 1227 */ 1228 Notification?: Notification; 1229 /** 1230 * The updated JobResource object, or the updated JobResource object. 1231 */ 1232 Resources?: JobResource; 1233 /** 1234 * Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System). 1235 */ 1236 OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration; 1237 /** 1238 * The ID of the updated Address object. 1239 */ 1240 AddressId?: AddressId; 1241 /** 1242 * The updated shipping option value of this job's ShippingDetails object. 1243 */ 1244 ShippingOption?: ShippingOption; 1245 /** 1246 * The updated description of this job's JobMetadata object. 1247 */ 1248 Description?: String; 1249 /** 1250 * The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions. For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide. 1251 */ 1252 SnowballCapacityPreference?: SnowballCapacity; 1253 /** 1254 * The updated ID for the forwarding address for a job. This field is not supported in most regions. 1255 */ 1256 ForwardingAddressId?: AddressId; 1257 } 1258 export interface UpdateJobResult { 1259 } 1260 export interface UpdateJobShipmentStateRequest { 1261 /** 1262 * The job ID of the job whose shipment date you want to update, for example JID123e4567-e89b-12d3-a456-426655440000. 1263 */ 1264 JobId: JobId; 1265 /** 1266 * The state of a device when it is being shipped. Set to RECEIVED when the device arrives at your location. Set to RETURNED when you have returned the device to AWS. 1267 */ 1268 ShipmentState: ShipmentState; 1269 } 1270 export interface UpdateJobShipmentStateResult { 1271 } 1272 export interface UpdateLongTermPricingRequest { 1273 /** 1274 * The ID of the long-term pricing type for the device. 1275 */ 1276 LongTermPricingId: LongTermPricingId; 1277 /** 1278 * Specifies that a device that is ordered with long-term pricing should be replaced with a new device. 1279 */ 1280 ReplacementJob?: JobId; 1281 /** 1282 * If set to true, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires. 1283 */ 1284 IsLongTermPricingAutoRenew?: JavaBoolean; 1285 } 1286 export interface UpdateLongTermPricingResult { 1287 } 1288 export interface WirelessConnection { 1289 /** 1290 * Enables the Wi-Fi adapter on an AWS Snowcone device. 1291 */ 1292 IsWifiEnabled?: Boolean; 1293 } 1294 /** 1295 * 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. 1296 */ 1297 export type apiVersion = "2016-06-30"|"latest"|string; 1298 export interface ClientApiVersions { 1299 /** 1300 * 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. 1301 */ 1302 apiVersion?: apiVersion; 1303 } 1304 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1305 /** 1306 * Contains interfaces for use with the Snowball client. 1307 */ 1308 export import Types = Snowball; 1309 } 1310 export = Snowball;