SnowballClient Class

Member Function Documentation

SnowballClient::SnowballClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a SnowballClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

SnowballClient::SnowballClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads SnowballClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CancelClusterResponse *SnowballClient::cancelCluster(const CancelClusterRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an CancelClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels a cluster job. You can only cancel a cluster job while it's in the <code>AwaitingQuorum</code> status. You'll have at least an hour after creating a cluster job to cancel

[slot] CancelJobResponse *SnowballClient::cancelJob(const CancelJobRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an CancelJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels the specified job. You can only cancel a job before its <code>JobState</code> value changes to <code>PreparingAppliance</code>. Requesting the <code>ListJobs</code> or <code>DescribeJob</code> action will return a job's <code>JobState</code> as part of the response element data

[slot] CreateAddressResponse *SnowballClient::createAddress(const CreateAddressRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an CreateAddressResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an address for a Snowball 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

[slot] CreateClusterResponse *SnowballClient::createCluster(const CreateClusterRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an CreateClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an empty cluster. Each cluster supports five nodes. You use the <a>CreateJob</a> action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been

[slot] CreateJobResponse *SnowballClient::createJob(const CreateJobRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an CreateJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 Snowball. If you're creating a job for a node in a cluster, you only need to provide the <code>clusterId</code> value; the other job attributes are inherited from the cluster.

[slot] DescribeAddressResponse *SnowballClient::describeAddress(const DescribeAddressRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an DescribeAddressResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Takes an <code>AddressId</code> and returns specific details about that address in the form of an <code>Address</code>

[slot] DescribeAddressesResponse *SnowballClient::describeAddresses(const DescribeAddressesRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an DescribeAddressesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a specified number of <code>ADDRESS</code> 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

[slot] DescribeClusterResponse *SnowballClient::describeCluster(const DescribeClusterRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an DescribeClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a specific cluster including shipping information, cluster status, and other important

[slot] DescribeJobResponse *SnowballClient::describeJob(const DescribeJobRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an DescribeJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a specific job including shipping information, job status, and other important metadata.

[slot] GetJobManifestResponse *SnowballClient::getJobManifest(const GetJobManifestRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an GetJobManifestResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified <code>JobId</code> 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 <code>GetJobManifest</code>

action>

The manifest is an encrypted file that you can download after your job enters the <code>WithCustomer</code> status. The manifest is decrypted by using the <code>UnlockCode</code> code value, when you pass both values to the Snowball 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 <code>UnlockCode</code> value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that

job>

The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is

[slot] GetJobUnlockCodeResponse *SnowballClient::getJobUnlockCode(const GetJobUnlockCodeRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an GetJobUnlockCodeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the <code>UnlockCode</code> code value for the specified job. A particular <code>UnlockCode</code> value can be accessed for up to 90 days after the associated job has been

created>

The <code>UnlockCode</code> 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 Snowball 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 <code>UnlockCode</code> in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that

[slot] GetSnowballUsageResponse *SnowballClient::getSnowballUsage(const GetSnowballUsageRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an GetSnowballUsageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in

use>

The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS

[slot] ListClusterJobsResponse *SnowballClient::listClusterJobs(const ListClusterJobsRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an ListClusterJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns an array of <code>JobListEntry</code> objects of the specified length. Each <code>JobListEntry</code> object is for a job in the specified cluster and contains a job's state, a job's ID, and other

[slot] ListClustersResponse *SnowballClient::listClusters(const ListClustersRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an ListClustersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns an array of <code>ClusterListEntry</code> objects of the specified length. Each <code>ClusterListEntry</code> object contains a cluster's state, a cluster's ID, and other important status

[slot] ListJobsResponse *SnowballClient::listJobs(const ListJobsRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an ListJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns an array of <code>JobListEntry</code> objects of the specified length. Each <code>JobListEntry</code> 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

[slot] UpdateClusterResponse *SnowballClient::updateCluster(const UpdateClusterRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an UpdateClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

While a cluster's <code>ClusterState</code> value is in the <code>AwaitingQuorum</code> 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

[slot] UpdateJobResponse *SnowballClient::updateJob(const UpdateJobRequest &request)

Sends request to the SnowballClient service, and returns a pointer to an UpdateJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

While a job's <code>JobState</code> value is <code>New</code>, 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