AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Snowball::Model::CreateJobRequest Class Reference

#include <CreateJobRequest.h>

+ Inheritance diagram for Aws::Snowball::Model::CreateJobRequest:

Public Member Functions

 CreateJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const JobTypeGetJobType () const
 
bool JobTypeHasBeenSet () const
 
void SetJobType (const JobType &value)
 
void SetJobType (JobType &&value)
 
CreateJobRequestWithJobType (const JobType &value)
 
CreateJobRequestWithJobType (JobType &&value)
 
const JobResourceGetResources () const
 
bool ResourcesHasBeenSet () const
 
void SetResources (const JobResource &value)
 
void SetResources (JobResource &&value)
 
CreateJobRequestWithResources (const JobResource &value)
 
CreateJobRequestWithResources (JobResource &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateJobRequestWithDescription (const Aws::String &value)
 
CreateJobRequestWithDescription (Aws::String &&value)
 
CreateJobRequestWithDescription (const char *value)
 
const Aws::StringGetAddressId () const
 
bool AddressIdHasBeenSet () const
 
void SetAddressId (const Aws::String &value)
 
void SetAddressId (Aws::String &&value)
 
void SetAddressId (const char *value)
 
CreateJobRequestWithAddressId (const Aws::String &value)
 
CreateJobRequestWithAddressId (Aws::String &&value)
 
CreateJobRequestWithAddressId (const char *value)
 
const Aws::StringGetKmsKeyARN () const
 
bool KmsKeyARNHasBeenSet () const
 
void SetKmsKeyARN (const Aws::String &value)
 
void SetKmsKeyARN (Aws::String &&value)
 
void SetKmsKeyARN (const char *value)
 
CreateJobRequestWithKmsKeyARN (const Aws::String &value)
 
CreateJobRequestWithKmsKeyARN (Aws::String &&value)
 
CreateJobRequestWithKmsKeyARN (const char *value)
 
const Aws::StringGetRoleARN () const
 
bool RoleARNHasBeenSet () const
 
void SetRoleARN (const Aws::String &value)
 
void SetRoleARN (Aws::String &&value)
 
void SetRoleARN (const char *value)
 
CreateJobRequestWithRoleARN (const Aws::String &value)
 
CreateJobRequestWithRoleARN (Aws::String &&value)
 
CreateJobRequestWithRoleARN (const char *value)
 
const SnowballCapacityGetSnowballCapacityPreference () const
 
bool SnowballCapacityPreferenceHasBeenSet () const
 
void SetSnowballCapacityPreference (const SnowballCapacity &value)
 
void SetSnowballCapacityPreference (SnowballCapacity &&value)
 
CreateJobRequestWithSnowballCapacityPreference (const SnowballCapacity &value)
 
CreateJobRequestWithSnowballCapacityPreference (SnowballCapacity &&value)
 
const ShippingOptionGetShippingOption () const
 
bool ShippingOptionHasBeenSet () const
 
void SetShippingOption (const ShippingOption &value)
 
void SetShippingOption (ShippingOption &&value)
 
CreateJobRequestWithShippingOption (const ShippingOption &value)
 
CreateJobRequestWithShippingOption (ShippingOption &&value)
 
const NotificationGetNotification () const
 
bool NotificationHasBeenSet () const
 
void SetNotification (const Notification &value)
 
void SetNotification (Notification &&value)
 
CreateJobRequestWithNotification (const Notification &value)
 
CreateJobRequestWithNotification (Notification &&value)
 
const Aws::StringGetClusterId () const
 
bool ClusterIdHasBeenSet () const
 
void SetClusterId (const Aws::String &value)
 
void SetClusterId (Aws::String &&value)
 
void SetClusterId (const char *value)
 
CreateJobRequestWithClusterId (const Aws::String &value)
 
CreateJobRequestWithClusterId (Aws::String &&value)
 
CreateJobRequestWithClusterId (const char *value)
 
const SnowballTypeGetSnowballType () const
 
bool SnowballTypeHasBeenSet () const
 
void SetSnowballType (const SnowballType &value)
 
void SetSnowballType (SnowballType &&value)
 
CreateJobRequestWithSnowballType (const SnowballType &value)
 
CreateJobRequestWithSnowballType (SnowballType &&value)
 
const Aws::StringGetForwardingAddressId () const
 
bool ForwardingAddressIdHasBeenSet () const
 
void SetForwardingAddressId (const Aws::String &value)
 
void SetForwardingAddressId (Aws::String &&value)
 
void SetForwardingAddressId (const char *value)
 
CreateJobRequestWithForwardingAddressId (const Aws::String &value)
 
CreateJobRequestWithForwardingAddressId (Aws::String &&value)
 
CreateJobRequestWithForwardingAddressId (const char *value)
 
const TaxDocumentsGetTaxDocuments () const
 
bool TaxDocumentsHasBeenSet () const
 
void SetTaxDocuments (const TaxDocuments &value)
 
void SetTaxDocuments (TaxDocuments &&value)
 
CreateJobRequestWithTaxDocuments (const TaxDocuments &value)
 
CreateJobRequestWithTaxDocuments (TaxDocuments &&value)
 
const DeviceConfigurationGetDeviceConfiguration () const
 
bool DeviceConfigurationHasBeenSet () const
 
void SetDeviceConfiguration (const DeviceConfiguration &value)
 
void SetDeviceConfiguration (DeviceConfiguration &&value)
 
CreateJobRequestWithDeviceConfiguration (const DeviceConfiguration &value)
 
CreateJobRequestWithDeviceConfiguration (DeviceConfiguration &&value)
 
- Public Member Functions inherited from Aws::Snowball::SnowballRequest
virtual ~SnowballRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 29 of file CreateJobRequest.h.

Constructor & Destructor Documentation

◆ CreateJobRequest()

Aws::Snowball::Model::CreateJobRequest::CreateJobRequest ( )

Member Function Documentation

◆ AddressIdHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::AddressIdHasBeenSet ( ) const
inline

The ID for the address that you want the Snow device shipped to.

Definition at line 206 of file CreateJobRequest.h.

◆ ClusterIdHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::ClusterIdHasBeenSet ( ) const
inline

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Definition at line 552 of file CreateJobRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::DescriptionHasBeenSet ( ) const
inline

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 159 of file CreateJobRequest.h.

◆ DeviceConfigurationHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::DeviceConfigurationHasBeenSet ( ) const
inline

Defines the device configuration for an AWS Snowcone job.

Definition at line 752 of file CreateJobRequest.h.

◆ ForwardingAddressIdHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::ForwardingAddressIdHasBeenSet ( ) const
inline

The forwarding address ID for a job. This field is not supported in most regions.

Definition at line 674 of file CreateJobRequest.h.

◆ GetAddressId()

const Aws::String& Aws::Snowball::Model::CreateJobRequest::GetAddressId ( ) const
inline

The ID for the address that you want the Snow device shipped to.

Definition at line 201 of file CreateJobRequest.h.

◆ GetClusterId()

const Aws::String& Aws::Snowball::Model::CreateJobRequest::GetClusterId ( ) const
inline

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Definition at line 545 of file CreateJobRequest.h.

◆ GetDescription()

const Aws::String& Aws::Snowball::Model::CreateJobRequest::GetDescription ( ) const
inline

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 153 of file CreateJobRequest.h.

◆ GetDeviceConfiguration()

const DeviceConfiguration& Aws::Snowball::Model::CreateJobRequest::GetDeviceConfiguration ( ) const
inline

Defines the device configuration for an AWS Snowcone job.

Definition at line 747 of file CreateJobRequest.h.

◆ GetForwardingAddressId()

const Aws::String& Aws::Snowball::Model::CreateJobRequest::GetForwardingAddressId ( ) const
inline

The forwarding address ID for a job. This field is not supported in most regions.

Definition at line 668 of file CreateJobRequest.h.

◆ GetJobType()

const JobType& Aws::Snowball::Model::CreateJobRequest::GetJobType ( ) const
inline

Defines the type of job that you're creating.

Definition at line 48 of file CreateJobRequest.h.

◆ GetKmsKeyARN()

const Aws::String& Aws::Snowball::Model::CreateJobRequest::GetKmsKeyARN ( ) const
inline

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Definition at line 245 of file CreateJobRequest.h.

◆ GetNotification()

const Notification& Aws::Snowball::Model::CreateJobRequest::GetNotification ( ) const
inline

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

Definition at line 507 of file CreateJobRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Snowball::Model::CreateJobRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Snowball::SnowballRequest.

◆ GetResources()

const JobResource& Aws::Snowball::Model::CreateJobRequest::GetResources ( ) const
inline

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

Definition at line 86 of file CreateJobRequest.h.

◆ GetRoleARN()

const Aws::String& Aws::Snowball::Model::CreateJobRequest::GetRoleARN ( ) const
inline

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Definition at line 310 of file CreateJobRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Snowball::Model::CreateJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateJobRequest.h.

◆ GetShippingOption()

const ShippingOption& Aws::Snowball::Model::CreateJobRequest::GetShippingOption ( ) const
inline

The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snow devices are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

Definition at line 425 of file CreateJobRequest.h.

◆ GetSnowballCapacityPreference()

const SnowballCapacity& Aws::Snowball::Model::CreateJobRequest::GetSnowballCapacityPreference ( ) const
inline

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

Definition at line 374 of file CreateJobRequest.h.

◆ GetSnowballType()

const SnowballType& Aws::Snowball::Model::CreateJobRequest::GetSnowballType ( ) const
inline

The type of AWS Snow Family device to use for this job.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

The type of AWS Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.

Definition at line 606 of file CreateJobRequest.h.

◆ GetTaxDocuments()

const TaxDocuments& Aws::Snowball::Model::CreateJobRequest::GetTaxDocuments ( ) const
inline

The tax documents required in your AWS Region.

Definition at line 716 of file CreateJobRequest.h.

◆ JobTypeHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::JobTypeHasBeenSet ( ) const
inline

Defines the type of job that you're creating.

Definition at line 53 of file CreateJobRequest.h.

◆ KmsKeyARNHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::KmsKeyARNHasBeenSet ( ) const
inline

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Definition at line 253 of file CreateJobRequest.h.

◆ NotificationHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::NotificationHasBeenSet ( ) const
inline

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

Definition at line 513 of file CreateJobRequest.h.

◆ ResourcesHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::ResourcesHasBeenSet ( ) const
inline

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

Definition at line 98 of file CreateJobRequest.h.

◆ RoleARNHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::RoleARNHasBeenSet ( ) const
inline

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Definition at line 318 of file CreateJobRequest.h.

◆ SerializePayload()

Aws::String Aws::Snowball::Model::CreateJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAddressId() [1/3]

void Aws::Snowball::Model::CreateJobRequest::SetAddressId ( const Aws::String value)
inline

The ID for the address that you want the Snow device shipped to.

Definition at line 211 of file CreateJobRequest.h.

◆ SetAddressId() [2/3]

void Aws::Snowball::Model::CreateJobRequest::SetAddressId ( Aws::String &&  value)
inline

The ID for the address that you want the Snow device shipped to.

Definition at line 216 of file CreateJobRequest.h.

◆ SetAddressId() [3/3]

void Aws::Snowball::Model::CreateJobRequest::SetAddressId ( const char *  value)
inline

The ID for the address that you want the Snow device shipped to.

Definition at line 221 of file CreateJobRequest.h.

◆ SetClusterId() [1/3]

void Aws::Snowball::Model::CreateJobRequest::SetClusterId ( const Aws::String value)
inline

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Definition at line 559 of file CreateJobRequest.h.

◆ SetClusterId() [2/3]

void Aws::Snowball::Model::CreateJobRequest::SetClusterId ( Aws::String &&  value)
inline

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Definition at line 566 of file CreateJobRequest.h.

◆ SetClusterId() [3/3]

void Aws::Snowball::Model::CreateJobRequest::SetClusterId ( const char *  value)
inline

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Definition at line 573 of file CreateJobRequest.h.

◆ SetDescription() [1/3]

void Aws::Snowball::Model::CreateJobRequest::SetDescription ( const Aws::String value)
inline

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 165 of file CreateJobRequest.h.

◆ SetDescription() [2/3]

void Aws::Snowball::Model::CreateJobRequest::SetDescription ( Aws::String &&  value)
inline

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 171 of file CreateJobRequest.h.

◆ SetDescription() [3/3]

void Aws::Snowball::Model::CreateJobRequest::SetDescription ( const char *  value)
inline

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 177 of file CreateJobRequest.h.

◆ SetDeviceConfiguration() [1/2]

void Aws::Snowball::Model::CreateJobRequest::SetDeviceConfiguration ( const DeviceConfiguration value)
inline

Defines the device configuration for an AWS Snowcone job.

Definition at line 757 of file CreateJobRequest.h.

◆ SetDeviceConfiguration() [2/2]

void Aws::Snowball::Model::CreateJobRequest::SetDeviceConfiguration ( DeviceConfiguration &&  value)
inline

Defines the device configuration for an AWS Snowcone job.

Definition at line 762 of file CreateJobRequest.h.

◆ SetForwardingAddressId() [1/3]

void Aws::Snowball::Model::CreateJobRequest::SetForwardingAddressId ( const Aws::String value)
inline

The forwarding address ID for a job. This field is not supported in most regions.

Definition at line 680 of file CreateJobRequest.h.

◆ SetForwardingAddressId() [2/3]

void Aws::Snowball::Model::CreateJobRequest::SetForwardingAddressId ( Aws::String &&  value)
inline

The forwarding address ID for a job. This field is not supported in most regions.

Definition at line 686 of file CreateJobRequest.h.

◆ SetForwardingAddressId() [3/3]

void Aws::Snowball::Model::CreateJobRequest::SetForwardingAddressId ( const char *  value)
inline

The forwarding address ID for a job. This field is not supported in most regions.

Definition at line 692 of file CreateJobRequest.h.

◆ SetJobType() [1/2]

void Aws::Snowball::Model::CreateJobRequest::SetJobType ( const JobType value)
inline

Defines the type of job that you're creating.

Definition at line 58 of file CreateJobRequest.h.

◆ SetJobType() [2/2]

void Aws::Snowball::Model::CreateJobRequest::SetJobType ( JobType &&  value)
inline

Defines the type of job that you're creating.

Definition at line 63 of file CreateJobRequest.h.

◆ SetKmsKeyARN() [1/3]

void Aws::Snowball::Model::CreateJobRequest::SetKmsKeyARN ( const Aws::String value)
inline

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Definition at line 261 of file CreateJobRequest.h.

◆ SetKmsKeyARN() [2/3]

void Aws::Snowball::Model::CreateJobRequest::SetKmsKeyARN ( Aws::String &&  value)
inline

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Definition at line 269 of file CreateJobRequest.h.

◆ SetKmsKeyARN() [3/3]

void Aws::Snowball::Model::CreateJobRequest::SetKmsKeyARN ( const char *  value)
inline

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Definition at line 277 of file CreateJobRequest.h.

◆ SetNotification() [1/2]

void Aws::Snowball::Model::CreateJobRequest::SetNotification ( const Notification value)
inline

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

Definition at line 519 of file CreateJobRequest.h.

◆ SetNotification() [2/2]

void Aws::Snowball::Model::CreateJobRequest::SetNotification ( Notification &&  value)
inline

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

Definition at line 525 of file CreateJobRequest.h.

◆ SetResources() [1/2]

void Aws::Snowball::Model::CreateJobRequest::SetResources ( const JobResource value)
inline

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

Definition at line 110 of file CreateJobRequest.h.

◆ SetResources() [2/2]

void Aws::Snowball::Model::CreateJobRequest::SetResources ( JobResource &&  value)
inline

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

Definition at line 122 of file CreateJobRequest.h.

◆ SetRoleARN() [1/3]

void Aws::Snowball::Model::CreateJobRequest::SetRoleARN ( const Aws::String value)
inline

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Definition at line 326 of file CreateJobRequest.h.

◆ SetRoleARN() [2/3]

void Aws::Snowball::Model::CreateJobRequest::SetRoleARN ( Aws::String &&  value)
inline

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Definition at line 334 of file CreateJobRequest.h.

◆ SetRoleARN() [3/3]

void Aws::Snowball::Model::CreateJobRequest::SetRoleARN ( const char *  value)
inline

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Definition at line 342 of file CreateJobRequest.h.

◆ SetShippingOption() [1/2]

void Aws::Snowball::Model::CreateJobRequest::SetShippingOption ( const ShippingOption value)
inline

The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snow devices are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

Definition at line 455 of file CreateJobRequest.h.

◆ SetShippingOption() [2/2]

void Aws::Snowball::Model::CreateJobRequest::SetShippingOption ( ShippingOption &&  value)
inline

The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snow devices are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

Definition at line 470 of file CreateJobRequest.h.

◆ SetSnowballCapacityPreference() [1/2]

void Aws::Snowball::Model::CreateJobRequest::SetSnowballCapacityPreference ( const SnowballCapacity value)
inline

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

Definition at line 388 of file CreateJobRequest.h.

◆ SetSnowballCapacityPreference() [2/2]

void Aws::Snowball::Model::CreateJobRequest::SetSnowballCapacityPreference ( SnowballCapacity &&  value)
inline

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

Definition at line 395 of file CreateJobRequest.h.

◆ SetSnowballType() [1/2]

void Aws::Snowball::Model::CreateJobRequest::SetSnowballType ( const SnowballType value)
inline

The type of AWS Snow Family device to use for this job.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

The type of AWS Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.

Definition at line 628 of file CreateJobRequest.h.

◆ SetSnowballType() [2/2]

void Aws::Snowball::Model::CreateJobRequest::SetSnowballType ( SnowballType &&  value)
inline

The type of AWS Snow Family device to use for this job.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

The type of AWS Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.

Definition at line 639 of file CreateJobRequest.h.

◆ SetTaxDocuments() [1/2]

void Aws::Snowball::Model::CreateJobRequest::SetTaxDocuments ( const TaxDocuments value)
inline

The tax documents required in your AWS Region.

Definition at line 726 of file CreateJobRequest.h.

◆ SetTaxDocuments() [2/2]

void Aws::Snowball::Model::CreateJobRequest::SetTaxDocuments ( TaxDocuments &&  value)
inline

The tax documents required in your AWS Region.

Definition at line 731 of file CreateJobRequest.h.

◆ ShippingOptionHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::ShippingOptionHasBeenSet ( ) const
inline

The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snow devices are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

Definition at line 440 of file CreateJobRequest.h.

◆ SnowballCapacityPreferenceHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::SnowballCapacityPreferenceHasBeenSet ( ) const
inline

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

Definition at line 381 of file CreateJobRequest.h.

◆ SnowballTypeHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::SnowballTypeHasBeenSet ( ) const
inline

The type of AWS Snow Family device to use for this job.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

The type of AWS Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.

Definition at line 617 of file CreateJobRequest.h.

◆ TaxDocumentsHasBeenSet()

bool Aws::Snowball::Model::CreateJobRequest::TaxDocumentsHasBeenSet ( ) const
inline

The tax documents required in your AWS Region.

Definition at line 721 of file CreateJobRequest.h.

◆ WithAddressId() [1/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithAddressId ( const Aws::String value)
inline

The ID for the address that you want the Snow device shipped to.

Definition at line 226 of file CreateJobRequest.h.

◆ WithAddressId() [2/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithAddressId ( Aws::String &&  value)
inline

The ID for the address that you want the Snow device shipped to.

Definition at line 231 of file CreateJobRequest.h.

◆ WithAddressId() [3/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithAddressId ( const char *  value)
inline

The ID for the address that you want the Snow device shipped to.

Definition at line 236 of file CreateJobRequest.h.

◆ WithClusterId() [1/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithClusterId ( const Aws::String value)
inline

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Definition at line 580 of file CreateJobRequest.h.

◆ WithClusterId() [2/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithClusterId ( Aws::String &&  value)
inline

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Definition at line 587 of file CreateJobRequest.h.

◆ WithClusterId() [3/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithClusterId ( const char *  value)
inline

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Definition at line 594 of file CreateJobRequest.h.

◆ WithDescription() [1/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithDescription ( const Aws::String value)
inline

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 183 of file CreateJobRequest.h.

◆ WithDescription() [2/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithDescription ( Aws::String &&  value)
inline

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 189 of file CreateJobRequest.h.

◆ WithDescription() [3/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithDescription ( const char *  value)
inline

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 195 of file CreateJobRequest.h.

◆ WithDeviceConfiguration() [1/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithDeviceConfiguration ( const DeviceConfiguration value)
inline

Defines the device configuration for an AWS Snowcone job.

Definition at line 767 of file CreateJobRequest.h.

◆ WithDeviceConfiguration() [2/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithDeviceConfiguration ( DeviceConfiguration &&  value)
inline

Defines the device configuration for an AWS Snowcone job.

Definition at line 772 of file CreateJobRequest.h.

◆ WithForwardingAddressId() [1/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithForwardingAddressId ( const Aws::String value)
inline

The forwarding address ID for a job. This field is not supported in most regions.

Definition at line 698 of file CreateJobRequest.h.

◆ WithForwardingAddressId() [2/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithForwardingAddressId ( Aws::String &&  value)
inline

The forwarding address ID for a job. This field is not supported in most regions.

Definition at line 704 of file CreateJobRequest.h.

◆ WithForwardingAddressId() [3/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithForwardingAddressId ( const char *  value)
inline

The forwarding address ID for a job. This field is not supported in most regions.

Definition at line 710 of file CreateJobRequest.h.

◆ WithJobType() [1/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithJobType ( const JobType value)
inline

Defines the type of job that you're creating.

Definition at line 68 of file CreateJobRequest.h.

◆ WithJobType() [2/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithJobType ( JobType &&  value)
inline

Defines the type of job that you're creating.

Definition at line 73 of file CreateJobRequest.h.

◆ WithKmsKeyARN() [1/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithKmsKeyARN ( const Aws::String value)
inline

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Definition at line 285 of file CreateJobRequest.h.

◆ WithKmsKeyARN() [2/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithKmsKeyARN ( Aws::String &&  value)
inline

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Definition at line 293 of file CreateJobRequest.h.

◆ WithKmsKeyARN() [3/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithKmsKeyARN ( const char *  value)
inline

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Definition at line 301 of file CreateJobRequest.h.

◆ WithNotification() [1/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithNotification ( const Notification value)
inline

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

Definition at line 531 of file CreateJobRequest.h.

◆ WithNotification() [2/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithNotification ( Notification &&  value)
inline

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

Definition at line 537 of file CreateJobRequest.h.

◆ WithResources() [1/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithResources ( const JobResource value)
inline

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

Definition at line 134 of file CreateJobRequest.h.

◆ WithResources() [2/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithResources ( JobResource &&  value)
inline

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

Definition at line 146 of file CreateJobRequest.h.

◆ WithRoleARN() [1/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithRoleARN ( const Aws::String value)
inline

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Definition at line 350 of file CreateJobRequest.h.

◆ WithRoleARN() [2/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithRoleARN ( Aws::String &&  value)
inline

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Definition at line 358 of file CreateJobRequest.h.

◆ WithRoleARN() [3/3]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithRoleARN ( const char *  value)
inline

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Definition at line 366 of file CreateJobRequest.h.

◆ WithShippingOption() [1/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithShippingOption ( const ShippingOption value)
inline

The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snow devices are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

Definition at line 485 of file CreateJobRequest.h.

◆ WithShippingOption() [2/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithShippingOption ( ShippingOption &&  value)
inline

The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snow devices are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

Definition at line 500 of file CreateJobRequest.h.

◆ WithSnowballCapacityPreference() [1/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithSnowballCapacityPreference ( const SnowballCapacity value)
inline

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

Definition at line 402 of file CreateJobRequest.h.

◆ WithSnowballCapacityPreference() [2/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithSnowballCapacityPreference ( SnowballCapacity &&  value)
inline

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

Definition at line 409 of file CreateJobRequest.h.

◆ WithSnowballType() [1/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithSnowballType ( const SnowballType value)
inline

The type of AWS Snow Family device to use for this job.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

The type of AWS Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.

Definition at line 650 of file CreateJobRequest.h.

◆ WithSnowballType() [2/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithSnowballType ( SnowballType &&  value)
inline

The type of AWS Snow Family device to use for this job.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

The type of AWS Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.

Definition at line 661 of file CreateJobRequest.h.

◆ WithTaxDocuments() [1/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithTaxDocuments ( const TaxDocuments value)
inline

The tax documents required in your AWS Region.

Definition at line 736 of file CreateJobRequest.h.

◆ WithTaxDocuments() [2/2]

CreateJobRequest& Aws::Snowball::Model::CreateJobRequest::WithTaxDocuments ( TaxDocuments &&  value)
inline

The tax documents required in your AWS Region.

Definition at line 741 of file CreateJobRequest.h.


The documentation for this class was generated from the following file: