AmazonSnowballAsyncClient (AWS Java SDK for Amazon Snowball 1.11.30 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.snowball.AmazonSnowballClient
  - - com.amazonaws.services.snowball.AmazonSnowballAsyncClient

All Implemented Interfaces:

AmazonSnowball, AmazonSnowballAsync
```
@ThreadSafe
public class AmazonSnowballAsyncClient
extends AmazonSnowballClient
implements AmazonSnowballAsync
```
Interface for accessing Amazon Snowball asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

This is a test of the welcome page front matter.

Field Summary
- Fields inherited from class com.amazonaws.services.snowball.AmazonSnowballClient
  configFactory
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.snowball.AmazonSnowball
  ENDPOINT_PREFIX

Constructor Summary

Constructors
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.

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class com.amazonaws.services.snowball.AmazonSnowballClient
cancelJob, createAddress, createJob, describeAddress, describeAddresses, describeJob, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, listJobs, updateJob

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.snowball.AmazonSnowball
cancelJob, createAddress, createJob, describeAddress, describeAddresses, describeJob, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, listJobs, setEndpoint, setRegion, updateJob

- Constructor Detail
  - AmazonSnowballAsyncClient
```
public AmazonSnowballAsyncClient()
```
    Constructs a new asynchronous client to invoke service methods on Amazon Snowball. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    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).
    See Also:
    
    DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
  - AmazonSnowballAsyncClient
```
public AmazonSnowballAsyncClient(ClientConfiguration clientConfiguration)
```
    Constructs a new asynchronous client to invoke service methods on Amazon Snowball. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    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().
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy settings, retry counts, etc).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
  - AmazonSnowballAsyncClient
```
public AmazonSnowballAsyncClient(AWSCredentials awsCredentials)
```
    Constructs a new asynchronous client to invoke service methods on Amazon Snowball using the specified AWS account credentials.
    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).
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    See Also:
    
    Executors.newFixedThreadPool(int)
  - AmazonSnowballAsyncClient
```
public 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. Default client settings will be used.
    
    Parameters:
    
    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.
  - AmazonSnowballAsyncClient
```
public 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.
    
    Parameters:
    
    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.
  - AmazonSnowballAsyncClient
```
public AmazonSnowballAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new asynchronous client to invoke service methods on Amazon Snowball using the specified AWS account credentials provider. Default client settings will be used.
    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).
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    See Also:
    
    Executors.newFixedThreadPool(int)
  - AmazonSnowballAsyncClient
```
public 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.
    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().
    
    Parameters:
    
    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).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
  - AmazonSnowballAsyncClient
```
public 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. Default client settings will be used.
    
    Parameters:
    
    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.
  - AmazonSnowballAsyncClient
```
public 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.
    
    Parameters:
    
    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.
- Method Detail
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Returns the executor service used by this client to execute async requests.
    
    Returns:
    
    The executor service used by this client to execute async requests.
  - cancelJobAsync
```
public Future<CancelJobResult> cancelJobAsync(CancelJobRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    cancelJobAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the CancelJob operation returned by the service.
  - cancelJobAsync
```
public Future<CancelJobResult> cancelJobAsync(CancelJobRequest request,
                                              AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
```
    Description copied from interface: 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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CancelJob operation returned by the service.
  - createAddressAsync
```
public Future<CreateAddressResult> createAddressAsync(CreateAddressRequest request)
```
    Description copied from interface: AmazonSnowballAsync
    
    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.
    
    Specified by:
    
    createAddressAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the CreateAddress operation returned by the service.
  - createAddressAsync
```
public Future<CreateAddressResult> createAddressAsync(CreateAddressRequest request,
                                                      AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler)
```
    Description copied from interface: AmazonSnowballAsync
    
    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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateAddress operation returned by the service.
  - createJobAsync
```
public Future<CreateJobResult> createJobAsync(CreateJobRequest request)
```
    Description copied from interface: AmazonSnowballAsync
    
    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.
    
    Specified by:
    
    createJobAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the CreateJob operation returned by the service.
  - createJobAsync
```
public Future<CreateJobResult> createJobAsync(CreateJobRequest request,
                                              AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
```
    Description copied from interface: AmazonSnowballAsync
    
    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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateJob operation returned by the service.
  - describeAddressAsync
```
public Future<DescribeAddressResult> describeAddressAsync(DescribeAddressRequest request)
```
    Description copied from interface: AmazonSnowballAsync
    
    Takes an AddressId and returns specific details about that address in the form of an Address object.
    
    Specified by:
    
    describeAddressAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeAddress operation returned by the service.
  - describeAddressAsync
```
public Future<DescribeAddressResult> describeAddressAsync(DescribeAddressRequest request,
                                                          AsyncHandler<DescribeAddressRequest,DescribeAddressResult> asyncHandler)
```
    Description copied from interface: AmazonSnowballAsync
    
    Takes an AddressId and returns specific details about that address in the form of an Address object.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DescribeAddress operation returned by the service.
  - describeAddressesAsync
```
public Future<DescribeAddressesResult> describeAddressesAsync(DescribeAddressesRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    describeAddressesAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeAddresses operation returned by the service.
  - describeAddressesAsync
```
public Future<DescribeAddressesResult> describeAddressesAsync(DescribeAddressesRequest request,
                                                              AsyncHandler<DescribeAddressesRequest,DescribeAddressesResult> asyncHandler)
```
    Description copied from interface: 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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DescribeAddresses operation returned by the service.
  - describeJobAsync
```
public Future<DescribeJobResult> describeJobAsync(DescribeJobRequest request)
```
    Description copied from interface: AmazonSnowballAsync
    
    Returns information about a specific job including shipping information, job status, and other important metadata.
    
    Specified by:
    
    describeJobAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeJob operation returned by the service.
  - describeJobAsync
```
public Future<DescribeJobResult> describeJobAsync(DescribeJobRequest request,
                                                  AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)
```
    Description copied from interface: AmazonSnowballAsync
    
    Returns information about a specific job including shipping information, job status, and other important metadata.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DescribeJob operation returned by the service.
  - getJobManifestAsync
```
public Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    getJobManifestAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the GetJobManifest operation returned by the service.
  - getJobManifestAsync
```
public Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest request,
                                                        AsyncHandler<GetJobManifestRequest,GetJobManifestResult> asyncHandler)
```
    Description copied from interface: 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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the GetJobManifest operation returned by the service.
  - getJobUnlockCodeAsync
```
public Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(GetJobUnlockCodeRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    getJobUnlockCodeAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the GetJobUnlockCode operation returned by the service.
  - getJobUnlockCodeAsync
```
public Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(GetJobUnlockCodeRequest request,
                                                            AsyncHandler<GetJobUnlockCodeRequest,GetJobUnlockCodeResult> asyncHandler)
```
    Description copied from interface: 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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the GetJobUnlockCode operation returned by the service.
  - getSnowballUsageAsync
```
public Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest request)
```
    Description copied from interface: AmazonSnowballAsync
    
    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.
    
    Specified by:
    
    getSnowballUsageAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the GetSnowballUsage operation returned by the service.
  - getSnowballUsageAsync
```
public Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest request,
                                                            AsyncHandler<GetSnowballUsageRequest,GetSnowballUsageResult> asyncHandler)
```
    Description copied from interface: AmazonSnowballAsync
    
    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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the GetSnowballUsage operation returned by the service.
  - listJobsAsync
```
public Future<ListJobsResult> listJobsAsync(ListJobsRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    listJobsAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the ListJobs operation returned by the service.
  - listJobsAsync
```
public Future<ListJobsResult> listJobsAsync(ListJobsRequest request,
                                            AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
```
    Description copied from interface: 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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListJobs operation returned by the service.
  - updateJobAsync
```
public Future<UpdateJobResult> updateJobAsync(UpdateJobRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    updateJobAsync in interface AmazonSnowballAsync
    
    Returns:
    
    A Java Future containing the result of the UpdateJob operation returned by the service.
  - updateJobAsync
```
public Future<UpdateJobResult> updateJobAsync(UpdateJobRequest request,
                                              AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler)
```
    Description copied from interface: 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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the UpdateJob operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
    
    Specified by:
    
    shutdown in interface AmazonSnowball
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonSnowballAsyncClient

Field Summary

Fields inherited from class com.amazonaws.services.snowball.AmazonSnowballClient

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.snowball.AmazonSnowball

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.services.snowball.AmazonSnowballClient

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.snowball.AmazonSnowball

Constructor Detail

AmazonSnowballAsyncClient

AmazonSnowballAsyncClient

AmazonSnowballAsyncClient

AmazonSnowballAsyncClient

AmazonSnowballAsyncClient

AmazonSnowballAsyncClient

AmazonSnowballAsyncClient

AmazonSnowballAsyncClient

AmazonSnowballAsyncClient

Method Detail

getExecutorService

cancelJobAsync

cancelJobAsync

createAddressAsync

createAddressAsync

createJobAsync

createJobAsync

describeAddressAsync

describeAddressAsync

describeAddressesAsync

describeAddressesAsync

describeJobAsync

describeJobAsync

getJobManifestAsync

getJobManifestAsync

getJobUnlockCodeAsync

getJobUnlockCodeAsync

getSnowballUsageAsync

getSnowballUsageAsync

listJobsAsync

listJobsAsync

updateJobAsync

updateJobAsync

shutdown