@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonSnowball extends Object implements AmazonSnowball
AmazonSnowball. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
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 |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("snowball.us-east-1.amazonaws.com/").
|
void |
setRegion(Region region)
An alternative to
AmazonSnowball.setEndpoint(String), sets the regional endpoint for this client's
service calls. |
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.
|
public void setEndpoint(String endpoint)
AmazonSnowball
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.
setEndpoint in interface AmazonSnowballendpoint - 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.public void setRegion(Region region)
AmazonSnowballAmazonSnowball.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.
setRegion in interface AmazonSnowballregion - 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)public CancelClusterResult cancelCluster(CancelClusterRequest request)
AmazonSnowball
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 AmazonSnowballpublic CancelJobResult cancelJob(CancelJobRequest request)
AmazonSnowball
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 AmazonSnowballpublic CreateAddressResult createAddress(CreateAddressRequest request)
AmazonSnowballCreates 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 AmazonSnowballpublic CreateClusterResult createCluster(CreateClusterRequest request)
AmazonSnowballCreates 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 AmazonSnowballpublic CreateJobResult createJob(CreateJobRequest request)
AmazonSnowball
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
createJob in interface AmazonSnowballpublic CreateLongTermPricingResult createLongTermPricing(CreateLongTermPricingRequest request)
AmazonSnowballCreates 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.
createLongTermPricing in interface AmazonSnowballpublic CreateReturnShippingLabelResult createReturnShippingLabel(CreateReturnShippingLabelRequest request)
AmazonSnowballCreates a shipping label that will be used to return the Snow device to Amazon Web Services.
createReturnShippingLabel in interface AmazonSnowballpublic DescribeAddressResult describeAddress(DescribeAddressRequest request)
AmazonSnowball
Takes an AddressId and returns specific details about that address in the form of an
Address object.
describeAddress in interface AmazonSnowballpublic DescribeAddressesResult describeAddresses(DescribeAddressesRequest request)
AmazonSnowball
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 AmazonSnowballpublic DescribeClusterResult describeCluster(DescribeClusterRequest request)
AmazonSnowballReturns information about a specific cluster including shipping information, cluster status, and other important metadata.
describeCluster in interface AmazonSnowballpublic DescribeJobResult describeJob(DescribeJobRequest request)
AmazonSnowballReturns information about a specific job including shipping information, job status, and other important metadata.
describeJob in interface AmazonSnowballpublic DescribeReturnShippingLabelResult describeReturnShippingLabel(DescribeReturnShippingLabelRequest request)
AmazonSnowballInformation on the shipping label of a Snow device that is being returned to Amazon Web Services.
describeReturnShippingLabel in interface AmazonSnowballpublic GetJobManifestResult getJobManifest(GetJobManifestRequest request)
AmazonSnowball
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.
getJobManifest in interface AmazonSnowballpublic GetJobUnlockCodeResult getJobUnlockCode(GetJobUnlockCodeRequest request)
AmazonSnowball
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.
getJobUnlockCode in interface AmazonSnowballpublic GetSnowballUsageResult getSnowballUsage(GetSnowballUsageRequest request)
AmazonSnowballReturns 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.
getSnowballUsage in interface AmazonSnowballpublic GetSoftwareUpdatesResult getSoftwareUpdates(GetSoftwareUpdatesRequest request)
AmazonSnowball
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
getSoftwareUpdates in interface AmazonSnowballpublic ListClusterJobsResult listClusterJobs(ListClusterJobsRequest request)
AmazonSnowball
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 AmazonSnowballpublic ListClustersResult listClusters(ListClustersRequest request)
AmazonSnowball
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 AmazonSnowballpublic ListCompatibleImagesResult listCompatibleImages(ListCompatibleImagesRequest request)
AmazonSnowballThis 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.
listCompatibleImages in interface AmazonSnowballpublic ListJobsResult listJobs(ListJobsRequest request)
AmazonSnowball
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 AmazonSnowballpublic ListLongTermPricingResult listLongTermPricing(ListLongTermPricingRequest request)
AmazonSnowballLists all long-term pricing types.
listLongTermPricing in interface AmazonSnowballpublic ListPickupLocationsResult listPickupLocations(ListPickupLocationsRequest request)
AmazonSnowballA list of locations from which the customer can choose to pickup a device.
listPickupLocations in interface AmazonSnowballpublic ListServiceVersionsResult listServiceVersions(ListServiceVersionsRequest request)
AmazonSnowball
Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object
containing the supported versions for a particular service.
listServiceVersions in interface AmazonSnowballpublic UpdateClusterResult updateCluster(UpdateClusterRequest request)
AmazonSnowball
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 AmazonSnowballpublic UpdateJobResult updateJob(UpdateJobRequest request)
AmazonSnowball
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 AmazonSnowballpublic UpdateJobShipmentStateResult updateJobShipmentState(UpdateJobShipmentStateRequest request)
AmazonSnowballUpdates the state when a shipment state changes to a different state.
updateJobShipmentState in interface AmazonSnowballpublic UpdateLongTermPricingResult updateLongTermPricing(UpdateLongTermPricingRequest request)
AmazonSnowballUpdates the long-term pricing type.
updateLongTermPricing in interface AmazonSnowballpublic void shutdown()
AmazonSnowballshutdown in interface AmazonSnowballpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonSnowballResponse 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.
getCachedResponseMetadata in interface AmazonSnowballrequest - The originally executed request.