@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSnowball
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonSnowball
instead.
The Amazon Web Services Snow Family provides 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 Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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 Snow device to be shipped to.
|
CreateClusterResult |
createCluster(CreateClusterRequest createClusterRequest)
Creates an empty cluster.
|
CreateJobResult |
createJob(CreateJobRequest createJobRequest)
Creates a job to import or export data between Amazon S3 and your on-premises data center.
|
CreateLongTermPricingResult |
createLongTermPricing(CreateLongTermPricingRequest createLongTermPricingRequest)
Creates a job with the long-term usage option for a device.
|
CreateReturnShippingLabelResult |
createReturnShippingLabel(CreateReturnShippingLabelRequest createReturnShippingLabelRequest)
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
|
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.
|
DescribeReturnShippingLabelResult |
describeReturnShippingLabel(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest)
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
|
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 Snow Family service limit for your account, and also the number of Snow devices
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-compatible Amazon Machine Images (AMIs) that are owned by
your Amazon Web Services accountthat would be supported for use on a Snow device.
|
ListJobsResult |
listJobs(ListJobsRequest listJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
ListLongTermPricingResult |
listLongTermPricing(ListLongTermPricingRequest listLongTermPricingRequest)
Lists all long-term pricing types.
|
ListPickupLocationsResult |
listPickupLocations(ListPickupLocationsRequest listPickupLocationsRequest)
A list of locations from which the customer can choose to pickup a device.
|
ListServiceVersionsResult |
listServiceVersions(ListServiceVersionsRequest listServiceVersionsRequest)
Lists all supported versions for Snow on-device services.
|
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. |
UpdateJobShipmentStateResult |
updateJobShipmentState(UpdateJobShipmentStateRequest updateJobShipmentStateRequest)
Updates the state when a shipment state changes to a different state.
|
UpdateLongTermPricingResult |
updateLongTermPricing(UpdateLongTermPricingRequest updateLongTermPricingRequest)
Updates the long-term pricing type.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
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.
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.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
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.
cancelClusterRequest
- KMSRequestFailedException
- The provided 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.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); CancelClusterRequest request = new CancelClusterRequest().withClusterId("CID123e4567-e89b-12d3-a456-426655440000"); CancelClusterResult response = client.cancelCluster(request);
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.
cancelJobRequest
- 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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); CancelJobRequest request = new CancelJobRequest().withJobId("JID123e4567-e89b-12d3-a456-426655440000"); CancelJobResult response = client.cancelJob(request);
CreateAddressResult createAddress(CreateAddressRequest createAddressRequest)
Creates an address for a Snow device 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. If providing an address as a JSON file through the
cli-input-json
option, include the full file path. For example,
--cli-input-json file://create-address.json
.
createAddressRequest
- 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 Amazon Web Services
Support.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); CreateAddressRequest request = new CreateAddressRequest().withAddress(new Address().withName("My Name").withCompany("My Company's Name") .withStreet1("123 Main Street").withCity("Seattle").withStateOrProvince("WA").withCountry("USA").withPostalCode("98101") .withPhoneNumber("425-555-5555")); CreateAddressResult response = client.createAddress(request);
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.
createClusterRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.KMSRequestFailedException
- The provided Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One or more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try
again.Ec2RequestFailedException
- Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); CreateClusterRequest request = new CreateClusterRequest().withJobType("LOCAL_USE") .withResources(new JobResource().withS3Resources(new S3Resource().withBucketArn("arn:aws:s3:::MyBucket").withKeyRange(new KeyRange()))) .withDescription("MyCluster").withAddressId("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b") .withKmsKeyARN("arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456") .withRoleARN("arn:aws:iam::123456789012:role/snowball-import-S3-role").withSnowballType("EDGE").withShippingOption("SECOND_DAY") .withNotification(new Notification().withJobStatesToNotify(new ArrayList()).withNotifyAll(false)); CreateClusterResult response = client.createCluster(request);
CreateJobResult createJob(CreateJobRequest createJobRequest)
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web
Services account must have the right trust policies and permissions in place to create a job for a Snow device.
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.
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
Snow Family devices and their capacities.
Device type: SNC1_SSD
Capacity: T14
Description: Snowcone
Device type: SNC1_HDD
Capacity: T8
Description: Snowcone
Device type: EDGE_S
Capacity: T98
Description: Snowball Edge Storage Optimized for data transfer only
Device type: EDGE_CG
Capacity: T42
Description: Snowball Edge Compute Optimized with GPU
Device type: EDGE_C
Capacity: T42
Description: Snowball Edge Compute Optimized without GPU
Device type: EDGE
Capacity: T100
Description: Snowball Edge Storage Optimized with EC2 Compute
This device is replaced with T98.
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
Snow Family device type: RACK_5U_C
Capacity: T13
Description: Snowblade.
Device type: V3_5S
Capacity: T240
Description: Snowball Edge Storage Optimized 210TB
createJobRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.KMSRequestFailedException
- The provided Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One or 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 fewer 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 nodes.Ec2RequestFailedException
- Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); CreateJobRequest request = new CreateJobRequest().withJobType("IMPORT") .withResources(new JobResource().withS3Resources(new S3Resource().withBucketArn("arn:aws:s3:::MyBucket").withKeyRange(new KeyRange()))) .withDescription("My Job").withAddressId("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b") .withKmsKeyARN("arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456") .withRoleARN("arn:aws:iam::123456789012:role/snowball-import-S3-role").withSnowballCapacityPreference("T80").withShippingOption("SECOND_DAY") .withNotification(new Notification().withJobStatesToNotify(new ArrayList()).withNotifyAll(false)).withSnowballType("STANDARD"); CreateJobResult response = client.createJob(request);
CreateLongTermPricingResult createLongTermPricing(CreateLongTermPricingRequest createLongTermPricingRequest)
Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.
createLongTermPricingRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.CreateReturnShippingLabelResult createReturnShippingLabel(CreateReturnShippingLabelRequest createReturnShippingLabelRequest)
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
createReturnShippingLabelRequest
- 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.InvalidInputCombinationException
- Job or cluster creation failed. One or more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try
again.ConflictException
- You get this exception when you call CreateReturnShippingLabel
more than once when other
requests are not completed.ReturnShippingLabelAlreadyExistsException
- You get this exception if you call CreateReturnShippingLabel
and a valid return shipping
label already exists. In this case, use DescribeReturnShippingLabel
to get the URL.DescribeAddressResult describeAddress(DescribeAddressRequest describeAddressRequest)
Takes an AddressId
and returns specific details about that address in the form of an
Address
object.
describeAddressRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); DescribeAddressRequest request = new DescribeAddressRequest().withAddressId("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"); DescribeAddressResult response = client.describeAddress(request);
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.
describeAddressesRequest
- 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.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); DescribeAddressesRequest request = new DescribeAddressesRequest(); DescribeAddressesResult response = client.describeAddresses(request);
DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
describeClusterRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); DescribeClusterRequest request = new DescribeClusterRequest().withClusterId("CID123e4567-e89b-12d3-a456-426655440000"); DescribeClusterResult response = client.describeCluster(request);
DescribeJobResult describeJob(DescribeJobRequest describeJobRequest)
Returns information about a specific job including shipping information, job status, and other important metadata.
describeJobRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); DescribeJobRequest request = new DescribeJobRequest().withJobId("JID123e4567-e89b-12d3-a456-426655440000"); DescribeJobResult response = client.describeJob(request);
DescribeReturnShippingLabelResult describeReturnShippingLabel(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest)
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
describeReturnShippingLabelRequest
- 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.ConflictException
- You get this exception when you call CreateReturnShippingLabel
more than once when other
requests are not completed.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. This is the only valid status for calling this API as the manifest and UnlockCode
code value
are used for securing your device and should only be used when you have the device. The manifest is decrypted by
using the UnlockCode
code value, when you pass both values to the Snow device 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 Snow device associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.
getJobManifestRequest
- 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.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); GetJobManifestRequest request = new GetJobManifestRequest().withJobId("JID123e4567-e89b-12d3-a456-426655440000"); GetJobManifestResult response = client.getJobManifest(request);
GetJobUnlockCodeResult getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest)
Returns the UnlockCode
code value for the specified job. A particular UnlockCode
value
can be accessed for up to 360 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 Snow device through the
Snowball client when the client is started for the first time. The only valid status for calling this API is
WithCustomer
as the manifest and Unlock
code values are used for securing your device
and should only be used when you have the device.
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 Snow device associated with that job.
getJobUnlockCodeRequest
- 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.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); GetJobUnlockCodeRequest request = new GetJobUnlockCodeRequest().withJobId("JID123e4567-e89b-12d3-a456-426655440000"); GetJobUnlockCodeResult response = client.getJobUnlockCode(request);
GetSnowballUsageResult getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest)
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.
The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.
getSnowballUsageRequest
- AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); GetSnowballUsageRequest request = new GetSnowballUsageRequest(); GetSnowballUsageResult response = client.getSnowballUsage(request);
GetSoftwareUpdatesResult getSoftwareUpdates(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest)
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId
.
getSoftwareUpdatesRequest
- 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.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.
listClusterJobsRequest
- 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.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); ListClusterJobsRequest request = new ListClusterJobsRequest().withClusterId("CID123e4567-e89b-12d3-a456-426655440000"); ListClusterJobsResult response = client.listClusterJobs(request);
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.
listClustersRequest
- InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); ListClustersRequest request = new ListClustersRequest(); ListClustersResult response = client.listClusters(request);
ListCompatibleImagesResult listCompatibleImages(ListCompatibleImagesRequest listCompatibleImagesRequest)
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
listCompatibleImagesRequest
- 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 user lacks the necessary Amazon EC2 permissions to perform the attempted action.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.
listJobsRequest
- InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); ListJobsRequest request = new ListJobsRequest(); ListJobsResult response = client.listJobs(request);
ListLongTermPricingResult listLongTermPricing(ListLongTermPricingRequest listLongTermPricingRequest)
Lists all long-term pricing types.
listLongTermPricingRequest
- 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.ListPickupLocationsResult listPickupLocations(ListPickupLocationsRequest listPickupLocationsRequest)
A list of locations from which the customer can choose to pickup a device.
listPickupLocationsRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.ListServiceVersionsResult listServiceVersions(ListServiceVersionsRequest listServiceVersionsRequest)
Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion
object
containing the supported versions for a particular service.
listServiceVersionsRequest
- InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.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.
updateClusterRequest
- 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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One or more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try
again.Ec2RequestFailedException
- Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); UpdateClusterRequest request = new UpdateClusterRequest().withClusterId("CID123e4567-e89b-12d3-a456-426655440000") .withDescription("Updated the address to send this to image processing - RJ").withAddressId("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"); UpdateClusterResult response = client.updateCluster(request);
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.
updateJobRequest
- 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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One or 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 fewer 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 nodes.Ec2RequestFailedException
- Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); UpdateJobRequest request = new UpdateJobRequest().withJobId("JID123e4567-e89b-12d3-a456-426655440000") .withAddressId("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b").withShippingOption("NEXT_DAY") .withDescription("Upgraded to Edge, shipped to Finance Dept, and requested faster shipping speed - TS.").withSnowballCapacityPreference("T100"); UpdateJobResult response = client.updateJob(request);
UpdateJobShipmentStateResult updateJobShipmentState(UpdateJobShipmentStateRequest updateJobShipmentStateRequest)
Updates the state when a shipment state changes to a different state.
updateJobShipmentStateRequest
- 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.UpdateLongTermPricingResult updateLongTermPricing(UpdateLongTermPricingRequest updateLongTermPricingRequest)
Updates the long-term pricing type.
updateLongTermPricingRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.