com.amazonaws.services.snowball.AmazonSnowballAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-snowball Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.snowball;
import javax.annotation.Generated;
import com.amazonaws.services.snowball.model.*;
/**
* Interface for accessing Amazon Snowball asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code 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
* {@link com.amazonaws.services.snowball.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSnowballAsync extends AmazonSnowball {
/**
*
* 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.
*
*
* @param cancelClusterRequest
* @return A Java Future containing the result of the CancelCluster operation returned by the service.
* @sample AmazonSnowballAsync.CancelCluster
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param cancelClusterRequest
* @param 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.
* @return A Java Future containing the result of the CancelCluster operation returned by the service.
* @sample AmazonSnowballAsyncHandler.CancelCluster
* @see AWS API
* Documentation
*/
java.util.concurrent.Future cancelClusterAsync(CancelClusterRequest cancelClusterRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param cancelJobRequest
* @return A Java Future containing the result of the CancelJob operation returned by the service.
* @sample AmazonSnowballAsync.CancelJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param cancelJobRequest
* @param 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.
* @return A Java Future containing the result of the CancelJob operation returned by the service.
* @sample AmazonSnowballAsyncHandler.CancelJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future cancelJobAsync(CancelJobRequest cancelJobRequest,
com.amazonaws.handlers.AsyncHandler 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. If providing an address as a JSON file through the
* cli-input-json option, include the full file path. For example,
* --cli-input-json file://create-address.json.
*
*
* @param createAddressRequest
* @return A Java Future containing the result of the CreateAddress operation returned by the service.
* @sample AmazonSnowballAsync.CreateAddress
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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. If providing an address as a JSON file through the
* cli-input-json option, include the full file path. For example,
* --cli-input-json file://create-address.json.
*
*
* @param createAddressRequest
* @param 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.
* @return A Java Future containing the result of the CreateAddress operation returned by the service.
* @sample AmazonSnowballAsyncHandler.CreateAddress
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createAddressAsync(CreateAddressRequest createAddressRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param createClusterRequest
* @return A Java Future containing the result of the CreateCluster operation returned by the service.
* @sample AmazonSnowballAsync.CreateCluster
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createClusterRequest
* @param 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.
* @return A Java Future containing the result of the CreateCluster operation returned by the service.
* @sample AmazonSnowballAsyncHandler.CreateCluster
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createClusterAsync(CreateClusterRequest createClusterRequest,
com.amazonaws.handlers.AsyncHandler 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
*
*
*
*
*
*
* @param createJobRequest
* @return A Java Future containing the result of the CreateJob operation returned by the service.
* @sample AmazonSnowballAsync.CreateJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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
*
*
*
*
*
*
* @param createJobRequest
* @param 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.
* @return A Java Future containing the result of the CreateJob operation returned by the service.
* @sample AmazonSnowballAsyncHandler.CreateJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createJobAsync(CreateJobRequest createJobRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param createLongTermPricingRequest
* @return A Java Future containing the result of the CreateLongTermPricing operation returned by the service.
* @sample AmazonSnowballAsync.CreateLongTermPricing
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createLongTermPricingRequest
* @param 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.
* @return A Java Future containing the result of the CreateLongTermPricing operation returned by the service.
* @sample AmazonSnowballAsyncHandler.CreateLongTermPricing
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createLongTermPricingAsync(CreateLongTermPricingRequest createLongTermPricingRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
*
*
* @param createReturnShippingLabelRequest
* @return A Java Future containing the result of the CreateReturnShippingLabel operation returned by the service.
* @sample AmazonSnowballAsync.CreateReturnShippingLabel
* @see AWS API Documentation
*/
java.util.concurrent.Future createReturnShippingLabelAsync(
CreateReturnShippingLabelRequest createReturnShippingLabelRequest);
/**
*
* Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
*
*
* @param createReturnShippingLabelRequest
* @param 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.
* @return A Java Future containing the result of the CreateReturnShippingLabel operation returned by the service.
* @sample AmazonSnowballAsyncHandler.CreateReturnShippingLabel
* @see AWS API Documentation
*/
java.util.concurrent.Future createReturnShippingLabelAsync(
CreateReturnShippingLabelRequest createReturnShippingLabelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Takes an AddressId and returns specific details about that address in the form of an
* Address object.
*
*
* @param describeAddressRequest
* @return A Java Future containing the result of the DescribeAddress operation returned by the service.
* @sample AmazonSnowballAsync.DescribeAddress
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeAddressAsync(DescribeAddressRequest describeAddressRequest);
/**
*
* Takes an AddressId and returns specific details about that address in the form of an
* Address object.
*
*
* @param describeAddressRequest
* @param 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.
* @return A Java Future containing the result of the DescribeAddress operation returned by the service.
* @sample AmazonSnowballAsyncHandler.DescribeAddress
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeAddressAsync(DescribeAddressRequest describeAddressRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param describeAddressesRequest
* @return A Java Future containing the result of the DescribeAddresses operation returned by the service.
* @sample AmazonSnowballAsync.DescribeAddresses
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeAddressesRequest
* @param 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.
* @return A Java Future containing the result of the DescribeAddresses operation returned by the service.
* @sample AmazonSnowballAsyncHandler.DescribeAddresses
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeAddressesAsync(DescribeAddressesRequest describeAddressesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about a specific cluster including shipping information, cluster status, and other important
* metadata.
*
*
* @param describeClusterRequest
* @return A Java Future containing the result of the DescribeCluster operation returned by the service.
* @sample AmazonSnowballAsync.DescribeCluster
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeClusterAsync(DescribeClusterRequest describeClusterRequest);
/**
*
* Returns information about a specific cluster including shipping information, cluster status, and other important
* metadata.
*
*
* @param describeClusterRequest
* @param 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.
* @return A Java Future containing the result of the DescribeCluster operation returned by the service.
* @sample AmazonSnowballAsyncHandler.DescribeCluster
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeClusterAsync(DescribeClusterRequest describeClusterRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about a specific job including shipping information, job status, and other important
* metadata.
*
*
* @param describeJobRequest
* @return A Java Future containing the result of the DescribeJob operation returned by the service.
* @sample AmazonSnowballAsync.DescribeJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeJobAsync(DescribeJobRequest describeJobRequest);
/**
*
* Returns information about a specific job including shipping information, job status, and other important
* metadata.
*
*
* @param describeJobRequest
* @param 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.
* @return A Java Future containing the result of the DescribeJob operation returned by the service.
* @sample AmazonSnowballAsyncHandler.DescribeJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeJobAsync(DescribeJobRequest describeJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
*
*
* @param describeReturnShippingLabelRequest
* @return A Java Future containing the result of the DescribeReturnShippingLabel operation returned by the service.
* @sample AmazonSnowballAsync.DescribeReturnShippingLabel
* @see AWS API Documentation
*/
java.util.concurrent.Future describeReturnShippingLabelAsync(
DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest);
/**
*
* Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
*
*
* @param describeReturnShippingLabelRequest
* @param 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.
* @return A Java Future containing the result of the DescribeReturnShippingLabel operation returned by the service.
* @sample AmazonSnowballAsyncHandler.DescribeReturnShippingLabel
* @see AWS API Documentation
*/
java.util.concurrent.Future describeReturnShippingLabelAsync(
DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getJobManifestRequest
* @return A Java Future containing the result of the GetJobManifest operation returned by the service.
* @sample AmazonSnowballAsync.GetJobManifest
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param getJobManifestRequest
* @param 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.
* @return A Java Future containing the result of the GetJobManifest operation returned by the service.
* @sample AmazonSnowballAsyncHandler.GetJobManifest
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getJobManifestAsync(GetJobManifestRequest getJobManifestRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getJobUnlockCodeRequest
* @return A Java Future containing the result of the GetJobUnlockCode operation returned by the service.
* @sample AmazonSnowballAsync.GetJobUnlockCode
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param getJobUnlockCodeRequest
* @param 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.
* @return A Java Future containing the result of the GetJobUnlockCode operation returned by the service.
* @sample AmazonSnowballAsyncHandler.GetJobUnlockCode
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getJobUnlockCodeAsync(GetJobUnlockCodeRequest getJobUnlockCodeRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getSnowballUsageRequest
* @return A Java Future containing the result of the GetSnowballUsage operation returned by the service.
* @sample AmazonSnowballAsync.GetSnowballUsage
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param getSnowballUsageRequest
* @param 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.
* @return A Java Future containing the result of the GetSnowballUsage operation returned by the service.
* @sample AmazonSnowballAsyncHandler.GetSnowballUsage
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
*
*
* @param getSoftwareUpdatesRequest
* @return A Java Future containing the result of the GetSoftwareUpdates operation returned by the service.
* @sample AmazonSnowballAsync.GetSoftwareUpdates
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getSoftwareUpdatesAsync(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest);
/**
*
* Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
*
*
* @param getSoftwareUpdatesRequest
* @param 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.
* @return A Java Future containing the result of the GetSoftwareUpdates operation returned by the service.
* @sample AmazonSnowballAsyncHandler.GetSoftwareUpdates
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getSoftwareUpdatesAsync(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listClusterJobsRequest
* @return A Java Future containing the result of the ListClusterJobs operation returned by the service.
* @sample AmazonSnowballAsync.ListClusterJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listClusterJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListClusterJobs operation returned by the service.
* @sample AmazonSnowballAsyncHandler.ListClusterJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listClusterJobsAsync(ListClusterJobsRequest listClusterJobsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listClustersRequest
* @return A Java Future containing the result of the ListClusters operation returned by the service.
* @sample AmazonSnowballAsync.ListClusters
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listClustersRequest
* @param 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.
* @return A Java Future containing the result of the ListClusters operation returned by the service.
* @sample AmazonSnowballAsyncHandler.ListClusters
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listClustersAsync(ListClustersRequest listClustersRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listCompatibleImagesRequest
* @return A Java Future containing the result of the ListCompatibleImages operation returned by the service.
* @sample AmazonSnowballAsync.ListCompatibleImages
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listCompatibleImagesRequest
* @param 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.
* @return A Java Future containing the result of the ListCompatibleImages operation returned by the service.
* @sample AmazonSnowballAsyncHandler.ListCompatibleImages
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listCompatibleImagesAsync(ListCompatibleImagesRequest listCompatibleImagesRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listJobsRequest
* @return A Java Future containing the result of the ListJobs operation returned by the service.
* @sample AmazonSnowballAsync.ListJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListJobs operation returned by the service.
* @sample AmazonSnowballAsyncHandler.ListJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listJobsAsync(ListJobsRequest listJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all long-term pricing types.
*
*
* @param listLongTermPricingRequest
* @return A Java Future containing the result of the ListLongTermPricing operation returned by the service.
* @sample AmazonSnowballAsync.ListLongTermPricing
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listLongTermPricingAsync(ListLongTermPricingRequest listLongTermPricingRequest);
/**
*
* Lists all long-term pricing types.
*
*
* @param listLongTermPricingRequest
* @param 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.
* @return A Java Future containing the result of the ListLongTermPricing operation returned by the service.
* @sample AmazonSnowballAsyncHandler.ListLongTermPricing
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listLongTermPricingAsync(ListLongTermPricingRequest listLongTermPricingRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* A list of locations from which the customer can choose to pickup a device.
*
*
* @param listPickupLocationsRequest
* @return A Java Future containing the result of the ListPickupLocations operation returned by the service.
* @sample AmazonSnowballAsync.ListPickupLocations
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPickupLocationsAsync(ListPickupLocationsRequest listPickupLocationsRequest);
/**
*
* A list of locations from which the customer can choose to pickup a device.
*
*
* @param listPickupLocationsRequest
* @param 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.
* @return A Java Future containing the result of the ListPickupLocations operation returned by the service.
* @sample AmazonSnowballAsyncHandler.ListPickupLocations
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPickupLocationsAsync(ListPickupLocationsRequest listPickupLocationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object
* containing the supported versions for a particular service.
*
*
* @param listServiceVersionsRequest
* @return A Java Future containing the result of the ListServiceVersions operation returned by the service.
* @sample AmazonSnowballAsync.ListServiceVersions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listServiceVersionsRequest
* @param 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.
* @return A Java Future containing the result of the ListServiceVersions operation returned by the service.
* @sample AmazonSnowballAsyncHandler.ListServiceVersions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listServiceVersionsAsync(ListServiceVersionsRequest listServiceVersionsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param updateClusterRequest
* @return A Java Future containing the result of the UpdateCluster operation returned by the service.
* @sample AmazonSnowballAsync.UpdateCluster
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param updateClusterRequest
* @param 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.
* @return A Java Future containing the result of the UpdateCluster operation returned by the service.
* @sample AmazonSnowballAsyncHandler.UpdateCluster
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateClusterAsync(UpdateClusterRequest updateClusterRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param updateJobRequest
* @return A Java Future containing the result of the UpdateJob operation returned by the service.
* @sample AmazonSnowballAsync.UpdateJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param updateJobRequest
* @param 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.
* @return A Java Future containing the result of the UpdateJob operation returned by the service.
* @sample AmazonSnowballAsyncHandler.UpdateJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateJobAsync(UpdateJobRequest updateJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the state when a shipment state changes to a different state.
*
*
* @param updateJobShipmentStateRequest
* @return A Java Future containing the result of the UpdateJobShipmentState operation returned by the service.
* @sample AmazonSnowballAsync.UpdateJobShipmentState
* @see AWS API Documentation
*/
java.util.concurrent.Future updateJobShipmentStateAsync(UpdateJobShipmentStateRequest updateJobShipmentStateRequest);
/**
*
* Updates the state when a shipment state changes to a different state.
*
*
* @param updateJobShipmentStateRequest
* @param 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.
* @return A Java Future containing the result of the UpdateJobShipmentState operation returned by the service.
* @sample AmazonSnowballAsyncHandler.UpdateJobShipmentState
* @see AWS API Documentation
*/
java.util.concurrent.Future updateJobShipmentStateAsync(UpdateJobShipmentStateRequest updateJobShipmentStateRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the long-term pricing type.
*
*
* @param updateLongTermPricingRequest
* @return A Java Future containing the result of the UpdateLongTermPricing operation returned by the service.
* @sample AmazonSnowballAsync.UpdateLongTermPricing
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateLongTermPricingAsync(UpdateLongTermPricingRequest updateLongTermPricingRequest);
/**
*
* Updates the long-term pricing type.
*
*
* @param updateLongTermPricingRequest
* @param 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.
* @return A Java Future containing the result of the UpdateLongTermPricing operation returned by the service.
* @sample AmazonSnowballAsyncHandler.UpdateLongTermPricing
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateLongTermPricingAsync(UpdateLongTermPricingRequest updateLongTermPricingRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}