Serialized Form (AWS Java SDK for Amazon Snowball 1.11.46 API)

Package com.amazonaws.services.snowball.model
- Class com.amazonaws.services.snowball.model.Address extends Object implements Serializable
  - Serialized Fields
    - addressId
```
String addressId
```
      The unique ID for an address.
    - name
```
String name
```
      The name of a person to receive a Snowball at an address.
    - company
```
String company
```
      The name of the company to receive a Snowball at an address.
    - street1
```
String street1
```
      The first line in a street address that a Snowball is to be delivered to.
    - street2
```
String street2
```
      The second line in a street address that a Snowball is to be delivered to.
    - street3
```
String street3
```
      The third line in a street address that a Snowball is to be delivered to.
    - city
```
String city
```
      The city in an address that a Snowball is to be delivered to.
    - stateOrProvince
```
String stateOrProvince
```
      The state or province in an address that a Snowball is to be delivered to.
    - prefectureOrDistrict
```
String prefectureOrDistrict
```
      The prefecture or district in an address that a Snowball is to be delivered to.
    - landmark
```
String landmark
```
      A landmark listed in an address that a Snowball is to be delivered to.
    - country
```
String country
```
      The country in an address that a Snowball is to be delivered to.
    - postalCode
```
String postalCode
```
      The postal code in an address that a Snowball is to be delivered to.
    - phoneNumber
```
String phoneNumber
```
      The phone number associated with an address that a Snowball is to be delivered to.
- Class com.amazonaws.services.snowball.model.AmazonSnowballException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.snowball.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The 39 character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.
- Class com.amazonaws.services.snowball.model.CancelJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.snowball.model.CreateAddressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - address
```
Address address
```
      The address that you want the Snowball shipped to.
- Class com.amazonaws.services.snowball.model.CreateAddressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - addressId
```
String addressId
```
      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.
- Class com.amazonaws.services.snowball.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobType
```
String jobType
```
      Defines the type of job that you're creating.
    - resources
```
JobResource resources
```
      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.
    - description
```
String description
```
      Defines an optional description of this specific job, for example Important Photos 2016-08-11.
    - addressId
```
String addressId
```
      The ID for the address that you want the Snowball shipped to.
    - kmsKeyARN
```
String kmsKeyARN
```
      The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.
    - roleARN
```
String roleARN
```
      The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.
    - snowballCapacityPreference
```
String snowballCapacityPreference
```
      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.
    - shippingOption
```
String shippingOption
```
      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.
    - notification
```
Notification notification
```
      Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
- Class com.amazonaws.services.snowball.model.CreateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
- Class com.amazonaws.services.snowball.model.DataTransfer extends Object implements Serializable
  - Serialized Fields
    - bytesTransferred
```
Long bytesTransferred
```
      The number of bytes transferred between a Snowball and Amazon S3.
    - objectsTransferred
```
Long objectsTransferred
```
      The number of objects transferred between a Snowball and Amazon S3.
    - totalBytes
```
Long totalBytes
```
      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.
    - totalObjects
```
Long totalObjects
```
      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.
- Class com.amazonaws.services.snowball.model.DescribeAddressesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The number of ADDRESS objects to return.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.snowball.model.DescribeAddressesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - addresses
```
List<E> addresses
```
      The Snowball shipping addresses that were created for this account.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.snowball.model.DescribeAddressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - addressId
```
String addressId
```
      The automatically generated ID for a specific address.
- Class com.amazonaws.services.snowball.model.DescribeAddressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - address
```
Address address
```
      The address that you want the Snowball or Snowballs associated with a specific job to be shipped to.
- Class com.amazonaws.services.snowball.model.DescribeJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
- Class com.amazonaws.services.snowball.model.DescribeJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobMetadata
```
JobMetadata jobMetadata
```
      Information about a specific job, including shipping information, job status, and other important metadata.
    - subJobMetadata
```
List<E> subJobMetadata
```
      Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
- Class com.amazonaws.services.snowball.model.GetJobManifestRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000.
- Class com.amazonaws.services.snowball.model.GetJobManifestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - manifestURI
```
String manifestURI
```
      The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
- Class com.amazonaws.services.snowball.model.GetJobUnlockCodeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000.
- Class com.amazonaws.services.snowball.model.GetJobUnlockCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - unlockCode
```
String unlockCode
```
      The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 90 days after the job has been created.
- Class com.amazonaws.services.snowball.model.GetSnowballUsageRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.snowball.model.GetSnowballUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - snowballLimit
```
Integer snowballLimit
```
      The service limit for number of Snowballs this account can have at once. The default service limit is 1 (one).
    - snowballsInUse
```
Integer snowballsInUse
```
      The number of Snowballs that this account is currently using.
- Class com.amazonaws.services.snowball.model.InvalidAddressException extends AmazonSnowballException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.snowball.model.InvalidJobStateException extends AmazonSnowballException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.snowball.model.InvalidResourceException extends AmazonSnowballException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.snowball.model.JobListEntry extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
    - jobState
```
String jobState
```
      The current state of this job.
    - isMaster
```
Boolean isMaster
```
      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.
- Class com.amazonaws.services.snowball.model.JobLogs extends Object implements Serializable
  - Serialized Fields
    - jobCompletionReportURI
```
String jobCompletionReportURI
```
      A link to an Amazon S3 presigned URL where the job completion report is located.
    - jobSuccessLogURI
```
String jobSuccessLogURI
```
      A link to an Amazon S3 presigned URL where the job success log is located.
    - jobFailureLogURI
```
String jobFailureLogURI
```
      A link to an Amazon S3 presigned URL where the job failure log is located.
- Class com.amazonaws.services.snowball.model.JobMetadata extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
    - jobState
```
String jobState
```
      The current state of the jobs.
    - jobType
```
String jobType
```
      The type of job.
    - creationDate
```
Date creationDate
```
      The creation date for this job.
    - resources
```
JobResource resources
```
      An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.
    - description
```
String description
```
      The description of the job, provided at job creation.
    - kmsKeyARN
```
String kmsKeyARN
```
      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.
    - roleARN
```
String roleARN
```
      The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
    - addressId
```
String addressId
```
      The ID for the address that you want the Snowball shipped to.
    - shippingDetails
```
ShippingDetails shippingDetails
```
      A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
    - snowballCapacityPreference
```
String snowballCapacityPreference
```
      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.
    - notification
```
Notification notification
```
      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.
    - dataTransferProgress
```
DataTransfer dataTransferProgress
```
      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.
    - jobLogInfo
```
JobLogs jobLogInfo
```
      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.
- Class com.amazonaws.services.snowball.model.JobResource extends Object implements Serializable
  - Serialized Fields
    - s3Resources
```
List<E> s3Resources
```
      An array of S3Resource objects.
- Class com.amazonaws.services.snowball.model.KeyRange extends Object implements Serializable
  - Serialized Fields
    - beginMarker
```
String beginMarker
```
      The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
    - endMarker
```
String endMarker
```
      The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
- Class com.amazonaws.services.snowball.model.KMSRequestFailedException extends AmazonSnowballException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.snowball.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The number of JobListEntry objects to return.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.snowball.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobListEntries
```
List<E> jobListEntries
```
      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.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.snowball.model.Notification extends Object implements Serializable
  - Serialized Fields
    - snsTopicARN
```
String snsTopicARN
```
      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.
    - jobStatesToNotify
```
List<E> jobStatesToNotify
```
      The list of job states that will trigger a notification for this job.
    - notifyAll
```
Boolean notifyAll
```
      Any change in job state will trigger a notification for this job.
- Class com.amazonaws.services.snowball.model.S3Resource extends Object implements Serializable
  - Serialized Fields
    - bucketArn
```
String bucketArn
```
      The Amazon Resource Name (ARN) of an Amazon S3 bucket.
    - keyRange
```
KeyRange keyRange
```
      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.
- Class com.amazonaws.services.snowball.model.Shipment extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      Status information for a shipment. Valid statuses include NEW, IN_TRANSIT, and DELIVERED.
    - trackingNumber
```
String trackingNumber
```
      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.
- Class com.amazonaws.services.snowball.model.ShippingDetails extends Object implements Serializable
  - Serialized Fields
    - shippingOption
```
String shippingOption
```
      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.
    - inboundShipment
```
Shipment inboundShipment
```
      The Status and TrackingNumber values for a Snowball being delivered to the address that you specified for a particular job.
    - outboundShipment
```
Shipment outboundShipment
```
      The Status and TrackingNumber values for a Snowball being returned to AWS for a particular job.
- Class com.amazonaws.services.snowball.model.UnsupportedAddressException extends AmazonSnowballException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.snowball.model.UpdateJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
    - roleARN
```
String roleARN
```
      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.
    - notification
```
Notification notification
```
      The new or updated Notification object.
    - resources
```
JobResource resources
```
      The updated S3Resource object (for a single Amazon S3 bucket or key range), or the updated JobResource object (for multiple buckets or key ranges).
    - addressId
```
String addressId
```
      The ID of the updated Address object.
    - shippingOption
```
String shippingOption
```
      The updated shipping option value of this job's ShippingDetails object.
    - description
```
String description
```
      The updated description of this job's JobMetadata object.
    - snowballCapacityPreference
```
String snowballCapacityPreference
```
      The updated SnowballCapacityPreference of this job's JobMetadata object. Note that the 50 TB Snowballs are only available in the US regions.
- Class com.amazonaws.services.snowball.model.UpdateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Form

Package com.amazonaws.services.snowball.model

Class com.amazonaws.services.snowball.model.Address extends Object implements Serializable

Serialized Fields

addressId

name

company

street1

street2

street3

city

stateOrProvince

prefectureOrDistrict

landmark

country

postalCode

phoneNumber

Class com.amazonaws.services.snowball.model.AmazonSnowballException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.snowball.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

Class com.amazonaws.services.snowball.model.CancelJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.snowball.model.CreateAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

address

Class com.amazonaws.services.snowball.model.CreateAddressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

addressId

Class com.amazonaws.services.snowball.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobType

resources

description

addressId

kmsKeyARN

roleARN

snowballCapacityPreference

shippingOption

notification

Class com.amazonaws.services.snowball.model.CreateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

jobId

Class com.amazonaws.services.snowball.model.DataTransfer extends Object implements Serializable

Serialized Fields

bytesTransferred

objectsTransferred

totalBytes

totalObjects

Class com.amazonaws.services.snowball.model.DescribeAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

nextToken

Class com.amazonaws.services.snowball.model.DescribeAddressesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

addresses

nextToken

Class com.amazonaws.services.snowball.model.DescribeAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

addressId

Class com.amazonaws.services.snowball.model.DescribeAddressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

address

Class com.amazonaws.services.snowball.model.DescribeJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

Class com.amazonaws.services.snowball.model.DescribeJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

jobMetadata

subJobMetadata

Class com.amazonaws.services.snowball.model.GetJobManifestRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

Class com.amazonaws.services.snowball.model.GetJobManifestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

manifestURI

Class com.amazonaws.services.snowball.model.GetJobUnlockCodeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

Class com.amazonaws.services.snowball.model.GetJobUnlockCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields