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

#include <JobMetadata.h>

Public Member Functions

 JobMetadata ()
 
 JobMetadata (Aws::Utils::Json::JsonView jsonValue)
 
JobMetadataoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
JobMetadataWithJobId (const Aws::String &value)
 
JobMetadataWithJobId (Aws::String &&value)
 
JobMetadataWithJobId (const char *value)
 
const JobStateGetJobState () const
 
bool JobStateHasBeenSet () const
 
void SetJobState (const JobState &value)
 
void SetJobState (JobState &&value)
 
JobMetadataWithJobState (const JobState &value)
 
JobMetadataWithJobState (JobState &&value)
 
const JobTypeGetJobType () const
 
bool JobTypeHasBeenSet () const
 
void SetJobType (const JobType &value)
 
void SetJobType (JobType &&value)
 
JobMetadataWithJobType (const JobType &value)
 
JobMetadataWithJobType (JobType &&value)
 
const SnowballTypeGetSnowballType () const
 
bool SnowballTypeHasBeenSet () const
 
void SetSnowballType (const SnowballType &value)
 
void SetSnowballType (SnowballType &&value)
 
JobMetadataWithSnowballType (const SnowballType &value)
 
JobMetadataWithSnowballType (SnowballType &&value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
JobMetadataWithCreationDate (const Aws::Utils::DateTime &value)
 
JobMetadataWithCreationDate (Aws::Utils::DateTime &&value)
 
const JobResourceGetResources () const
 
bool ResourcesHasBeenSet () const
 
void SetResources (const JobResource &value)
 
void SetResources (JobResource &&value)
 
JobMetadataWithResources (const JobResource &value)
 
JobMetadataWithResources (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)
 
JobMetadataWithDescription (const Aws::String &value)
 
JobMetadataWithDescription (Aws::String &&value)
 
JobMetadataWithDescription (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)
 
JobMetadataWithKmsKeyARN (const Aws::String &value)
 
JobMetadataWithKmsKeyARN (Aws::String &&value)
 
JobMetadataWithKmsKeyARN (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)
 
JobMetadataWithRoleARN (const Aws::String &value)
 
JobMetadataWithRoleARN (Aws::String &&value)
 
JobMetadataWithRoleARN (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)
 
JobMetadataWithAddressId (const Aws::String &value)
 
JobMetadataWithAddressId (Aws::String &&value)
 
JobMetadataWithAddressId (const char *value)
 
const ShippingDetailsGetShippingDetails () const
 
bool ShippingDetailsHasBeenSet () const
 
void SetShippingDetails (const ShippingDetails &value)
 
void SetShippingDetails (ShippingDetails &&value)
 
JobMetadataWithShippingDetails (const ShippingDetails &value)
 
JobMetadataWithShippingDetails (ShippingDetails &&value)
 
const SnowballCapacityGetSnowballCapacityPreference () const
 
bool SnowballCapacityPreferenceHasBeenSet () const
 
void SetSnowballCapacityPreference (const SnowballCapacity &value)
 
void SetSnowballCapacityPreference (SnowballCapacity &&value)
 
JobMetadataWithSnowballCapacityPreference (const SnowballCapacity &value)
 
JobMetadataWithSnowballCapacityPreference (SnowballCapacity &&value)
 
const NotificationGetNotification () const
 
bool NotificationHasBeenSet () const
 
void SetNotification (const Notification &value)
 
void SetNotification (Notification &&value)
 
JobMetadataWithNotification (const Notification &value)
 
JobMetadataWithNotification (Notification &&value)
 
const DataTransferGetDataTransferProgress () const
 
bool DataTransferProgressHasBeenSet () const
 
void SetDataTransferProgress (const DataTransfer &value)
 
void SetDataTransferProgress (DataTransfer &&value)
 
JobMetadataWithDataTransferProgress (const DataTransfer &value)
 
JobMetadataWithDataTransferProgress (DataTransfer &&value)
 
const JobLogsGetJobLogInfo () const
 
bool JobLogInfoHasBeenSet () const
 
void SetJobLogInfo (const JobLogs &value)
 
void SetJobLogInfo (JobLogs &&value)
 
JobMetadataWithJobLogInfo (const JobLogs &value)
 
JobMetadataWithJobLogInfo (JobLogs &&value)
 
const Aws::StringGetClusterId () const
 
bool ClusterIdHasBeenSet () const
 
void SetClusterId (const Aws::String &value)
 
void SetClusterId (Aws::String &&value)
 
void SetClusterId (const char *value)
 
JobMetadataWithClusterId (const Aws::String &value)
 
JobMetadataWithClusterId (Aws::String &&value)
 
JobMetadataWithClusterId (const char *value)
 
const Aws::StringGetForwardingAddressId () const
 
bool ForwardingAddressIdHasBeenSet () const
 
void SetForwardingAddressId (const Aws::String &value)
 
void SetForwardingAddressId (Aws::String &&value)
 
void SetForwardingAddressId (const char *value)
 
JobMetadataWithForwardingAddressId (const Aws::String &value)
 
JobMetadataWithForwardingAddressId (Aws::String &&value)
 
JobMetadataWithForwardingAddressId (const char *value)
 
const TaxDocumentsGetTaxDocuments () const
 
bool TaxDocumentsHasBeenSet () const
 
void SetTaxDocuments (const TaxDocuments &value)
 
void SetTaxDocuments (TaxDocuments &&value)
 
JobMetadataWithTaxDocuments (const TaxDocuments &value)
 
JobMetadataWithTaxDocuments (TaxDocuments &&value)
 
const DeviceConfigurationGetDeviceConfiguration () const
 
bool DeviceConfigurationHasBeenSet () const
 
void SetDeviceConfiguration (const DeviceConfiguration &value)
 
void SetDeviceConfiguration (DeviceConfiguration &&value)
 
JobMetadataWithDeviceConfiguration (const DeviceConfiguration &value)
 
JobMetadataWithDeviceConfiguration (DeviceConfiguration &&value)
 

Detailed Description

Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the DescribeJob action.

See Also:

AWS API Reference

Definition at line 46 of file JobMetadata.h.

Constructor & Destructor Documentation

◆ JobMetadata() [1/2]

Aws::Snowball::Model::JobMetadata::JobMetadata ( )

◆ JobMetadata() [2/2]

Aws::Snowball::Model::JobMetadata::JobMetadata ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddressIdHasBeenSet()

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

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

Definition at line 442 of file JobMetadata.h.

◆ ClusterIdHasBeenSet()

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

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Definition at line 712 of file JobMetadata.h.

◆ CreationDateHasBeenSet()

bool Aws::Snowball::Model::JobMetadata::CreationDateHasBeenSet ( ) const
inline

The creation date for this job.

Definition at line 205 of file JobMetadata.h.

◆ DataTransferProgressHasBeenSet()

bool Aws::Snowball::Model::JobMetadata::DataTransferProgressHasBeenSet ( ) const
inline

A value that defines the real-time status of a Snow device's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

Definition at line 618 of file JobMetadata.h.

◆ DescriptionHasBeenSet()

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

The description of the job, provided at job creation.

Definition at line 279 of file JobMetadata.h.

◆ DeviceConfigurationHasBeenSet()

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

Definition at line 841 of file JobMetadata.h.

◆ ForwardingAddressIdHasBeenSet()

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

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Definition at line 761 of file JobMetadata.h.

◆ GetAddressId()

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

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

Definition at line 437 of file JobMetadata.h.

◆ GetClusterId()

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

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Definition at line 706 of file JobMetadata.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::Snowball::Model::JobMetadata::GetCreationDate ( ) const
inline

The creation date for this job.

Definition at line 200 of file JobMetadata.h.

◆ GetDataTransferProgress()

const DataTransfer& Aws::Snowball::Model::JobMetadata::GetDataTransferProgress ( ) const
inline

A value that defines the real-time status of a Snow device's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

Definition at line 610 of file JobMetadata.h.

◆ GetDescription()

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

The description of the job, provided at job creation.

Definition at line 274 of file JobMetadata.h.

◆ GetDeviceConfiguration()

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

Definition at line 838 of file JobMetadata.h.

◆ GetForwardingAddressId()

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

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Definition at line 755 of file JobMetadata.h.

◆ GetJobId()

const Aws::String& Aws::Snowball::Model::JobMetadata::GetJobId ( ) const
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 59 of file JobMetadata.h.

◆ GetJobLogInfo()

const JobLogs& Aws::Snowball::Model::JobMetadata::GetJobLogInfo ( ) const
inline

Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.

Definition at line 659 of file JobMetadata.h.

◆ GetJobState()

const JobState& Aws::Snowball::Model::JobMetadata::GetJobState ( ) const
inline

The current status of the jobs.

Definition at line 107 of file JobMetadata.h.

◆ GetJobType()

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

The type of job.

Definition at line 138 of file JobMetadata.h.

◆ GetKmsKeyARN()

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

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Definition at line 318 of file JobMetadata.h.

◆ GetNotification()

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

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

Definition at line 561 of file JobMetadata.h.

◆ GetResources()

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

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

Definition at line 233 of file JobMetadata.h.

◆ GetRoleARN()

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

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 382 of file JobMetadata.h.

◆ GetShippingDetails()

const ShippingDetails& Aws::Snowball::Model::JobMetadata::GetShippingDetails ( ) const
inline

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

Definition at line 479 of file JobMetadata.h.

◆ GetSnowballCapacityPreference()

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

The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

Definition at line 517 of file JobMetadata.h.

◆ GetSnowballType()

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

The type of device used with this job.

Definition at line 169 of file JobMetadata.h.

◆ GetTaxDocuments()

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

The metadata associated with the tax documents required in your AWS Region.

Definition at line 804 of file JobMetadata.h.

◆ JobIdHasBeenSet()

bool Aws::Snowball::Model::JobMetadata::JobIdHasBeenSet ( ) const
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 65 of file JobMetadata.h.

◆ JobLogInfoHasBeenSet()

bool Aws::Snowball::Model::JobMetadata::JobLogInfoHasBeenSet ( ) const
inline

Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.

Definition at line 667 of file JobMetadata.h.

◆ JobStateHasBeenSet()

bool Aws::Snowball::Model::JobMetadata::JobStateHasBeenSet ( ) const
inline

The current status of the jobs.

Definition at line 112 of file JobMetadata.h.

◆ JobTypeHasBeenSet()

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

The type of job.

Definition at line 143 of file JobMetadata.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Snowball::Model::JobMetadata::Jsonize ( ) const

◆ KmsKeyARNHasBeenSet()

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

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Definition at line 326 of file JobMetadata.h.

◆ NotificationHasBeenSet()

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

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

Definition at line 569 of file JobMetadata.h.

◆ operator=()

JobMetadata& Aws::Snowball::Model::JobMetadata::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ResourcesHasBeenSet()

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

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

Definition at line 240 of file JobMetadata.h.

◆ RoleARNHasBeenSet()

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

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 389 of file JobMetadata.h.

◆ SetAddressId() [1/3]

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

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

Definition at line 447 of file JobMetadata.h.

◆ SetAddressId() [2/3]

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

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

Definition at line 452 of file JobMetadata.h.

◆ SetAddressId() [3/3]

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

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

Definition at line 457 of file JobMetadata.h.

◆ SetClusterId() [1/3]

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

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Definition at line 718 of file JobMetadata.h.

◆ SetClusterId() [2/3]

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

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Definition at line 724 of file JobMetadata.h.

◆ SetClusterId() [3/3]

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

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Definition at line 730 of file JobMetadata.h.

◆ SetCreationDate() [1/2]

void Aws::Snowball::Model::JobMetadata::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The creation date for this job.

Definition at line 210 of file JobMetadata.h.

◆ SetCreationDate() [2/2]

void Aws::Snowball::Model::JobMetadata::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The creation date for this job.

Definition at line 215 of file JobMetadata.h.

◆ SetDataTransferProgress() [1/2]

void Aws::Snowball::Model::JobMetadata::SetDataTransferProgress ( const DataTransfer value)
inline

A value that defines the real-time status of a Snow device's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

Definition at line 626 of file JobMetadata.h.

◆ SetDataTransferProgress() [2/2]

void Aws::Snowball::Model::JobMetadata::SetDataTransferProgress ( DataTransfer &&  value)
inline

A value that defines the real-time status of a Snow device's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

Definition at line 634 of file JobMetadata.h.

◆ SetDescription() [1/3]

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

The description of the job, provided at job creation.

Definition at line 284 of file JobMetadata.h.

◆ SetDescription() [2/3]

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

The description of the job, provided at job creation.

Definition at line 289 of file JobMetadata.h.

◆ SetDescription() [3/3]

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

The description of the job, provided at job creation.

Definition at line 294 of file JobMetadata.h.

◆ SetDeviceConfiguration() [1/2]

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

Definition at line 844 of file JobMetadata.h.

◆ SetDeviceConfiguration() [2/2]

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

Definition at line 847 of file JobMetadata.h.

◆ SetForwardingAddressId() [1/3]

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

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Definition at line 767 of file JobMetadata.h.

◆ SetForwardingAddressId() [2/3]

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

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Definition at line 773 of file JobMetadata.h.

◆ SetForwardingAddressId() [3/3]

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

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Definition at line 779 of file JobMetadata.h.

◆ SetJobId() [1/3]

void Aws::Snowball::Model::JobMetadata::SetJobId ( const Aws::String value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 71 of file JobMetadata.h.

◆ SetJobId() [2/3]

void Aws::Snowball::Model::JobMetadata::SetJobId ( Aws::String &&  value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 77 of file JobMetadata.h.

◆ SetJobId() [3/3]

void Aws::Snowball::Model::JobMetadata::SetJobId ( const char *  value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 83 of file JobMetadata.h.

◆ SetJobLogInfo() [1/2]

void Aws::Snowball::Model::JobMetadata::SetJobLogInfo ( const JobLogs value)
inline

Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.

Definition at line 675 of file JobMetadata.h.

◆ SetJobLogInfo() [2/2]

void Aws::Snowball::Model::JobMetadata::SetJobLogInfo ( JobLogs &&  value)
inline

Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.

Definition at line 683 of file JobMetadata.h.

◆ SetJobState() [1/2]

void Aws::Snowball::Model::JobMetadata::SetJobState ( const JobState value)
inline

The current status of the jobs.

Definition at line 117 of file JobMetadata.h.

◆ SetJobState() [2/2]

void Aws::Snowball::Model::JobMetadata::SetJobState ( JobState &&  value)
inline

The current status of the jobs.

Definition at line 122 of file JobMetadata.h.

◆ SetJobType() [1/2]

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

The type of job.

Definition at line 148 of file JobMetadata.h.

◆ SetJobType() [2/2]

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

The type of job.

Definition at line 153 of file JobMetadata.h.

◆ SetKmsKeyARN() [1/3]

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

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Definition at line 334 of file JobMetadata.h.

◆ SetKmsKeyARN() [2/3]

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

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Definition at line 342 of file JobMetadata.h.

◆ SetKmsKeyARN() [3/3]

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

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Definition at line 350 of file JobMetadata.h.

◆ SetNotification() [1/2]

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

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

Definition at line 577 of file JobMetadata.h.

◆ SetNotification() [2/2]

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

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

Definition at line 585 of file JobMetadata.h.

◆ SetResources() [1/2]

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

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

Definition at line 247 of file JobMetadata.h.

◆ SetResources() [2/2]

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

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

Definition at line 254 of file JobMetadata.h.

◆ SetRoleARN() [1/3]

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

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 396 of file JobMetadata.h.

◆ SetRoleARN() [2/3]

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

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 403 of file JobMetadata.h.

◆ SetRoleARN() [3/3]

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

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 410 of file JobMetadata.h.

◆ SetShippingDetails() [1/2]

void Aws::Snowball::Model::JobMetadata::SetShippingDetails ( const ShippingDetails value)
inline

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

Definition at line 491 of file JobMetadata.h.

◆ SetShippingDetails() [2/2]

void Aws::Snowball::Model::JobMetadata::SetShippingDetails ( ShippingDetails &&  value)
inline

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

Definition at line 497 of file JobMetadata.h.

◆ SetSnowballCapacityPreference() [1/2]

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

The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

Definition at line 531 of file JobMetadata.h.

◆ SetSnowballCapacityPreference() [2/2]

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

The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

Definition at line 538 of file JobMetadata.h.

◆ SetSnowballType() [1/2]

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

The type of device used with this job.

Definition at line 179 of file JobMetadata.h.

◆ SetSnowballType() [2/2]

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

The type of device used with this job.

Definition at line 184 of file JobMetadata.h.

◆ SetTaxDocuments() [1/2]

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

The metadata associated with the tax documents required in your AWS Region.

Definition at line 816 of file JobMetadata.h.

◆ SetTaxDocuments() [2/2]

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

The metadata associated with the tax documents required in your AWS Region.

Definition at line 822 of file JobMetadata.h.

◆ ShippingDetailsHasBeenSet()

bool Aws::Snowball::Model::JobMetadata::ShippingDetailsHasBeenSet ( ) const
inline

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

Definition at line 485 of file JobMetadata.h.

◆ SnowballCapacityPreferenceHasBeenSet()

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

The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

Definition at line 524 of file JobMetadata.h.

◆ SnowballTypeHasBeenSet()

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

The type of device used with this job.

Definition at line 174 of file JobMetadata.h.

◆ TaxDocumentsHasBeenSet()

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

The metadata associated with the tax documents required in your AWS Region.

Definition at line 810 of file JobMetadata.h.

◆ WithAddressId() [1/3]

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

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

Definition at line 462 of file JobMetadata.h.

◆ WithAddressId() [2/3]

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

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

Definition at line 467 of file JobMetadata.h.

◆ WithAddressId() [3/3]

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

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

Definition at line 472 of file JobMetadata.h.

◆ WithClusterId() [1/3]

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

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Definition at line 736 of file JobMetadata.h.

◆ WithClusterId() [2/3]

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

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Definition at line 742 of file JobMetadata.h.

◆ WithClusterId() [3/3]

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

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Definition at line 748 of file JobMetadata.h.

◆ WithCreationDate() [1/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The creation date for this job.

Definition at line 220 of file JobMetadata.h.

◆ WithCreationDate() [2/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The creation date for this job.

Definition at line 225 of file JobMetadata.h.

◆ WithDataTransferProgress() [1/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithDataTransferProgress ( const DataTransfer value)
inline

A value that defines the real-time status of a Snow device's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

Definition at line 642 of file JobMetadata.h.

◆ WithDataTransferProgress() [2/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithDataTransferProgress ( DataTransfer &&  value)
inline

A value that defines the real-time status of a Snow device's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

Definition at line 650 of file JobMetadata.h.

◆ WithDescription() [1/3]

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

The description of the job, provided at job creation.

Definition at line 299 of file JobMetadata.h.

◆ WithDescription() [2/3]

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

The description of the job, provided at job creation.

Definition at line 304 of file JobMetadata.h.

◆ WithDescription() [3/3]

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

The description of the job, provided at job creation.

Definition at line 309 of file JobMetadata.h.

◆ WithDeviceConfiguration() [1/2]

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

Definition at line 850 of file JobMetadata.h.

◆ WithDeviceConfiguration() [2/2]

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

Definition at line 853 of file JobMetadata.h.

◆ WithForwardingAddressId() [1/3]

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

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Definition at line 785 of file JobMetadata.h.

◆ WithForwardingAddressId() [2/3]

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

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Definition at line 791 of file JobMetadata.h.

◆ WithForwardingAddressId() [3/3]

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

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Definition at line 797 of file JobMetadata.h.

◆ WithJobId() [1/3]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithJobId ( const Aws::String value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 89 of file JobMetadata.h.

◆ WithJobId() [2/3]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithJobId ( Aws::String &&  value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 95 of file JobMetadata.h.

◆ WithJobId() [3/3]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithJobId ( const char *  value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 101 of file JobMetadata.h.

◆ WithJobLogInfo() [1/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithJobLogInfo ( const JobLogs value)
inline

Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.

Definition at line 691 of file JobMetadata.h.

◆ WithJobLogInfo() [2/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithJobLogInfo ( JobLogs &&  value)
inline

Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.

Definition at line 699 of file JobMetadata.h.

◆ WithJobState() [1/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithJobState ( const JobState value)
inline

The current status of the jobs.

Definition at line 127 of file JobMetadata.h.

◆ WithJobState() [2/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithJobState ( JobState &&  value)
inline

The current status of the jobs.

Definition at line 132 of file JobMetadata.h.

◆ WithJobType() [1/2]

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

The type of job.

Definition at line 158 of file JobMetadata.h.

◆ WithJobType() [2/2]

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

The type of job.

Definition at line 163 of file JobMetadata.h.

◆ WithKmsKeyARN() [1/3]

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

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Definition at line 358 of file JobMetadata.h.

◆ WithKmsKeyARN() [2/3]

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

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Definition at line 366 of file JobMetadata.h.

◆ WithKmsKeyARN() [3/3]

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

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Definition at line 374 of file JobMetadata.h.

◆ WithNotification() [1/2]

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

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

Definition at line 593 of file JobMetadata.h.

◆ WithNotification() [2/2]

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

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

Definition at line 601 of file JobMetadata.h.

◆ WithResources() [1/2]

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

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

Definition at line 261 of file JobMetadata.h.

◆ WithResources() [2/2]

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

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

Definition at line 268 of file JobMetadata.h.

◆ WithRoleARN() [1/3]

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

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 417 of file JobMetadata.h.

◆ WithRoleARN() [2/3]

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

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 424 of file JobMetadata.h.

◆ WithRoleARN() [3/3]

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

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 431 of file JobMetadata.h.

◆ WithShippingDetails() [1/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithShippingDetails ( const ShippingDetails value)
inline

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

Definition at line 503 of file JobMetadata.h.

◆ WithShippingDetails() [2/2]

JobMetadata& Aws::Snowball::Model::JobMetadata::WithShippingDetails ( ShippingDetails &&  value)
inline

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

Definition at line 509 of file JobMetadata.h.

◆ WithSnowballCapacityPreference() [1/2]

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

The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

Definition at line 545 of file JobMetadata.h.

◆ WithSnowballCapacityPreference() [2/2]

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

The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

Definition at line 552 of file JobMetadata.h.

◆ WithSnowballType() [1/2]

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

The type of device used with this job.

Definition at line 189 of file JobMetadata.h.

◆ WithSnowballType() [2/2]

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

The type of device used with this job.

Definition at line 194 of file JobMetadata.h.

◆ WithTaxDocuments() [1/2]

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

The metadata associated with the tax documents required in your AWS Region.

Definition at line 828 of file JobMetadata.h.

◆ WithTaxDocuments() [2/2]

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

The metadata associated with the tax documents required in your AWS Region.

Definition at line 834 of file JobMetadata.h.


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