@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSnowballAsyncClient extends AmazonSnowballClient implements AmazonSnowballAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonSnowballAsyncClient()
Deprecated.
|
AmazonSnowballAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonSnowballAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonSnowballAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonSnowballAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AmazonSnowballAsyncClientBuilder |
asyncBuilder() |
Future<CancelClusterResult> |
cancelClusterAsync(CancelClusterRequest request)
Cancels a cluster job.
|
Future<CancelClusterResult> |
cancelClusterAsync(CancelClusterRequest request,
AsyncHandler<CancelClusterRequest,CancelClusterResult> asyncHandler)
Cancels a cluster job.
|
Future<CancelJobResult> |
cancelJobAsync(CancelJobRequest request)
Cancels the specified job.
|
Future<CancelJobResult> |
cancelJobAsync(CancelJobRequest request,
AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
Cancels the specified job.
|
Future<CreateAddressResult> |
createAddressAsync(CreateAddressRequest request)
Creates an address for a Snowball to be shipped to.
|
Future<CreateAddressResult> |
createAddressAsync(CreateAddressRequest request,
AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler)
Creates an address for a Snowball to be shipped to.
|
Future<CreateClusterResult> |
createClusterAsync(CreateClusterRequest request)
Creates an empty cluster.
|
Future<CreateClusterResult> |
createClusterAsync(CreateClusterRequest request,
AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)
Creates an empty cluster.
|
Future<CreateJobResult> |
createJobAsync(CreateJobRequest request)
Creates a job to the other job attributes are inherited from the cluster.
|
Future<CreateJobResult> |
createJobAsync(CreateJobRequest request,
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 request)
Takes an
AddressId and returns specific details about that address in the form of an
Address object. |
Future<DescribeAddressResult> |
describeAddressAsync(DescribeAddressRequest request,
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 request)
Returns a specified number of
ADDRESS objects. |
Future<DescribeAddressesResult> |
describeAddressesAsync(DescribeAddressesRequest request,
AsyncHandler<DescribeAddressesRequest,DescribeAddressesResult> asyncHandler)
Returns a specified number of
ADDRESS objects. |
Future<DescribeClusterResult> |
describeClusterAsync(DescribeClusterRequest request)
Returns information about a specific cluster including shipping information, cluster status, and other important
metadata.
|
Future<DescribeClusterResult> |
describeClusterAsync(DescribeClusterRequest request,
AsyncHandler<DescribeClusterRequest,DescribeClusterResult> asyncHandler)
Returns information about a specific cluster including shipping information, cluster status, and other important
metadata.
|
Future<DescribeJobResult> |
describeJobAsync(DescribeJobRequest request)
Returns information about a specific job including shipping information, job status, and other important
metadata.
|
Future<DescribeJobResult> |
describeJobAsync(DescribeJobRequest request,
AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)
Returns information about a specific job including shipping information, job status, and other important
metadata.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetJobManifestResult> |
getJobManifestAsync(GetJobManifestRequest request)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId value. |
Future<GetJobManifestResult> |
getJobManifestAsync(GetJobManifestRequest request,
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 request)
Returns the
UnlockCode code value for the specified job. |
Future<GetJobUnlockCodeResult> |
getJobUnlockCodeAsync(GetJobUnlockCodeRequest request,
AsyncHandler<GetJobUnlockCodeRequest,GetJobUnlockCodeResult> asyncHandler)
Returns the
UnlockCode code value for the specified job. |
Future<GetSnowballUsageResult> |
getSnowballUsageAsync(GetSnowballUsageRequest request)
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 request,
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 request)
Returns an array of
JobListEntry objects of the specified length. |
Future<ListClusterJobsResult> |
listClusterJobsAsync(ListClusterJobsRequest request,
AsyncHandler<ListClusterJobsRequest,ListClusterJobsResult> asyncHandler)
Returns an array of
JobListEntry objects of the specified length. |
Future<ListClustersResult> |
listClustersAsync(ListClustersRequest request)
Returns an array of
ClusterListEntry objects of the specified length. |
Future<ListClustersResult> |
listClustersAsync(ListClustersRequest request,
AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)
Returns an array of
ClusterListEntry objects of the specified length. |
Future<ListJobsResult> |
listJobsAsync(ListJobsRequest request)
Returns an array of
JobListEntry objects of the specified length. |
Future<ListJobsResult> |
listJobsAsync(ListJobsRequest request,
AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
Returns an array of
JobListEntry objects of the specified length. |
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<UpdateClusterResult> |
updateClusterAsync(UpdateClusterRequest request)
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 request,
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 request)
While a job's
JobState value is New , you can update some of the information associated
with a job. |
Future<UpdateJobResult> |
updateJobAsync(UpdateJobRequest request,
AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler)
While a job's
JobState value is New , you can update some of the information associated
with a job. |
builder, cancelCluster, cancelJob, createAddress, createCluster, createJob, describeAddress, describeAddresses, describeCluster, describeJob, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, listClusterJobs, listClusters, listJobs, updateCluster, updateJob
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
cancelCluster, cancelJob, createAddress, createCluster, createJob, describeAddress, describeAddresses, describeCluster, describeJob, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, listClusterJobs, listClusters, listJobs, setEndpoint, setRegion, updateCluster, updateJob
@Deprecated public AmazonSnowballAsyncClient()
AmazonSnowballAsyncClientBuilder.defaultClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonSnowballAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy
settings, retry counts, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AmazonSnowballAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AmazonSnowballAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonSnowballAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.public static AmazonSnowballAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelClusterResult> cancelClusterAsync(CancelClusterRequest request)
AmazonSnowballAsync
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.
cancelClusterAsync
in interface AmazonSnowballAsync
public Future<CancelClusterResult> cancelClusterAsync(CancelClusterRequest request, AsyncHandler<CancelClusterRequest,CancelClusterResult> asyncHandler)
AmazonSnowballAsync
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.
cancelClusterAsync
in interface AmazonSnowballAsync
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.public Future<CancelJobResult> cancelJobAsync(CancelJobRequest request)
AmazonSnowballAsync
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.
cancelJobAsync
in interface AmazonSnowballAsync
public Future<CancelJobResult> cancelJobAsync(CancelJobRequest request, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
AmazonSnowballAsync
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.
cancelJobAsync
in interface AmazonSnowballAsync
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.public Future<CreateAddressResult> createAddressAsync(CreateAddressRequest request)
AmazonSnowballAsync
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.
createAddressAsync
in interface AmazonSnowballAsync
public Future<CreateAddressResult> createAddressAsync(CreateAddressRequest request, AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler)
AmazonSnowballAsync
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.
createAddressAsync
in interface AmazonSnowballAsync
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.public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request)
AmazonSnowballAsync
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.
createClusterAsync
in interface AmazonSnowballAsync
public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)
AmazonSnowballAsync
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.
createClusterAsync
in interface AmazonSnowballAsync
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.public Future<CreateJobResult> createJobAsync(CreateJobRequest request)
AmazonSnowballAsync
Creates a job to the other job attributes are inherited from the cluster.
createJobAsync
in interface AmazonSnowballAsync
public Future<CreateJobResult> createJobAsync(CreateJobRequest request, AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
AmazonSnowballAsync
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.
createJobAsync
in interface AmazonSnowballAsync
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.public Future<DescribeAddressResult> describeAddressAsync(DescribeAddressRequest request)
AmazonSnowballAsync
Takes an AddressId
and returns specific details about that address in the form of an
Address
object.
describeAddressAsync
in interface AmazonSnowballAsync
public Future<DescribeAddressResult> describeAddressAsync(DescribeAddressRequest request, AsyncHandler<DescribeAddressRequest,DescribeAddressResult> asyncHandler)
AmazonSnowballAsync
Takes an AddressId
and returns specific details about that address in the form of an
Address
object.
describeAddressAsync
in interface AmazonSnowballAsync
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.public Future<DescribeAddressesResult> describeAddressesAsync(DescribeAddressesRequest request)
AmazonSnowballAsync
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.
describeAddressesAsync
in interface AmazonSnowballAsync
public Future<DescribeAddressesResult> describeAddressesAsync(DescribeAddressesRequest request, AsyncHandler<DescribeAddressesRequest,DescribeAddressesResult> asyncHandler)
AmazonSnowballAsync
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.
describeAddressesAsync
in interface AmazonSnowballAsync
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.public Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest request)
AmazonSnowballAsync
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
describeClusterAsync
in interface AmazonSnowballAsync
public Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest request, AsyncHandler<DescribeClusterRequest,DescribeClusterResult> asyncHandler)
AmazonSnowballAsync
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
describeClusterAsync
in interface AmazonSnowballAsync
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.public Future<DescribeJobResult> describeJobAsync(DescribeJobRequest request)
AmazonSnowballAsync
Returns information about a specific job including shipping information, job status, and other important metadata.
describeJobAsync
in interface AmazonSnowballAsync
public Future<DescribeJobResult> describeJobAsync(DescribeJobRequest request, AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)
AmazonSnowballAsync
Returns information about a specific job including shipping information, job status, and other important metadata.
describeJobAsync
in interface AmazonSnowballAsync
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.public Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest request)
AmazonSnowballAsync
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.
getJobManifestAsync
in interface AmazonSnowballAsync
public Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest request, AsyncHandler<GetJobManifestRequest,GetJobManifestResult> asyncHandler)
AmazonSnowballAsync
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.
getJobManifestAsync
in interface AmazonSnowballAsync
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.public Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(GetJobUnlockCodeRequest request)
AmazonSnowballAsync
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.
getJobUnlockCodeAsync
in interface AmazonSnowballAsync
public Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(GetJobUnlockCodeRequest request, AsyncHandler<GetJobUnlockCodeRequest,GetJobUnlockCodeResult> asyncHandler)
AmazonSnowballAsync
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.
getJobUnlockCodeAsync
in interface AmazonSnowballAsync
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.public Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest request)
AmazonSnowballAsync
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.
getSnowballUsageAsync
in interface AmazonSnowballAsync
public Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest request, AsyncHandler<GetSnowballUsageRequest,GetSnowballUsageResult> asyncHandler)
AmazonSnowballAsync
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.
getSnowballUsageAsync
in interface AmazonSnowballAsync
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.public Future<ListClusterJobsResult> listClusterJobsAsync(ListClusterJobsRequest request)
AmazonSnowballAsync
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.
listClusterJobsAsync
in interface AmazonSnowballAsync
public Future<ListClusterJobsResult> listClusterJobsAsync(ListClusterJobsRequest request, AsyncHandler<ListClusterJobsRequest,ListClusterJobsResult> asyncHandler)
AmazonSnowballAsync
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.
listClusterJobsAsync
in interface AmazonSnowballAsync
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.public Future<ListClustersResult> listClustersAsync(ListClustersRequest request)
AmazonSnowballAsync
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.
listClustersAsync
in interface AmazonSnowballAsync
public Future<ListClustersResult> listClustersAsync(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)
AmazonSnowballAsync
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.
listClustersAsync
in interface AmazonSnowballAsync
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.public Future<ListJobsResult> listJobsAsync(ListJobsRequest request)
AmazonSnowballAsync
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.
listJobsAsync
in interface AmazonSnowballAsync
public Future<ListJobsResult> listJobsAsync(ListJobsRequest request, AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
AmazonSnowballAsync
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.
listJobsAsync
in interface AmazonSnowballAsync
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.public Future<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest request)
AmazonSnowballAsync
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.
updateClusterAsync
in interface AmazonSnowballAsync
public Future<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest request, AsyncHandler<UpdateClusterRequest,UpdateClusterResult> asyncHandler)
AmazonSnowballAsync
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.
updateClusterAsync
in interface AmazonSnowballAsync
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.public Future<UpdateJobResult> updateJobAsync(UpdateJobRequest request)
AmazonSnowballAsync
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.
updateJobAsync
in interface AmazonSnowballAsync
public Future<UpdateJobResult> updateJobAsync(UpdateJobRequest request, AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler)
AmazonSnowballAsync
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.
updateJobAsync
in interface AmazonSnowballAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonSnowball
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.