@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSnowballClient extends AmazonWebServiceClient implements AmazonSnowball
AWS Snow Family 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 Snow commands described here provide access to the same functionality that is available in the AWS Snow Family Management Console, which enables you to create and manage jobs for a Snow device. To transfer data locally with a Snow device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or AWS OpsHub for Snow Family. For more information, see the User Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonSnowballClient()
Deprecated.
|
AmazonSnowballClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonSnowballClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonSnowballClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonSnowballClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AmazonSnowballClientBuilder |
builder() |
CancelClusterResult |
cancelCluster(CancelClusterRequest request)
Cancels a cluster job.
|
CancelJobResult |
cancelJob(CancelJobRequest request)
Cancels the specified job.
|
CreateAddressResult |
createAddress(CreateAddressRequest request)
Creates an address for a Snow device to be shipped to.
|
CreateClusterResult |
createCluster(CreateClusterRequest request)
Creates an empty cluster.
|
CreateJobResult |
createJob(CreateJobRequest request)
Creates a job to import or export data between Amazon S3 and your on-premises data center.
|
CreateLongTermPricingResult |
createLongTermPricing(CreateLongTermPricingRequest request)
Creates a job with long term usage option for a device.
|
CreateReturnShippingLabelResult |
createReturnShippingLabel(CreateReturnShippingLabelRequest request)
Creates a shipping label that will be used to return the Snow device to AWS.
|
DescribeAddressResult |
describeAddress(DescribeAddressRequest request)
Takes an
AddressId and returns specific details about that address in the form of an
Address object. |
DescribeAddressesResult |
describeAddresses(DescribeAddressesRequest request)
Returns a specified number of
ADDRESS objects. |
DescribeClusterResult |
describeCluster(DescribeClusterRequest request)
Returns information about a specific cluster including shipping information, cluster status, and other important
metadata.
|
DescribeJobResult |
describeJob(DescribeJobRequest request)
Returns information about a specific job including shipping information, job status, and other important
metadata.
|
DescribeReturnShippingLabelResult |
describeReturnShippingLabel(DescribeReturnShippingLabelRequest request)
Information on the shipping label of a Snow device that is being returned to AWS.
|
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 request)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId value. |
GetJobUnlockCodeResult |
getJobUnlockCode(GetJobUnlockCodeRequest request)
Returns the
UnlockCode code value for the specified job. |
GetSnowballUsageResult |
getSnowballUsage(GetSnowballUsageRequest request)
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 request)
Returns an Amazon S3 presigned URL for an update file associated with a specified
JobId. |
ListClusterJobsResult |
listClusterJobs(ListClusterJobsRequest request)
Returns an array of
JobListEntry objects of the specified length. |
ListClustersResult |
listClusters(ListClustersRequest request)
Returns an array of
ClusterListEntry objects of the specified length. |
ListCompatibleImagesResult |
listCompatibleImages(ListCompatibleImagesRequest request)
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 Snow device.
|
ListJobsResult |
listJobs(ListJobsRequest request)
Returns an array of
JobListEntry objects of the specified length. |
ListLongTermPricingResult |
listLongTermPricing(ListLongTermPricingRequest request)
Lists all long term pricing types.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
UpdateClusterResult |
updateCluster(UpdateClusterRequest request)
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 request)
While a job's
JobState value is New, you can update some of the information associated
with a job. |
UpdateJobShipmentStateResult |
updateJobShipmentState(UpdateJobShipmentStateRequest request)
Updates the state when a the shipment states changes to a different state.
|
UpdateLongTermPricingResult |
updateLongTermPricing(UpdateLongTermPricingRequest request)
Updates the long term pricing type.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AmazonSnowballClient()
AmazonSnowballClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonSnowballClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonSnowballClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonSnowballClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonSnowballClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy
settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonSnowballClientBuilder builder()
public CancelClusterResult cancelCluster(CancelClusterRequest request)
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.
cancelCluster in interface AmazonSnowballcancelClusterRequest - 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.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build();
CancelClusterRequest request = new CancelClusterRequest().withClusterId("CID123e4567-e89b-12d3-a456-426655440000");
CancelClusterResult response = client.cancelCluster(request);public CancelJobResult cancelJob(CancelJobRequest request)
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.
cancelJob in interface AmazonSnowballcancelJobRequest - 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.AmazonSnowball client = AmazonSnowballClientBuilder.standard().build();
CancelJobRequest request = new CancelJobRequest().withJobId("JID123e4567-e89b-12d3-a456-426655440000");
CancelJobResult response = client.cancelJob(request);public CreateAddressResult createAddress(CreateAddressRequest request)
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.
createAddress in interface AmazonSnowballcreateAddressRequest - 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.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);public CreateClusterResult createCluster(CreateClusterRequest request)
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.
createCluster in interface AmazonSnowballcreateClusterRequest - 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 or 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.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);public CreateJobResult createJob(CreateJobRequest request)
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must
have the right trust policies and permissions in place to create a job for 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 AWS Region. For more information about region availability, see AWS Regional Services.
AWS Snow Family device types and their capacities.
Snow Family device type: SNC1_SSD
Capacity: T14
Description: Snowcone
Snow Family 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
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore AWS Regions.
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore AWS Regions.
createJob in interface AmazonSnowballcreateJobRequest - 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 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 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.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);public CreateLongTermPricingResult createLongTermPricing(CreateLongTermPricingRequest request)
Creates a job with long term usage option for a device. The long term usage is a one year or three year long term pricing type for the device. You are billed upfront and AWS give discounts for long term pricing. For detailed information see XXXXXXXX
createLongTermPricing in interface AmazonSnowballcreateLongTermPricingRequest - InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try
again.public CreateReturnShippingLabelResult createReturnShippingLabel(CreateReturnShippingLabelRequest request)
Creates a shipping label that will be used to return the Snow device to AWS.
createReturnShippingLabel in interface AmazonSnowballcreateReturnShippingLabelRequest - 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.public DescribeAddressResult describeAddress(DescribeAddressRequest request)
Takes an AddressId and returns specific details about that address in the form of an
Address object.
describeAddress in interface AmazonSnowballdescribeAddressRequest - 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);public DescribeAddressesResult describeAddresses(DescribeAddressesRequest request)
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.
describeAddresses in interface AmazonSnowballdescribeAddressesRequest - 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);
public DescribeClusterResult describeCluster(DescribeClusterRequest request)
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
describeCluster in interface AmazonSnowballdescribeClusterRequest - 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);public DescribeJobResult describeJob(DescribeJobRequest request)
Returns information about a specific job including shipping information, job status, and other important metadata.
describeJob in interface AmazonSnowballdescribeJobRequest - 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);public DescribeReturnShippingLabelResult describeReturnShippingLabel(DescribeReturnShippingLabelRequest request)
Information on the shipping label of a Snow device that is being returned to AWS.
describeReturnShippingLabel in interface AmazonSnowballdescribeReturnShippingLabelRequest - 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.public GetJobManifestResult getJobManifest(GetJobManifestRequest request)
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 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.
getJobManifest in interface AmazonSnowballgetJobManifestRequest - 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);public GetJobUnlockCodeResult getJobUnlockCode(GetJobUnlockCodeRequest request)
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.
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.
getJobUnlockCode in interface AmazonSnowballgetJobUnlockCodeRequest - 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);public GetSnowballUsageResult getSnowballUsage(GetSnowballUsageRequest request)
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 AWS Support.
getSnowballUsage in interface AmazonSnowballgetSnowballUsageRequest - AmazonSnowball client = AmazonSnowballClientBuilder.standard().build(); GetSnowballUsageRequest request = new GetSnowballUsageRequest(); GetSnowballUsageResult response = client.getSnowballUsage(request);
public GetSoftwareUpdatesResult getSoftwareUpdates(GetSoftwareUpdatesRequest request)
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
getSoftwareUpdates in interface AmazonSnowballgetSoftwareUpdatesRequest - 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.public ListClusterJobsResult listClusterJobs(ListClusterJobsRequest request)
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.
listClusterJobs in interface AmazonSnowballlistClusterJobsRequest - 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);public ListClustersResult listClusters(ListClustersRequest request)
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.
listClusters in interface AmazonSnowballlistClustersRequest - 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);
public ListCompatibleImagesResult listCompatibleImages(ListCompatibleImagesRequest request)
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 Snow 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.
listCompatibleImages in interface AmazonSnowballlistCompatibleImagesRequest - 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.public ListJobsResult listJobs(ListJobsRequest request)
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.
listJobs in interface AmazonSnowballlistJobsRequest - 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);
public ListLongTermPricingResult listLongTermPricing(ListLongTermPricingRequest request)
Lists all long term pricing types.
listLongTermPricing in interface AmazonSnowballlistLongTermPricingRequest - 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.public UpdateClusterResult updateCluster(UpdateClusterRequest request)
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.
updateCluster in interface AmazonSnowballupdateClusterRequest - 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 or 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.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);public UpdateJobResult updateJob(UpdateJobRequest request)
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.
updateJob in interface AmazonSnowballupdateJobRequest - 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 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 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.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);public UpdateJobShipmentStateResult updateJobShipmentState(UpdateJobShipmentStateRequest request)
Updates the state when a the shipment states changes to a different state.
updateJobShipmentState in interface AmazonSnowballupdateJobShipmentStateRequest - 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.public UpdateLongTermPricingResult updateLongTermPricing(UpdateLongTermPricingRequest request)
Updates the long term pricing type.
updateLongTermPricing in interface AmazonSnowballupdateLongTermPricingRequest - InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try
again.public 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 the request.
getCachedResponseMetadata in interface AmazonSnowballrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonSnowballshutdown in class AmazonWebServiceClient