com.amazonaws.services.snowball

Interface AmazonSnowball

All Known Subinterfaces:

AmazonSnowballAsync

All Known Implementing Classes:

AbstractAmazonSnowball, AbstractAmazonSnowballAsync, AmazonSnowballAsyncClient, AmazonSnowballClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSnowball

Interface for accessing Amazon Snowball.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonSnowball instead.

AWS Snowball is a petabyte-scale data transport solution that uses secure devices 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 device, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelClusterResult	cancelCluster(CancelClusterRequest cancelClusterRequest) Cancels a cluster job.
CancelJobResult	cancelJob(CancelJobRequest cancelJobRequest) Cancels the specified job.
CreateAddressResult	createAddress(CreateAddressRequest createAddressRequest) Creates an address for a Snowball to be shipped to.
CreateClusterResult	createCluster(CreateClusterRequest createClusterRequest) Creates an empty cluster.
CreateJobResult	createJob(CreateJobRequest createJobRequest) Creates a job to the other job attributes are inherited from the cluster.
DescribeAddressResult	describeAddress(DescribeAddressRequest describeAddressRequest) Takes an AddressId and returns specific details about that address in the form of an Address object.
DescribeAddressesResult	describeAddresses(DescribeAddressesRequest describeAddressesRequest) Returns a specified number of ADDRESS objects.
DescribeClusterResult	describeCluster(DescribeClusterRequest describeClusterRequest) Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
DescribeJobResult	describeJob(DescribeJobRequest describeJobRequest) Returns information about a specific job including shipping information, job status, and other important metadata.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetJobManifestResult	getJobManifest(GetJobManifestRequest getJobManifestRequest) Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
GetJobUnlockCodeResult	getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest) Returns the UnlockCode code value for the specified job.
GetSnowballUsageResult	getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest) Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
GetSoftwareUpdatesResult	getSoftwareUpdates(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest) Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
ListClusterJobsResult	listClusterJobs(ListClusterJobsRequest listClusterJobsRequest) Returns an array of JobListEntry objects of the specified length.
ListClustersResult	listClusters(ListClustersRequest listClustersRequest) Returns an array of ClusterListEntry objects of the specified length.
ListCompatibleImagesResult	listCompatibleImages(ListCompatibleImagesRequest listCompatibleImagesRequest) This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snowball Edge device.
ListJobsResult	listJobs(ListJobsRequest listJobsRequest) Returns an array of JobListEntry objects of the specified length.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateClusterResult	updateCluster(UpdateClusterRequest updateClusterRequest) While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster.
UpdateJobResult	updateJob(UpdateJobRequest updateJobRequest) While a job's JobState value is New, you can update some of the information associated with a job.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("snowball.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "snowball.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "snowball.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "snowball.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "snowball.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

cancelCluster

CancelClusterResult cancelCluster(CancelClusterRequest cancelClusterRequest)

Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

Parameters:

cancelClusterRequest -

Returns:

Result of the CancelCluster operation returned by the service.

Throws:

KMSRequestFailedException - The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidJobStateException - The action can't be performed because the job's current state doesn't allow that action to be performed.

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

See Also:

AWS API Documentation

cancelJob

CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.

Parameters:

cancelJobRequest -

Returns:

Result of the CancelJob operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException - The action can't be performed because the job's current state doesn't allow that action to be performed.

KMSRequestFailedException - The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

See Also:

AWS API Documentation

createAddress

CreateAddressResult createAddress(CreateAddressRequest createAddressRequest)

Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

Parameters:

createAddressRequest -

Returns:

Result of the CreateAddress operation returned by the service.

Throws:

InvalidAddressException - The address provided was invalid. Check the address with your region's carrier, and try again.

UnsupportedAddressException - The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact AWS Support.

See Also:

AWS API Documentation

createCluster

CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

KMSRequestFailedException - The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidInputCombinationException - Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

Ec2RequestFailedException - Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.

See Also:

AWS API Documentation

createJob

CreateJobResult createJob(CreateJobRequest createJobRequest)

Creates a job to the other job attributes are inherited from the cluster.

Parameters:

createJobRequest -

Returns:

Result of the CreateJob operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

KMSRequestFailedException - The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidInputCombinationException - Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

ClusterLimitExceededException - Job creation failed. Currently, clusters support five nodes. If you have less than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five notes.

Ec2RequestFailedException - Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.

See Also:

AWS API Documentation

describeAddress

DescribeAddressResult describeAddress(DescribeAddressRequest describeAddressRequest)

Takes an AddressId and returns specific details about that address in the form of an Address object.

Parameters:

describeAddressRequest -

Returns:

Result of the DescribeAddress operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

See Also:

AWS API Documentation

describeAddresses

DescribeAddressesResult describeAddresses(DescribeAddressesRequest describeAddressesRequest)

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

Parameters:

describeAddressesRequest -

Returns:

Result of the DescribeAddresses operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

See Also:

AWS API Documentation

describeCluster

DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Parameters:

describeClusterRequest -

Returns:

Result of the DescribeCluster operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

See Also:

AWS API Documentation

describeJob

DescribeJobResult describeJob(DescribeJobRequest describeJobRequest)

Returns information about a specific job including shipping information, job status, and other important metadata.

Parameters:

describeJobRequest -

Returns:

Result of the DescribeJob operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

See Also:

AWS API Documentation

getJobManifest

GetJobManifestResult getJobManifest(GetJobManifestRequest getJobManifestRequest)

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.

Parameters:

getJobManifestRequest -

Returns:

Result of the GetJobManifest operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException - The action can't be performed because the job's current state doesn't allow that action to be performed.

See Also:

AWS API Documentation

getJobUnlockCode

GetJobUnlockCodeResult getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest)

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.

The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

Parameters:

getJobUnlockCodeRequest -

Returns:

Result of the GetJobUnlockCode operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException - The action can't be performed because the job's current state doesn't allow that action to be performed.

See Also:

AWS API Documentation

getSnowballUsage

GetSnowballUsageResult getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest)

Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.

Parameters:

getSnowballUsageRequest -

Returns:

Result of the GetSnowballUsage operation returned by the service.

See Also:

AWS API Documentation

getSoftwareUpdates

GetSoftwareUpdatesResult getSoftwareUpdates(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest)

Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.

Parameters:

getSoftwareUpdatesRequest -

Returns:

Result of the GetSoftwareUpdates operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException - The action can't be performed because the job's current state doesn't allow that action to be performed.

See Also:

AWS API Documentation

listClusterJobs

ListClusterJobsResult listClusterJobs(ListClusterJobsRequest listClusterJobsRequest)

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

Parameters:

listClusterJobsRequest -

Returns:

Result of the ListClusterJobs operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

See Also:

AWS API Documentation

listClusters

ListClustersResult listClusters(ListClustersRequest listClustersRequest)

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

Throws:

InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

See Also:

AWS API Documentation

listCompatibleImages

ListCompatibleImagesResult listCompatibleImages(ListCompatibleImagesRequest listCompatibleImagesRequest)

This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snowball Edge device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace.

Parameters:

listCompatibleImagesRequest -

Returns:

Result of the ListCompatibleImages operation returned by the service.

Throws:

InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

Ec2RequestFailedException - Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.

See Also:

AWS API Documentation

listJobs

ListJobsResult listJobs(ListJobsRequest listJobsRequest)

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

Parameters:

listJobsRequest -

Returns:

Result of the ListJobs operation returned by the service.

Throws:

InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

See Also:

AWS API Documentation

updateCluster

UpdateClusterResult updateCluster(UpdateClusterRequest updateClusterRequest)

While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

Parameters:

updateClusterRequest -

Returns:

Result of the UpdateCluster operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException - The action can't be performed because the job's current state doesn't allow that action to be performed.

KMSRequestFailedException - The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidInputCombinationException - Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

Ec2RequestFailedException - Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.

See Also:

AWS API Documentation

updateJob

UpdateJobResult updateJob(UpdateJobRequest updateJobRequest)

While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

Parameters:

updateJobRequest -

Returns:

Result of the UpdateJob operation returned by the service.

Throws:

InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException - The action can't be performed because the job's current state doesn't allow that action to be performed.

KMSRequestFailedException - The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidInputCombinationException - Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

ClusterLimitExceededException - Job creation failed. Currently, clusters support five nodes. If you have less than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five notes.

Ec2RequestFailedException - Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.