@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSnowballAsync extends AmazonSnowball
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonSnowballAsync instead.
The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<CancelClusterResult> |
cancelClusterAsync(CancelClusterRequest cancelClusterRequest)
Cancels a cluster job.
|
Future<CancelClusterResult> |
cancelClusterAsync(CancelClusterRequest cancelClusterRequest,
AsyncHandler<CancelClusterRequest,CancelClusterResult> asyncHandler)
Cancels a cluster job.
|
Future<CancelJobResult> |
cancelJobAsync(CancelJobRequest cancelJobRequest)
Cancels the specified job.
|
Future<CancelJobResult> |
cancelJobAsync(CancelJobRequest cancelJobRequest,
AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
Cancels the specified job.
|
Future<CreateAddressResult> |
createAddressAsync(CreateAddressRequest createAddressRequest)
Creates an address for a Snow device to be shipped to.
|
Future<CreateAddressResult> |
createAddressAsync(CreateAddressRequest createAddressRequest,
AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler)
Creates an address for a Snow device to be shipped to.
|
Future<CreateClusterResult> |
createClusterAsync(CreateClusterRequest createClusterRequest)
Creates an empty cluster.
|
Future<CreateClusterResult> |
createClusterAsync(CreateClusterRequest createClusterRequest,
AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)
Creates an empty cluster.
|
Future<CreateJobResult> |
createJobAsync(CreateJobRequest createJobRequest)
Creates a job to import or export data between Amazon S3 and your on-premises data center.
|
Future<CreateJobResult> |
createJobAsync(CreateJobRequest createJobRequest,
AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
Creates a job to import or export data between Amazon S3 and your on-premises data center.
|
Future<CreateLongTermPricingResult> |
createLongTermPricingAsync(CreateLongTermPricingRequest createLongTermPricingRequest)
Creates a job with the long-term usage option for a device.
|
Future<CreateLongTermPricingResult> |
createLongTermPricingAsync(CreateLongTermPricingRequest createLongTermPricingRequest,
AsyncHandler<CreateLongTermPricingRequest,CreateLongTermPricingResult> asyncHandler)
Creates a job with the long-term usage option for a device.
|
Future<CreateReturnShippingLabelResult> |
createReturnShippingLabelAsync(CreateReturnShippingLabelRequest createReturnShippingLabelRequest)
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
|
Future<CreateReturnShippingLabelResult> |
createReturnShippingLabelAsync(CreateReturnShippingLabelRequest createReturnShippingLabelRequest,
AsyncHandler<CreateReturnShippingLabelRequest,CreateReturnShippingLabelResult> asyncHandler)
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
|
Future<DescribeAddressResult> |
describeAddressAsync(DescribeAddressRequest describeAddressRequest)
Takes an
AddressId and returns specific details about that address in the form of an
Address object. |
Future<DescribeAddressResult> |
describeAddressAsync(DescribeAddressRequest describeAddressRequest,
AsyncHandler<DescribeAddressRequest,DescribeAddressResult> asyncHandler)
Takes an
AddressId and returns specific details about that address in the form of an
Address object. |
Future<DescribeAddressesResult> |
describeAddressesAsync(DescribeAddressesRequest describeAddressesRequest)
Returns a specified number of
ADDRESS objects. |
Future<DescribeAddressesResult> |
describeAddressesAsync(DescribeAddressesRequest describeAddressesRequest,
AsyncHandler<DescribeAddressesRequest,DescribeAddressesResult> asyncHandler)
Returns a specified number of
ADDRESS objects. |
Future<DescribeClusterResult> |
describeClusterAsync(DescribeClusterRequest describeClusterRequest)
Returns information about a specific cluster including shipping information, cluster status, and other important
metadata.
|
Future<DescribeClusterResult> |
describeClusterAsync(DescribeClusterRequest describeClusterRequest,
AsyncHandler<DescribeClusterRequest,DescribeClusterResult> asyncHandler)
Returns information about a specific cluster including shipping information, cluster status, and other important
metadata.
|
Future<DescribeJobResult> |
describeJobAsync(DescribeJobRequest describeJobRequest)
Returns information about a specific job including shipping information, job status, and other important
metadata.
|
Future<DescribeJobResult> |
describeJobAsync(DescribeJobRequest describeJobRequest,
AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)
Returns information about a specific job including shipping information, job status, and other important
metadata.
|
Future<DescribeReturnShippingLabelResult> |
describeReturnShippingLabelAsync(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest)
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
|
Future<DescribeReturnShippingLabelResult> |
describeReturnShippingLabelAsync(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest,
AsyncHandler<DescribeReturnShippingLabelRequest,DescribeReturnShippingLabelResult> asyncHandler)
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
|
Future<GetJobManifestResult> |
getJobManifestAsync(GetJobManifestRequest getJobManifestRequest)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId value. |
Future<GetJobManifestResult> |
getJobManifestAsync(GetJobManifestRequest getJobManifestRequest,
AsyncHandler<GetJobManifestRequest,GetJobManifestResult> asyncHandler)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId value. |
Future<GetJobUnlockCodeResult> |
getJobUnlockCodeAsync(GetJobUnlockCodeRequest getJobUnlockCodeRequest)
Returns the
UnlockCode code value for the specified job. |
Future<GetJobUnlockCodeResult> |
getJobUnlockCodeAsync(GetJobUnlockCodeRequest getJobUnlockCodeRequest,
AsyncHandler<GetJobUnlockCodeRequest,GetJobUnlockCodeResult> asyncHandler)
Returns the
UnlockCode code value for the specified job. |
Future<GetSnowballUsageResult> |
getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest)
Returns information about the Snow Family service limit for your account, and also the number of Snow devices
your account has in use.
|
Future<GetSnowballUsageResult> |
getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest,
AsyncHandler<GetSnowballUsageRequest,GetSnowballUsageResult> asyncHandler)
Returns information about the Snow Family service limit for your account, and also the number of Snow devices
your account has in use.
|
Future<GetSoftwareUpdatesResult> |
getSoftwareUpdatesAsync(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest)
Returns an Amazon S3 presigned URL for an update file associated with a specified
JobId. |
Future<GetSoftwareUpdatesResult> |
getSoftwareUpdatesAsync(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest,
AsyncHandler<GetSoftwareUpdatesRequest,GetSoftwareUpdatesResult> asyncHandler)
Returns an Amazon S3 presigned URL for an update file associated with a specified
JobId. |
Future<ListClusterJobsResult> |
listClusterJobsAsync(ListClusterJobsRequest listClusterJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
Future<ListClusterJobsResult> |
listClusterJobsAsync(ListClusterJobsRequest listClusterJobsRequest,
AsyncHandler<ListClusterJobsRequest,ListClusterJobsResult> asyncHandler)
Returns an array of
JobListEntry objects of the specified length. |
Future<ListClustersResult> |
listClustersAsync(ListClustersRequest listClustersRequest)
Returns an array of
ClusterListEntry objects of the specified length. |
Future<ListClustersResult> |
listClustersAsync(ListClustersRequest listClustersRequest,
AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)
Returns an array of
ClusterListEntry objects of the specified length. |
Future<ListCompatibleImagesResult> |
listCompatibleImagesAsync(ListCompatibleImagesRequest listCompatibleImagesRequest)
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by
your Amazon Web Services accountthat would be supported for use on a Snow device.
|
Future<ListCompatibleImagesResult> |
listCompatibleImagesAsync(ListCompatibleImagesRequest listCompatibleImagesRequest,
AsyncHandler<ListCompatibleImagesRequest,ListCompatibleImagesResult> asyncHandler)
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by
your Amazon Web Services accountthat would be supported for use on a Snow device.
|
Future<ListJobsResult> |
listJobsAsync(ListJobsRequest listJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
Future<ListJobsResult> |
listJobsAsync(ListJobsRequest listJobsRequest,
AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
Returns an array of
JobListEntry objects of the specified length. |
Future<ListLongTermPricingResult> |
listLongTermPricingAsync(ListLongTermPricingRequest listLongTermPricingRequest)
Lists all long-term pricing types.
|
Future<ListLongTermPricingResult> |
listLongTermPricingAsync(ListLongTermPricingRequest listLongTermPricingRequest,
AsyncHandler<ListLongTermPricingRequest,ListLongTermPricingResult> asyncHandler)
Lists all long-term pricing types.
|
Future<ListPickupLocationsResult> |
listPickupLocationsAsync(ListPickupLocationsRequest listPickupLocationsRequest)
A list of locations from which the customer can choose to pickup a device.
|
Future<ListPickupLocationsResult> |
listPickupLocationsAsync(ListPickupLocationsRequest listPickupLocationsRequest,
AsyncHandler<ListPickupLocationsRequest,ListPickupLocationsResult> asyncHandler)
A list of locations from which the customer can choose to pickup a device.
|
Future<ListServiceVersionsResult> |
listServiceVersionsAsync(ListServiceVersionsRequest listServiceVersionsRequest)
Lists all supported versions for Snow on-device services.
|
Future<ListServiceVersionsResult> |
listServiceVersionsAsync(ListServiceVersionsRequest listServiceVersionsRequest,
AsyncHandler<ListServiceVersionsRequest,ListServiceVersionsResult> asyncHandler)
Lists all supported versions for Snow on-device services.
|
Future<UpdateClusterResult> |
updateClusterAsync(UpdateClusterRequest updateClusterRequest)
While a cluster's
ClusterState value is in the AwaitingQuorum state, you can update
some of the information associated with a cluster. |
Future<UpdateClusterResult> |
updateClusterAsync(UpdateClusterRequest updateClusterRequest,
AsyncHandler<UpdateClusterRequest,UpdateClusterResult> asyncHandler)
While a cluster's
ClusterState value is in the AwaitingQuorum state, you can update
some of the information associated with a cluster. |
Future<UpdateJobResult> |
updateJobAsync(UpdateJobRequest updateJobRequest)
While a job's
JobState value is New, you can update some of the information associated
with a job. |
Future<UpdateJobResult> |
updateJobAsync(UpdateJobRequest updateJobRequest,
AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler)
While a job's
JobState value is New, you can update some of the information associated
with a job. |
Future<UpdateJobShipmentStateResult> |
updateJobShipmentStateAsync(UpdateJobShipmentStateRequest updateJobShipmentStateRequest)
Updates the state when a shipment state changes to a different state.
|
Future<UpdateJobShipmentStateResult> |
updateJobShipmentStateAsync(UpdateJobShipmentStateRequest updateJobShipmentStateRequest,
AsyncHandler<UpdateJobShipmentStateRequest,UpdateJobShipmentStateResult> asyncHandler)
Updates the state when a shipment state changes to a different state.
|
Future<UpdateLongTermPricingResult> |
updateLongTermPricingAsync(UpdateLongTermPricingRequest updateLongTermPricingRequest)
Updates the long-term pricing type.
|
Future<UpdateLongTermPricingResult> |
updateLongTermPricingAsync(UpdateLongTermPricingRequest updateLongTermPricingRequest,
AsyncHandler<UpdateLongTermPricingRequest,UpdateLongTermPricingResult> asyncHandler)
Updates the long-term pricing type.
|
cancelCluster, cancelJob, createAddress, createCluster, createJob, createLongTermPricing, createReturnShippingLabel, describeAddress, describeAddresses, describeCluster, describeJob, describeReturnShippingLabel, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, getSoftwareUpdates, listClusterJobs, listClusters, listCompatibleImages, listJobs, listLongTermPricing, listPickupLocations, listServiceVersions, setEndpoint, setRegion, shutdown, updateCluster, updateJob, updateJobShipmentState, updateLongTermPricingFuture<CancelClusterResult> cancelClusterAsync(CancelClusterRequest cancelClusterRequest)
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.
cancelClusterRequest - Future<CancelClusterResult> cancelClusterAsync(CancelClusterRequest cancelClusterRequest, AsyncHandler<CancelClusterRequest,CancelClusterResult> asyncHandler)
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.
cancelClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest)
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.
cancelJobRequest - Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
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.
cancelJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAddressResult> createAddressAsync(CreateAddressRequest createAddressRequest)
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.
createAddressRequest - Future<CreateAddressResult> createAddressAsync(CreateAddressRequest createAddressRequest, AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler)
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.
createAddressRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateClusterResult> createClusterAsync(CreateClusterRequest createClusterRequest)
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.
createClusterRequest - Future<CreateClusterResult> createClusterAsync(CreateClusterRequest createClusterRequest, AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)
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.
createClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest)
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web
Services 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 Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
Snow Family devices and their capacities.
Device type: SNC1_SSD
Capacity: T14
Description: Snowcone
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
This device is replaced with T98.
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
Snow Family device type: RACK_5U_C
Capacity: T13
Description: Snowblade.
Device type: V3_5S
Capacity: T240
Description: Snowball Edge Storage Optimized 210TB
createJobRequest - Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest, AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web
Services 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 Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
Snow Family devices and their capacities.
Device type: SNC1_SSD
Capacity: T14
Description: Snowcone
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
This device is replaced with T98.
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
Snow Family device type: RACK_5U_C
Capacity: T13
Description: Snowblade.
Device type: V3_5S
Capacity: T240
Description: Snowball Edge Storage Optimized 210TB
createJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateLongTermPricingResult> createLongTermPricingAsync(CreateLongTermPricingRequest createLongTermPricingRequest)
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 Amazon Web Services provides discounts for long-term pricing.
createLongTermPricingRequest - Future<CreateLongTermPricingResult> createLongTermPricingAsync(CreateLongTermPricingRequest createLongTermPricingRequest, AsyncHandler<CreateLongTermPricingRequest,CreateLongTermPricingResult> asyncHandler)
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 Amazon Web Services provides discounts for long-term pricing.
createLongTermPricingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateReturnShippingLabelResult> createReturnShippingLabelAsync(CreateReturnShippingLabelRequest createReturnShippingLabelRequest)
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
createReturnShippingLabelRequest - Future<CreateReturnShippingLabelResult> createReturnShippingLabelAsync(CreateReturnShippingLabelRequest createReturnShippingLabelRequest, AsyncHandler<CreateReturnShippingLabelRequest,CreateReturnShippingLabelResult> asyncHandler)
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
createReturnShippingLabelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAddressResult> describeAddressAsync(DescribeAddressRequest describeAddressRequest)
Takes an AddressId and returns specific details about that address in the form of an
Address object.
describeAddressRequest - Future<DescribeAddressResult> describeAddressAsync(DescribeAddressRequest describeAddressRequest, AsyncHandler<DescribeAddressRequest,DescribeAddressResult> asyncHandler)
Takes an AddressId and returns specific details about that address in the form of an
Address object.
describeAddressRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAddressesResult> describeAddressesAsync(DescribeAddressesRequest describeAddressesRequest)
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.
describeAddressesRequest - Future<DescribeAddressesResult> describeAddressesAsync(DescribeAddressesRequest describeAddressesRequest, AsyncHandler<DescribeAddressesRequest,DescribeAddressesResult> asyncHandler)
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.
describeAddressesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest describeClusterRequest)
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
describeClusterRequest - Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest describeClusterRequest, AsyncHandler<DescribeClusterRequest,DescribeClusterResult> asyncHandler)
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
describeClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeJobResult> describeJobAsync(DescribeJobRequest describeJobRequest)
Returns information about a specific job including shipping information, job status, and other important metadata.
describeJobRequest - Future<DescribeJobResult> describeJobAsync(DescribeJobRequest describeJobRequest, AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)
Returns information about a specific job including shipping information, job status, and other important metadata.
describeJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeReturnShippingLabelResult> describeReturnShippingLabelAsync(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest)
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
describeReturnShippingLabelRequest - Future<DescribeReturnShippingLabelResult> describeReturnShippingLabelAsync(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest, AsyncHandler<DescribeReturnShippingLabelRequest,DescribeReturnShippingLabelResult> asyncHandler)
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
describeReturnShippingLabelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest getJobManifestRequest)
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. This is the only valid status for calling this API as the manifest and UnlockCode code value
are used for securing your device and should only be used when you have the device. 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.
getJobManifestRequest - Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest getJobManifestRequest, AsyncHandler<GetJobManifestRequest,GetJobManifestResult> asyncHandler)
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. This is the only valid status for calling this API as the manifest and UnlockCode code value
are used for securing your device and should only be used when you have the device. 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.
getJobManifestRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(GetJobUnlockCodeRequest getJobUnlockCodeRequest)
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. The only valid status for calling this API is
WithCustomer as the manifest and Unlock code values are used for securing your device
and should only be used when you have the device.
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.
getJobUnlockCodeRequest - Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(GetJobUnlockCodeRequest getJobUnlockCodeRequest, AsyncHandler<GetJobUnlockCodeRequest,GetJobUnlockCodeResult> asyncHandler)
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. The only valid status for calling this API is
WithCustomer as the manifest and Unlock code values are used for securing your device
and should only be used when you have the device.
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.
getJobUnlockCodeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest)
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 Amazon Web Services Support.
getSnowballUsageRequest - Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest, AsyncHandler<GetSnowballUsageRequest,GetSnowballUsageResult> asyncHandler)
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 Amazon Web Services Support.
getSnowballUsageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSoftwareUpdatesResult> getSoftwareUpdatesAsync(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest)
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
getSoftwareUpdatesRequest - Future<GetSoftwareUpdatesResult> getSoftwareUpdatesAsync(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest, AsyncHandler<GetSoftwareUpdatesRequest,GetSoftwareUpdatesResult> asyncHandler)
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
getSoftwareUpdatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListClusterJobsResult> listClusterJobsAsync(ListClusterJobsRequest listClusterJobsRequest)
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.
listClusterJobsRequest - Future<ListClusterJobsResult> listClusterJobsAsync(ListClusterJobsRequest listClusterJobsRequest, AsyncHandler<ListClusterJobsRequest,ListClusterJobsResult> asyncHandler)
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.
listClusterJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListClustersResult> listClustersAsync(ListClustersRequest listClustersRequest)
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.
listClustersRequest - Future<ListClustersResult> listClustersAsync(ListClustersRequest listClustersRequest, AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)
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.
listClustersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCompatibleImagesResult> listCompatibleImagesAsync(ListCompatibleImagesRequest listCompatibleImagesRequest)
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
listCompatibleImagesRequest - Future<ListCompatibleImagesResult> listCompatibleImagesAsync(ListCompatibleImagesRequest listCompatibleImagesRequest, AsyncHandler<ListCompatibleImagesRequest,ListCompatibleImagesResult> asyncHandler)
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
listCompatibleImagesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest)
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.
listJobsRequest - Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest, AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
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.
listJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListLongTermPricingResult> listLongTermPricingAsync(ListLongTermPricingRequest listLongTermPricingRequest)
Lists all long-term pricing types.
listLongTermPricingRequest - Future<ListLongTermPricingResult> listLongTermPricingAsync(ListLongTermPricingRequest listLongTermPricingRequest, AsyncHandler<ListLongTermPricingRequest,ListLongTermPricingResult> asyncHandler)
Lists all long-term pricing types.
listLongTermPricingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPickupLocationsResult> listPickupLocationsAsync(ListPickupLocationsRequest listPickupLocationsRequest)
A list of locations from which the customer can choose to pickup a device.
listPickupLocationsRequest - Future<ListPickupLocationsResult> listPickupLocationsAsync(ListPickupLocationsRequest listPickupLocationsRequest, AsyncHandler<ListPickupLocationsRequest,ListPickupLocationsResult> asyncHandler)
A list of locations from which the customer can choose to pickup a device.
listPickupLocationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListServiceVersionsResult> listServiceVersionsAsync(ListServiceVersionsRequest listServiceVersionsRequest)
Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object
containing the supported versions for a particular service.
listServiceVersionsRequest - Future<ListServiceVersionsResult> listServiceVersionsAsync(ListServiceVersionsRequest listServiceVersionsRequest, AsyncHandler<ListServiceVersionsRequest,ListServiceVersionsResult> asyncHandler)
Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object
containing the supported versions for a particular service.
listServiceVersionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest updateClusterRequest)
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.
updateClusterRequest - Future<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest updateClusterRequest, AsyncHandler<UpdateClusterRequest,UpdateClusterResult> asyncHandler)
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.
updateClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateJobResult> updateJobAsync(UpdateJobRequest updateJobRequest)
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.
updateJobRequest - Future<UpdateJobResult> updateJobAsync(UpdateJobRequest updateJobRequest, AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler)
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.
updateJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateJobShipmentStateResult> updateJobShipmentStateAsync(UpdateJobShipmentStateRequest updateJobShipmentStateRequest)
Updates the state when a shipment state changes to a different state.
updateJobShipmentStateRequest - Future<UpdateJobShipmentStateResult> updateJobShipmentStateAsync(UpdateJobShipmentStateRequest updateJobShipmentStateRequest, AsyncHandler<UpdateJobShipmentStateRequest,UpdateJobShipmentStateResult> asyncHandler)
Updates the state when a shipment state changes to a different state.
updateJobShipmentStateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateLongTermPricingResult> updateLongTermPricingAsync(UpdateLongTermPricingRequest updateLongTermPricingRequest)
Updates the long-term pricing type.
updateLongTermPricingRequest - Future<UpdateLongTermPricingResult> updateLongTermPricingAsync(UpdateLongTermPricingRequest updateLongTermPricingRequest, AsyncHandler<UpdateLongTermPricingRequest,UpdateLongTermPricingResult> asyncHandler)
Updates the long-term pricing type.
updateLongTermPricingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.