@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.
AWS Snowball is a petabyte-scale data transport solution that uses secure appliances to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball appliance, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. 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 Snowball to be shipped to.
|
Future<CreateAddressResult> |
createAddressAsync(CreateAddressRequest createAddressRequest,
AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler)
Creates an address for a Snowball 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 the other job attributes are inherited from the cluster.
|
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<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<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 Snowball service limit for your account, and also the number of Snowballs your
account has in use.
|
Future<GetSnowballUsageResult> |
getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest,
AsyncHandler<GetSnowballUsageRequest,GetSnowballUsageResult> asyncHandler)
Returns information about the Snowball service limit for your account, and also the number of Snowballs your
account has in use.
|
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<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<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. |
cancelCluster, cancelJob, createAddress, createCluster, createJob, describeAddress, describeAddresses, describeCluster, describeJob, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, listClusterJobs, listClusters, listJobs, setEndpoint, setRegion, shutdown, updateCluster, updateJobFuture<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 will
return 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 will
return 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 Snowball 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 Snowball 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 the other job attributes are inherited from the cluster.
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 AWS account must
have the right trust policies and permissions in place to create a job for Snowball. 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.
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<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<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. 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.
The credentials of a given job, including its manifest file and unlock code, expire 90 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. 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.
The credentials of a given job, including its manifest file and unlock code, expire 90 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 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.
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 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.
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 Snowball service limit for your account, and also the number of Snowballs your account has in use.
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.
getSnowballUsageRequest - Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest, AsyncHandler<GetSnowballUsageRequest,GetSnowballUsageResult> asyncHandler)
Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
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.
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<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<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<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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.