com.amazonaws.services.snowball.AmazonSnowballAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-snowball Show documentation
/*
* Copyright 2011-2016 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 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.
*
*
* This is a test of the welcome page front matter.
*
*/
public interface AmazonSnowballAsync extends AmazonSnowball {
/**
*
* Cancels the specified job. Note that you can only cancel a job before its
* JobState value changes to PreparingAppliance.
* Requesting the ListJobs or DescribeJob action
* will return a job's JobState as part of the response element
* data returned.
*
*
* @param cancelJobRequest
* @return A Java Future containing the result of the CancelJob operation
* returned by the service.
* @sample AmazonSnowballAsync.CancelJob
*/
java.util.concurrent.Future cancelJobAsync(
CancelJobRequest cancelJobRequest);
/**
*
* Cancels the specified job. Note that you can only cancel a job before its
* JobState value changes to PreparingAppliance.
* Requesting the ListJobs or DescribeJob action
* will return a job's JobState as part of the response element
* data returned.
*
*
* @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
*/
java.util.concurrent.Future cancelJobAsync(
CancelJobRequest cancelJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates an address for a Snowball to be shipped to.
*
*
* Addresses are validated at the time of creation. The address you provide
* must be located within the serviceable area of your region. If the
* address is invalid or unsupported, then an exception is thrown.
*
*
* @param createAddressRequest
* @return A Java Future containing the result of the CreateAddress
* operation returned by the service.
* @sample AmazonSnowballAsync.CreateAddress
*/
java.util.concurrent.Future createAddressAsync(
CreateAddressRequest createAddressRequest);
/**
*
* Creates an address for a Snowball to be shipped to.
*
*
* Addresses are validated at the time of creation. The address you provide
* must be located within the serviceable area of your region. If the
* address is invalid or unsupported, then an exception is thrown.
*
*
* @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
*/
java.util.concurrent.Future createAddressAsync(
CreateAddressRequest createAddressRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a job to import or export data between Amazon S3 and your
* on-premises data center. Note that your AWS account must have the right
* trust policies and permissions in place to create a job for Snowball. For
* more information, see api-reference-policies.
*
*
* @param createJobRequest
* @return A Java Future containing the result of the CreateJob operation
* returned by the service.
* @sample AmazonSnowballAsync.CreateJob
*/
java.util.concurrent.Future createJobAsync(
CreateJobRequest createJobRequest);
/**
*
* Creates a job to import or export data between Amazon S3 and your
* on-premises data center. Note that your AWS account must have the right
* trust policies and permissions in place to create a job for Snowball. For
* more information, see api-reference-policies.
*
*
* @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
*/
java.util.concurrent.Future createJobAsync(
CreateJobRequest createJobRequest,
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
*/
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
*/
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
*/
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
*/
java.util.concurrent.Future describeAddressesAsync(
DescribeAddressesRequest describeAddressesRequest,
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
*/
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
*/
java.util.concurrent.Future describeJobAsync(
DescribeJobRequest describeJobRequest,
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. The manifest is decrypted by
* using the UnlockCode code value, when you pass both values
* to the Snowball through the Snowball client when the client is started
* for the first time.
*
*
* As a best practice, we recommend that you don't save a copy of an
* UnlockCode value in the same location as the manifest file
* for that job. Saving these separately helps prevent unauthorized parties
* from gaining access to the Snowball associated with that job.
*
*
* Note that the credentials of a given job, including its manifest file and
* unlock code, expire 90 days after the job is created.
*
*
* @param getJobManifestRequest
* @return A Java Future containing the result of the GetJobManifest
* operation returned by the service.
* @sample AmazonSnowballAsync.GetJobManifest
*/
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. The manifest is decrypted by
* using the UnlockCode code value, when you pass both values
* to the Snowball through the Snowball client when the client is started
* for the first time.
*
*
* As a best practice, we recommend that you don't save a copy of an
* UnlockCode value in the same location as the manifest file
* for that job. Saving these separately helps prevent unauthorized parties
* from gaining access to the Snowball associated with that job.
*
*
* Note that the credentials of a given job, including its manifest file and
* unlock code, expire 90 days after the job is created.
*
*
* @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
*/
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 90
* days after the associated job has been created.
*
*
* The UnlockCode value is a 29-character code with 25
* alphanumeric characters and 4 hyphens. This code is used to decrypt the
* manifest file when it is passed along with the manifest to the Snowball
* through the Snowball client when the client is started for the first
* time.
*
*
* As a best practice, we recommend that you don't save a copy of the
* UnlockCode in the same location as the manifest file for
* that job. Saving these separately helps prevent unauthorized parties from
* gaining access to the Snowball associated with that job.
*
*
* @param getJobUnlockCodeRequest
* @return A Java Future containing the result of the GetJobUnlockCode
* operation returned by the service.
* @sample AmazonSnowballAsync.GetJobUnlockCode
*/
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 90
* days after the associated job has been created.
*
*
* The UnlockCode value is a 29-character code with 25
* alphanumeric characters and 4 hyphens. This code is used to decrypt the
* manifest file when it is passed along with the manifest to the Snowball
* through the Snowball client when the client is started for the first
* time.
*
*
* As a best practice, we recommend that you don't save a copy of the
* UnlockCode in the same location as the manifest file for
* that job. Saving these separately helps prevent unauthorized parties from
* gaining access to the Snowball associated with that job.
*
*
* @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
*/
java.util.concurrent.Future getJobUnlockCodeAsync(
GetJobUnlockCodeRequest getJobUnlockCodeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about the Snowball service limit for your account,
* and also the number of Snowballs your account has in use.
*
*
* Note that the default service limit for the number of Snowballs that you
* can have at one time is 1. If you want to increase your service limit,
* contact AWS Support.
*
*
* @param getSnowballUsageRequest
* @return A Java Future containing the result of the GetSnowballUsage
* operation returned by the service.
* @sample AmazonSnowballAsync.GetSnowballUsage
*/
java.util.concurrent.Future getSnowballUsageAsync(
GetSnowballUsageRequest getSnowballUsageRequest);
/**
*
* Returns information about the Snowball service limit for your account,
* and also the number of Snowballs your account has in use.
*
*
* Note that the default service limit for the number of Snowballs that you
* can have at one time is 1. If you want to increase your service limit,
* contact AWS Support.
*
*
* @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
*/
java.util.concurrent.Future getSnowballUsageAsync(
GetSnowballUsageRequest getSnowballUsageRequest,
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
*/
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
*/
java.util.concurrent.Future listJobsAsync(
ListJobsRequest listJobsRequest,
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
*/
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
*/
java.util.concurrent.Future updateJobAsync(
UpdateJobRequest updateJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}