AWS SDK for C++
0.14.3
AWS SDK for C++
|
#include <SnowballClient.h>
Public Types | |
typedef Aws::Client::AWSJsonClient | BASECLASS |
![]() | |
typedef AWSClient | BASECLASS |
This is a test of the welcome page front matter.
Definition at line 133 of file SnowballClient.h.
Definition at line 136 of file SnowballClient.h.
Aws::Snowball::SnowballClient::SnowballClient | ( | const Client::ClientConfiguration & | clientConfiguration = Client::ClientConfiguration() | ) |
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.
Aws::Snowball::SnowballClient::SnowballClient | ( | const Auth::AWSCredentials & | credentials, |
const Client::ClientConfiguration & | clientConfiguration = Client::ClientConfiguration() |
||
) |
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.
Aws::Snowball::SnowballClient::SnowballClient | ( | const std::shared_ptr< Auth::AWSCredentialsProvider > & | credentialsProvider, |
const Client::ClientConfiguration & | clientConfiguration = Client::ClientConfiguration() |
||
) |
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
|
virtual |
|
virtual |
Cancels the specified job. Note that you can only cancel a job before its JobState
value changes to PreparingAppliance
. Requesting the ListJobs
or DescribeJob
action will return a job's JobState
as part of the response element data returned.
|
virtual |
Cancels the specified job. Note that you can only cancel a job before its JobState
value changes to PreparingAppliance
. Requesting the ListJobs
or DescribeJob
action will return a job's JobState
as part of the response element data returned.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Cancels the specified job. Note that you can only cancel a job before its JobState
value changes to PreparingAppliance
. Requesting the ListJobs
or DescribeJob
action will return a job's JobState
as part of the response element data returned.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Creates an address for a Snowball to be shipped to.
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.
|
virtual |
Creates an address for a Snowball to be shipped to.
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.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Creates an address for a Snowball to be shipped to.
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.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
|
virtual |
Creates a job to import or export data between Amazon S3 and your on-premises data center. Note that your AWS account must have the right trust policies and permissions in place to create a job for Snowball. For more information, see api-reference-policies.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Creates a job to import or export data between Amazon S3 and your on-premises data center. Note that your AWS account must have the right trust policies and permissions in place to create a job for Snowball. For more information, see api-reference-policies.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Takes an AddressId
and returns specific details about that address in the form of an Address
object.
|
virtual |
Takes an AddressId
and returns specific details about that address in the form of an Address
object.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Takes an AddressId
and returns specific details about that address in the form of an Address
object.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
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.
|
virtual |
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.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
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.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Returns information about a specific job including shipping information, job status, and other important metadata.
|
virtual |
Returns information about a specific job including shipping information, job status, and other important metadata.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Returns information about a specific job including shipping information, job status, and other important metadata.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId
value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest
action.
The manifest is an encrypted file that you can download after your job enters the WithCustomer
status. The manifest is decrypted by using the UnlockCode
code value, when you pass both values to the 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 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 Snowball associated with that job.
Note that the credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
|
virtual |
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId
value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest
action.
The manifest is an encrypted file that you can download after your job enters the WithCustomer
status. The manifest is decrypted by using the UnlockCode
code value, when you pass both values to the 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 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 Snowball associated with that job.
Note that the credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId
value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest
action.
The manifest is an encrypted file that you can download after your job enters the WithCustomer
status. The manifest is decrypted by using the UnlockCode
code value, when you pass both values to the 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 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 Snowball associated with that job.
Note that the credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Returns the UnlockCode
code value for the specified job. A particular UnlockCode
value can be accessed for up to 90 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 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 UnlockCode
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.
|
virtual |
Returns the UnlockCode
code value for the specified job. A particular UnlockCode
value can be accessed for up to 90 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 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 UnlockCode
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.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Returns the UnlockCode
code value for the specified job. A particular UnlockCode
value can be accessed for up to 90 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 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 UnlockCode
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.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
|
virtual |
Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
Note that 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 Support.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
Note that 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 Support.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
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.
|
virtual |
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.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
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.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
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.
|
virtual |
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.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
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.
returns a future to the operation so that it can be executed in parallel to other requests.