AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <SnowballClient.h>
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.
Definition at line 31 of file SnowballClient.h.
Definition at line 34 of file SnowballClient.h.
Definition at line 38 of file SnowballClient.h.
Definition at line 39 of file SnowballClient.h.
Aws::Snowball::SnowballClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Snowball::SnowballClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Snowball::SnowballClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
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.
nullptr
An Async wrapper for CancelCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 111 of file SnowballClient.h.
A Callable wrapper for CancelCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 102 of file SnowballClient.h.
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.
nullptr
An Async wrapper for CancelJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 140 of file SnowballClient.h.
A Callable wrapper for CancelJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 131 of file SnowballClient.h.
Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. If providing an address as a JSON file through the cli-input-json
option, include the full file path. For example, –cli-input-json file://create-address.json
.
nullptr
An Async wrapper for CreateAddress that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 171 of file SnowballClient.h.
A Callable wrapper for CreateAddress that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 162 of file SnowballClient.h.
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.
nullptr
An Async wrapper for CreateCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 199 of file SnowballClient.h.
A Callable wrapper for CreateCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 190 of file SnowballClient.h.
{}
)
const
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
Device type: STANDARD
Snow Family device type: RACK_5U_C
Capacity: T13
Description: Snowblade.
Device type: V3_5S
Capacity: T240
Description: Snowball Edge Storage Optimized 210TB
nullptr
,
{}
An Async wrapper for CreateJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 260 of file SnowballClient.h.
{}
)
const
A Callable wrapper for CreateJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 251 of file SnowballClient.h.
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.
nullptr
An Async wrapper for CreateLongTermPricing that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 288 of file SnowballClient.h.
A Callable wrapper for CreateLongTermPricing that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 279 of file SnowballClient.h.
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
nullptr
An Async wrapper for CreateReturnShippingLabel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 314 of file SnowballClient.h.
A Callable wrapper for CreateReturnShippingLabel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 305 of file SnowballClient.h.
Takes an AddressId
and returns specific details about that address in the form of an Address
object.
nullptr
An Async wrapper for DescribeAddress that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 341 of file SnowballClient.h.
A Callable wrapper for DescribeAddress that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 332 of file SnowballClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for DescribeAddresses that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 368 of file SnowballClient.h.
{}
)
const
A Callable wrapper for DescribeAddresses that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 359 of file SnowballClient.h.
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
nullptr
An Async wrapper for DescribeCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 394 of file SnowballClient.h.
A Callable wrapper for DescribeCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 385 of file SnowballClient.h.
Returns information about a specific job including shipping information, job status, and other important metadata.
nullptr
An Async wrapper for DescribeJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 420 of file SnowballClient.h.
A Callable wrapper for DescribeJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 411 of file SnowballClient.h.
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
nullptr
An Async wrapper for DescribeReturnShippingLabel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 446 of file SnowballClient.h.
A Callable wrapper for DescribeReturnShippingLabel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 437 of file SnowballClient.h.
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.
nullptr
An Async wrapper for GetJobManifest that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 487 of file SnowballClient.h.
A Callable wrapper for GetJobManifest that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 478 of file SnowballClient.h.
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.
nullptr
An Async wrapper for GetJobUnlockCode that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 525 of file SnowballClient.h.
A Callable wrapper for GetJobUnlockCode that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 516 of file SnowballClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for GetSnowballUsage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 554 of file SnowballClient.h.
{}
)
const
A Callable wrapper for GetSnowballUsage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 545 of file SnowballClient.h.
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId
.
nullptr
An Async wrapper for GetSoftwareUpdates that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 580 of file SnowballClient.h.
A Callable wrapper for GetSoftwareUpdates that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 571 of file SnowballClient.h.
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.
nullptr
An Async wrapper for ListClusterJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 608 of file SnowballClient.h.
A Callable wrapper for ListClusterJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 599 of file SnowballClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListClusters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 636 of file SnowballClient.h.
{}
)
const
A Callable wrapper for ListClusters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 627 of file SnowballClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListCompatibleImages that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 668 of file SnowballClient.h.
{}
)
const
A Callable wrapper for ListCompatibleImages that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 659 of file SnowballClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 698 of file SnowballClient.h.
{}
)
const
A Callable wrapper for ListJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 689 of file SnowballClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListLongTermPricing that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 723 of file SnowballClient.h.
{}
)
const
A Callable wrapper for ListLongTermPricing that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 714 of file SnowballClient.h.
{}
)
const
A list of locations from which the customer can choose to pickup a device.
nullptr
,
{}
An Async wrapper for ListPickupLocations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 749 of file SnowballClient.h.
{}
)
const
A Callable wrapper for ListPickupLocations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 740 of file SnowballClient.h.
Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion
object containing the supported versions for a particular service.
nullptr
An Async wrapper for ListServiceVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 776 of file SnowballClient.h.
A Callable wrapper for ListServiceVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 767 of file SnowballClient.h.
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.
nullptr
An Async wrapper for UpdateCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 805 of file SnowballClient.h.
A Callable wrapper for UpdateCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 796 of file SnowballClient.h.
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.
nullptr
An Async wrapper for UpdateJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 833 of file SnowballClient.h.
A Callable wrapper for UpdateJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 824 of file SnowballClient.h.
nullptr
An Async wrapper for UpdateJobShipmentState that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 859 of file SnowballClient.h.
A Callable wrapper for UpdateJobShipmentState that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 850 of file SnowballClient.h.
nullptr
An Async wrapper for UpdateLongTermPricing that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 884 of file SnowballClient.h.
A Callable wrapper for UpdateLongTermPricing that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 875 of file SnowballClient.h.
Definition at line 891 of file SnowballClient.h.