AmazonSnowballClient (AWS Java SDK for Amazon Snowball 1.12.618 API)

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

All Implemented Interfaces:

AmazonSnowball

Direct Known Subclasses:

AmazonSnowballAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonSnowballClient
extends AmazonWebServiceClient
implements AmazonSnowball
```
Client for accessing Amazon Snowball. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.snowball.AmazonSnowball
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Constructor Summary

Constructors
Constructor and Description
`AmazonSnowballClient()` Deprecated. use `AmazonSnowballClientBuilder.defaultClient()`
`AmazonSnowballClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AmazonSnowballClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AmazonSnowballClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AmazonSnowballClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 the 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 Amazon Web Services.
`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 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 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-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 request)` Returns an array of `JobListEntry` objects of the specified length.
`ListLongTermPricingResult`	`listLongTermPricing(ListLongTermPricingRequest request)` Lists all long-term pricing types.
`ListPickupLocationsResult`	`listPickupLocations(ListPickupLocationsRequest request)` A list of locations from which the customer can choose to pickup a device.
`ListServiceVersionsResult`	`listServiceVersions(ListServiceVersionsRequest request)` Lists all supported versions for Snow on-device services.
`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 shipment state changes to a different state.
`UpdateLongTermPricingResult`	`updateLongTermPricing(UpdateLongTermPricingRequest request)` Updates the long-term pricing type.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

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

Methods inherited from interface com.amazonaws.services.snowball.AmazonSnowball
setEndpoint, setRegion

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Constructor Detail
  - AmazonSnowballClient
```
@Deprecated
public AmazonSnowballClient()
```
    Deprecated. use AmazonSnowballClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on Amazon Snowball. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonSnowballClient
```
@Deprecated
public AmazonSnowballClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on Amazon Snowball. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonSnowballClient
```
@Deprecated
public AmazonSnowballClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonSnowballClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AmazonSnowballClient
```
@Deprecated
public AmazonSnowballClient(AWSCredentials awsCredentials,
                                        ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    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.).
  - AmazonSnowballClient
```
@Deprecated
public AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AmazonSnowballClient
```
@Deprecated
public AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    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.).
  - AmazonSnowballClient
```
@Deprecated
public AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration,
                                        RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    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 collector
- Method Detail
  - builder
```
public static AmazonSnowballClientBuilder builder()
```
  - cancelCluster
```
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.
    
    Specified by:
    
    cancelCluster in interface AmazonSnowball
    
    Parameters:
    
    cancelClusterRequest -
    
    Returns:
    
    Result of the CancelCluster operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - cancelJob
```
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.
    
    Specified by:
    
    cancelJob in interface AmazonSnowball
    
    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 Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
    
    See Also:
    
    AWS API Documentation
  - createAddress
```
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.
    
    Specified by:
    
    createAddress in interface AmazonSnowball
    
    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 Amazon Web Services Support.
    
    See Also:
    
    AWS API Documentation
  - createCluster
```
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.
    
    Specified by:
    
    createCluster in interface AmazonSnowball
    
    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 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.
    
    See Also:
    
    AWS API Documentation
  - createJob
```
public CreateJobResult createJob(CreateJobRequest request)
```
    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
    Specified by:
    
    createJob in interface AmazonSnowball
    
    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 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.
    
    See Also:
    
    AWS API Documentation
  - createLongTermPricing
```
public CreateLongTermPricingResult createLongTermPricing(CreateLongTermPricingRequest request)
```
    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.
    
    Specified by:
    
    createLongTermPricing in interface AmazonSnowball
    
    Parameters:
    
    createLongTermPricingRequest -
    
    Returns:
    
    Result of the CreateLongTermPricing 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
  - createReturnShippingLabel
```
public CreateReturnShippingLabelResult createReturnShippingLabel(CreateReturnShippingLabelRequest request)
```
    Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
    
    Specified by:
    
    createReturnShippingLabel in interface AmazonSnowball
    
    Parameters:
    
    createReturnShippingLabelRequest -
    
    Returns:
    
    Result of the CreateReturnShippingLabel 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.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeAddress
```
public DescribeAddressResult describeAddress(DescribeAddressRequest request)
```
    Takes an AddressId and returns specific details about that address in the form of an Address object.
    
    Specified by:
    
    describeAddress in interface AmazonSnowball
    
    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
```
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.
    
    Specified by:
    
    describeAddresses in interface AmazonSnowball
    
    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
```
public DescribeClusterResult describeCluster(DescribeClusterRequest request)
```
    Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
    
    Specified by:
    
    describeCluster in interface AmazonSnowball
    
    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
```
public DescribeJobResult describeJob(DescribeJobRequest request)
```
    Returns information about a specific job including shipping information, job status, and other important metadata.
    
    Specified by:
    
    describeJob in interface AmazonSnowball
    
    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
  - describeReturnShippingLabel
```
public DescribeReturnShippingLabelResult describeReturnShippingLabel(DescribeReturnShippingLabelRequest request)
```
    Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
    
    Specified by:
    
    describeReturnShippingLabel in interface AmazonSnowball
    
    Parameters:
    
    describeReturnShippingLabelRequest -
    
    Returns:
    
    Result of the DescribeReturnShippingLabel 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.
    
    ConflictException - You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
    
    See Also:
    
    AWS API Documentation
  - getJobManifest
```
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. 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.
    
    Specified by:
    
    getJobManifest in interface AmazonSnowball
    
    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
```
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. 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.
    
    Specified by:
    
    getJobUnlockCode in interface AmazonSnowball
    
    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
```
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 Amazon Web Services Support.
    
    Specified by:
    
    getSnowballUsage in interface AmazonSnowball
    
    Parameters:
    
    getSnowballUsageRequest -
    
    Returns:
    
    Result of the GetSnowballUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSoftwareUpdates
```
public GetSoftwareUpdatesResult getSoftwareUpdates(GetSoftwareUpdatesRequest request)
```
    Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
    
    Specified by:
    
    getSoftwareUpdates in interface AmazonSnowball
    
    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
```
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.
    
    Specified by:
    
    listClusterJobs in interface AmazonSnowball
    
    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
```
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.
    
    Specified by:
    
    listClusters in interface AmazonSnowball
    
    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
```
public ListCompatibleImagesResult listCompatibleImages(ListCompatibleImagesRequest request)
```
    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.
    
    Specified by:
    
    listCompatibleImages in interface AmazonSnowball
    
    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 user lacks the necessary Amazon EC2 permissions to perform the attempted action.
    
    See Also:
    
    AWS API Documentation
  - listJobs
```
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.
    
    Specified by:
    
    listJobs in interface AmazonSnowball
    
    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
  - listLongTermPricing
```
public ListLongTermPricingResult listLongTermPricing(ListLongTermPricingRequest request)
```
    Lists all long-term pricing types.
    
    Specified by:
    
    listLongTermPricing in interface AmazonSnowball
    
    Parameters:
    
    listLongTermPricingRequest -
    
    Returns:
    
    Result of the ListLongTermPricing 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
  - listPickupLocations
```
public ListPickupLocationsResult listPickupLocations(ListPickupLocationsRequest request)
```
    A list of locations from which the customer can choose to pickup a device.
    
    Specified by:
    
    listPickupLocations in interface AmazonSnowball
    
    Parameters:
    
    listPickupLocationsRequest -
    
    Returns:
    
    Result of the ListPickupLocations 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
  - listServiceVersions
```
public ListServiceVersionsResult listServiceVersions(ListServiceVersionsRequest request)
```
    Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.
    
    Specified by:
    
    listServiceVersions in interface AmazonSnowball
    
    Parameters:
    
    listServiceVersionsRequest -
    
    Returns:
    
    Result of the ListServiceVersions 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.
    
    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
  - updateCluster
```
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.
    
    Specified by:
    
    updateCluster in interface AmazonSnowball
    
    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 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.
    
    See Also:
    
    AWS API Documentation
  - updateJob
```
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.
    
    Specified by:
    
    updateJob in interface AmazonSnowball
    
    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 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.
    
    See Also:
    
    AWS API Documentation
  - updateJobShipmentState
```
public UpdateJobShipmentStateResult updateJobShipmentState(UpdateJobShipmentStateRequest request)
```
    Updates the state when a shipment state changes to a different state.
    
    Specified by:
    
    updateJobShipmentState in interface AmazonSnowball
    
    Parameters:
    
    updateJobShipmentStateRequest -
    
    Returns:
    
    Result of the UpdateJobShipmentState 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
  - updateLongTermPricing
```
public UpdateLongTermPricingResult updateLongTermPricing(UpdateLongTermPricingRequest request)
```
    Updates the long-term pricing type.
    
    Specified by:
    
    updateLongTermPricing in interface AmazonSnowball
    
    Parameters:
    
    updateLongTermPricingRequest -
    
    Returns:
    
    Result of the UpdateLongTermPricing 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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonSnowball
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonSnowball
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonSnowballClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

Constructor Detail

AmazonSnowballClient

AmazonSnowballClient

AmazonSnowballClient

AmazonSnowballClient

AmazonSnowballClient

AmazonSnowballClient

AmazonSnowballClient

Method Detail

builder

cancelCluster

cancelJob

createAddress

createCluster

createJob

createLongTermPricing

createReturnShippingLabel

describeAddress

describeAddresses

describeCluster

describeJob

describeReturnShippingLabel

getJobManifest

getJobUnlockCode

getSnowballUsage

getSoftwareUpdates

listClusterJobs

listClusters

listCompatibleImages

listJobs

listLongTermPricing

listPickupLocations

listServiceVersions

updateCluster

updateJob

updateJobShipmentState

updateLongTermPricing

getCachedResponseMetadata

shutdown