@ThreadSafe public class AmazonSnowballAsyncClient extends AmazonSnowballClient implements AmazonSnowballAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
AWS Import/Export 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_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonSnowballAsyncClient()
Constructs a new asynchronous client to invoke service methods on Amazon Snowball.
|
AmazonSnowballAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on Amazon Snowball using the specified AWS account
credentials.
|
AmazonSnowballAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon Snowball using the specified AWS account
credentials, executor service, and client configuration options.
|
AmazonSnowballAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon Snowball using the specified AWS account
credentials and executor service.
|
AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on Amazon Snowball using the specified AWS account
credentials provider.
|
AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on Amazon Snowball using the provided AWS account
credentials provider and client configuration options.
|
AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon Snowball using the specified AWS account
credentials provider, executor service, and client configuration options.
|
AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon Snowball using the specified AWS account
credentials provider and executor service.
|
AmazonSnowballAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on Amazon Snowball.
|
| Modifier and Type | Method and Description |
|---|---|
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<CreateJobResult> |
createJobAsync(CreateJobRequest request)
Creates a job to import or export data between Amazon S3 and your on-premises data center.
|
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<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<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<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. |
cancelJob, createAddress, createJob, describeAddress, describeAddresses, describeJob, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, listJobs, updateJobaddRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelJob, createAddress, createJob, describeAddress, describeAddresses, describeJob, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, listJobs, setEndpoint, setRegion, updateJobpublic AmazonSnowballAsyncClient()
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).
public AmazonSnowballAsyncClient(ClientConfiguration 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)public AmazonSnowballAsyncClient(AWSCredentials awsCredentials)
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)public AmazonSnowballAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
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.public AmazonSnowballAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
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.public AmazonSnowballAsyncClient(AWSCredentialsProvider 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)public AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration 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)public AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
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.public AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
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 ExecutorService getExecutorService()
public Future<CancelJobResult> cancelJobAsync(CancelJobRequest request)
AmazonSnowballAsync
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.
cancelJobAsync in interface AmazonSnowballAsyncpublic Future<CancelJobResult> cancelJobAsync(CancelJobRequest request, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
AmazonSnowballAsync
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.
cancelJobAsync in interface AmazonSnowballAsyncasyncHandler - 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)
AmazonSnowballAsyncCreates 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.
createAddressAsync in interface AmazonSnowballAsyncpublic Future<CreateAddressResult> createAddressAsync(CreateAddressRequest request, AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler)
AmazonSnowballAsyncCreates 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.
createAddressAsync in interface AmazonSnowballAsyncasyncHandler - 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)
AmazonSnowballAsyncCreates 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.
createJobAsync in interface AmazonSnowballAsyncpublic Future<CreateJobResult> createJobAsync(CreateJobRequest request, AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
AmazonSnowballAsyncCreates 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.
createJobAsync in interface AmazonSnowballAsyncasyncHandler - 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 AmazonSnowballAsyncpublic 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 AmazonSnowballAsyncasyncHandler - 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 AmazonSnowballAsyncpublic 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 AmazonSnowballAsyncasyncHandler - 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)
AmazonSnowballAsyncReturns information about a specific job including shipping information, job status, and other important metadata.
describeJobAsync in interface AmazonSnowballAsyncpublic Future<DescribeJobResult> describeJobAsync(DescribeJobRequest request, AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)
AmazonSnowballAsyncReturns information about a specific job including shipping information, job status, and other important metadata.
describeJobAsync in interface AmazonSnowballAsyncasyncHandler - 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.
Note that the credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
getJobManifestAsync in interface AmazonSnowballAsyncpublic 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.
Note that the credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
getJobManifestAsync in interface AmazonSnowballAsyncasyncHandler - 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 AmazonSnowballAsyncpublic 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 AmazonSnowballAsyncasyncHandler - 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)
AmazonSnowballAsyncReturns 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.
getSnowballUsageAsync in interface AmazonSnowballAsyncpublic Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest request, AsyncHandler<GetSnowballUsageRequest,GetSnowballUsageResult> asyncHandler)
AmazonSnowballAsyncReturns 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.
getSnowballUsageAsync in interface AmazonSnowballAsyncasyncHandler - 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 AmazonSnowballAsyncpublic 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 AmazonSnowballAsyncasyncHandler - 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 AmazonSnowballAsyncpublic 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 AmazonSnowballAsyncasyncHandler - 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 AmazonSnowballshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.