AWS SDK for C++  1.9.159
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::Job Class Reference

#include <Job.h>

Public Member Functions

 Job ()
 
 Job (Aws::Utils::Json::JsonView jsonValue)
 
Joboperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobArn () const
 
bool JobArnHasBeenSet () const
 
void SetJobArn (const Aws::String &value)
 
void SetJobArn (Aws::String &&value)
 
void SetJobArn (const char *value)
 
JobWithJobArn (const Aws::String &value)
 
JobWithJobArn (Aws::String &&value)
 
JobWithJobArn (const char *value)
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
JobWithJobId (const Aws::String &value)
 
JobWithJobId (Aws::String &&value)
 
JobWithJobId (const char *value)
 
const TargetSelectionGetTargetSelection () const
 
bool TargetSelectionHasBeenSet () const
 
void SetTargetSelection (const TargetSelection &value)
 
void SetTargetSelection (TargetSelection &&value)
 
JobWithTargetSelection (const TargetSelection &value)
 
JobWithTargetSelection (TargetSelection &&value)
 
const JobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobStatus &value)
 
void SetStatus (JobStatus &&value)
 
JobWithStatus (const JobStatus &value)
 
JobWithStatus (JobStatus &&value)
 
bool GetForceCanceled () const
 
bool ForceCanceledHasBeenSet () const
 
void SetForceCanceled (bool value)
 
JobWithForceCanceled (bool value)
 
const Aws::StringGetReasonCode () const
 
bool ReasonCodeHasBeenSet () const
 
void SetReasonCode (const Aws::String &value)
 
void SetReasonCode (Aws::String &&value)
 
void SetReasonCode (const char *value)
 
JobWithReasonCode (const Aws::String &value)
 
JobWithReasonCode (Aws::String &&value)
 
JobWithReasonCode (const char *value)
 
const Aws::StringGetComment () const
 
bool CommentHasBeenSet () const
 
void SetComment (const Aws::String &value)
 
void SetComment (Aws::String &&value)
 
void SetComment (const char *value)
 
JobWithComment (const Aws::String &value)
 
JobWithComment (Aws::String &&value)
 
JobWithComment (const char *value)
 
const Aws::Vector< Aws::String > & GetTargets () const
 
bool TargetsHasBeenSet () const
 
void SetTargets (const Aws::Vector< Aws::String > &value)
 
void SetTargets (Aws::Vector< Aws::String > &&value)
 
JobWithTargets (const Aws::Vector< Aws::String > &value)
 
JobWithTargets (Aws::Vector< Aws::String > &&value)
 
JobAddTargets (const Aws::String &value)
 
JobAddTargets (Aws::String &&value)
 
JobAddTargets (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
JobWithDescription (const Aws::String &value)
 
JobWithDescription (Aws::String &&value)
 
JobWithDescription (const char *value)
 
const PresignedUrlConfigGetPresignedUrlConfig () const
 
bool PresignedUrlConfigHasBeenSet () const
 
void SetPresignedUrlConfig (const PresignedUrlConfig &value)
 
void SetPresignedUrlConfig (PresignedUrlConfig &&value)
 
JobWithPresignedUrlConfig (const PresignedUrlConfig &value)
 
JobWithPresignedUrlConfig (PresignedUrlConfig &&value)
 
const JobExecutionsRolloutConfigGetJobExecutionsRolloutConfig () const
 
bool JobExecutionsRolloutConfigHasBeenSet () const
 
void SetJobExecutionsRolloutConfig (const JobExecutionsRolloutConfig &value)
 
void SetJobExecutionsRolloutConfig (JobExecutionsRolloutConfig &&value)
 
JobWithJobExecutionsRolloutConfig (const JobExecutionsRolloutConfig &value)
 
JobWithJobExecutionsRolloutConfig (JobExecutionsRolloutConfig &&value)
 
const AbortConfigGetAbortConfig () const
 
bool AbortConfigHasBeenSet () const
 
void SetAbortConfig (const AbortConfig &value)
 
void SetAbortConfig (AbortConfig &&value)
 
JobWithAbortConfig (const AbortConfig &value)
 
JobWithAbortConfig (AbortConfig &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
JobWithCreatedAt (const Aws::Utils::DateTime &value)
 
JobWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedAt () const
 
bool LastUpdatedAtHasBeenSet () const
 
void SetLastUpdatedAt (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedAt (Aws::Utils::DateTime &&value)
 
JobWithLastUpdatedAt (const Aws::Utils::DateTime &value)
 
JobWithLastUpdatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCompletedAt () const
 
bool CompletedAtHasBeenSet () const
 
void SetCompletedAt (const Aws::Utils::DateTime &value)
 
void SetCompletedAt (Aws::Utils::DateTime &&value)
 
JobWithCompletedAt (const Aws::Utils::DateTime &value)
 
JobWithCompletedAt (Aws::Utils::DateTime &&value)
 
const JobProcessDetailsGetJobProcessDetails () const
 
bool JobProcessDetailsHasBeenSet () const
 
void SetJobProcessDetails (const JobProcessDetails &value)
 
void SetJobProcessDetails (JobProcessDetails &&value)
 
JobWithJobProcessDetails (const JobProcessDetails &value)
 
JobWithJobProcessDetails (JobProcessDetails &&value)
 
const TimeoutConfigGetTimeoutConfig () const
 
bool TimeoutConfigHasBeenSet () const
 
void SetTimeoutConfig (const TimeoutConfig &value)
 
void SetTimeoutConfig (TimeoutConfig &&value)
 
JobWithTimeoutConfig (const TimeoutConfig &value)
 
JobWithTimeoutConfig (TimeoutConfig &&value)
 
const Aws::StringGetNamespaceId () const
 
bool NamespaceIdHasBeenSet () const
 
void SetNamespaceId (const Aws::String &value)
 
void SetNamespaceId (Aws::String &&value)
 
void SetNamespaceId (const char *value)
 
JobWithNamespaceId (const Aws::String &value)
 
JobWithNamespaceId (Aws::String &&value)
 
JobWithNamespaceId (const char *value)
 
const Aws::StringGetJobTemplateArn () const
 
bool JobTemplateArnHasBeenSet () const
 
void SetJobTemplateArn (const Aws::String &value)
 
void SetJobTemplateArn (Aws::String &&value)
 
void SetJobTemplateArn (const char *value)
 
JobWithJobTemplateArn (const Aws::String &value)
 
JobWithJobTemplateArn (Aws::String &&value)
 
JobWithJobTemplateArn (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetDocumentParameters () const
 
bool DocumentParametersHasBeenSet () const
 
void SetDocumentParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetDocumentParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
JobWithDocumentParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
JobWithDocumentParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
JobAddDocumentParameters (const Aws::String &key, const Aws::String &value)
 
JobAddDocumentParameters (Aws::String &&key, const Aws::String &value)
 
JobAddDocumentParameters (const Aws::String &key, Aws::String &&value)
 
JobAddDocumentParameters (Aws::String &&key, Aws::String &&value)
 
JobAddDocumentParameters (const char *key, Aws::String &&value)
 
JobAddDocumentParameters (Aws::String &&key, const char *value)
 
JobAddDocumentParameters (const char *key, const char *value)
 

Detailed Description

The Job object contains details about a job.

See Also:

AWS API Reference

Definition at line 42 of file Job.h.

Constructor & Destructor Documentation

◆ Job() [1/2]

Aws::IoT::Model::Job::Job ( )

◆ Job() [2/2]

Aws::IoT::Model::Job::Job ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AbortConfigHasBeenSet()

bool Aws::IoT::Model::Job::AbortConfigHasBeenSet ( ) const
inline

Configuration for criteria to abort the job.

Definition at line 509 of file Job.h.

◆ AddDocumentParameters() [1/7]

Job& Aws::IoT::Model::Job::AddDocumentParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 909 of file Job.h.

◆ AddDocumentParameters() [2/7]

Job& Aws::IoT::Model::Job::AddDocumentParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 895 of file Job.h.

◆ AddDocumentParameters() [3/7]

Job& Aws::IoT::Model::Job::AddDocumentParameters ( Aws::String &&  key,
const char *  value 
)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 923 of file Job.h.

◆ AddDocumentParameters() [4/7]

Job& Aws::IoT::Model::Job::AddDocumentParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 902 of file Job.h.

◆ AddDocumentParameters() [5/7]

Job& Aws::IoT::Model::Job::AddDocumentParameters ( const Aws::String key,
const Aws::String value 
)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 888 of file Job.h.

◆ AddDocumentParameters() [6/7]

Job& Aws::IoT::Model::Job::AddDocumentParameters ( const char *  key,
Aws::String &&  value 
)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 916 of file Job.h.

◆ AddDocumentParameters() [7/7]

Job& Aws::IoT::Model::Job::AddDocumentParameters ( const char *  key,
const char *  value 
)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 930 of file Job.h.

◆ AddTargets() [1/3]

Job& Aws::IoT::Model::Job::AddTargets ( Aws::String &&  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 390 of file Job.h.

◆ AddTargets() [2/3]

Job& Aws::IoT::Model::Job::AddTargets ( const Aws::String value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 385 of file Job.h.

◆ AddTargets() [3/3]

Job& Aws::IoT::Model::Job::AddTargets ( const char *  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 395 of file Job.h.

◆ CommentHasBeenSet()

bool Aws::IoT::Model::Job::CommentHasBeenSet ( ) const
inline

If the job was updated, describes the reason for the update.

Definition at line 319 of file Job.h.

◆ CompletedAtHasBeenSet()

bool Aws::IoT::Model::Job::CompletedAtHasBeenSet ( ) const
inline

The time, in seconds since the epoch, when the job was completed.

Definition at line 602 of file Job.h.

◆ CreatedAtHasBeenSet()

bool Aws::IoT::Model::Job::CreatedAtHasBeenSet ( ) const
inline

The time, in seconds since the epoch, when the job was created.

Definition at line 540 of file Job.h.

◆ DescriptionHasBeenSet()

bool Aws::IoT::Model::Job::DescriptionHasBeenSet ( ) const
inline

A short text description of the job.

Definition at line 406 of file Job.h.

◆ DocumentParametersHasBeenSet()

bool Aws::IoT::Model::Job::DocumentParametersHasBeenSet ( ) const
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 853 of file Job.h.

◆ ForceCanceledHasBeenSet()

bool Aws::IoT::Model::Job::ForceCanceledHasBeenSet ( ) const
inline

Will be true if the job was canceled with the optional force parameter set to true.

Definition at line 255 of file Job.h.

◆ GetAbortConfig()

const AbortConfig& Aws::IoT::Model::Job::GetAbortConfig ( ) const
inline

Configuration for criteria to abort the job.

Definition at line 504 of file Job.h.

◆ GetComment()

const Aws::String& Aws::IoT::Model::Job::GetComment ( ) const
inline

If the job was updated, describes the reason for the update.

Definition at line 314 of file Job.h.

◆ GetCompletedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::Job::GetCompletedAt ( ) const
inline

The time, in seconds since the epoch, when the job was completed.

Definition at line 597 of file Job.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::Job::GetCreatedAt ( ) const
inline

The time, in seconds since the epoch, when the job was created.

Definition at line 535 of file Job.h.

◆ GetDescription()

const Aws::String& Aws::IoT::Model::Job::GetDescription ( ) const
inline

A short text description of the job.

Definition at line 401 of file Job.h.

◆ GetDocumentParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::IoT::Model::Job::GetDocumentParameters ( ) const
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 846 of file Job.h.

◆ GetForceCanceled()

bool Aws::IoT::Model::Job::GetForceCanceled ( ) const
inline

Will be true if the job was canceled with the optional force parameter set to true.

Definition at line 249 of file Job.h.

◆ GetJobArn()

const Aws::String& Aws::IoT::Model::Job::GetJobArn ( ) const
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 55 of file Job.h.

◆ GetJobExecutionsRolloutConfig()

const JobExecutionsRolloutConfig& Aws::IoT::Model::Job::GetJobExecutionsRolloutConfig ( ) const
inline

Allows you to create a staged rollout of a job.

Definition at line 473 of file Job.h.

◆ GetJobId()

const Aws::String& Aws::IoT::Model::Job::GetJobId ( ) const
inline

The unique identifier you assigned to this job when it was created.

Definition at line 103 of file Job.h.

◆ GetJobProcessDetails()

const JobProcessDetails& Aws::IoT::Model::Job::GetJobProcessDetails ( ) const
inline

Details about the job process.

Definition at line 628 of file Job.h.

◆ GetJobTemplateArn()

const Aws::String& Aws::IoT::Model::Job::GetJobTemplateArn ( ) const
inline

The ARN of the job template used to create the job.

Definition at line 803 of file Job.h.

◆ GetLastUpdatedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::Job::GetLastUpdatedAt ( ) const
inline

The time, in seconds since the epoch, when the job was last updated.

Definition at line 566 of file Job.h.

◆ GetNamespaceId()

const Aws::String& Aws::IoT::Model::Job::GetNamespaceId ( ) const
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 720 of file Job.h.

◆ GetPresignedUrlConfig()

const PresignedUrlConfig& Aws::IoT::Model::Job::GetPresignedUrlConfig ( ) const
inline

Configuration for pre-signed S3 URLs.

Definition at line 442 of file Job.h.

◆ GetReasonCode()

const Aws::String& Aws::IoT::Model::Job::GetReasonCode ( ) const
inline

If the job was updated, provides the reason code for the update.

Definition at line 273 of file Job.h.

◆ GetStatus()

const JobStatus& Aws::IoT::Model::Job::GetStatus ( ) const
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 207 of file Job.h.

◆ GetTargets()

const Aws::Vector<Aws::String>& Aws::IoT::Model::Job::GetTargets ( ) const
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 355 of file Job.h.

◆ GetTargetSelection()

const TargetSelection& Aws::IoT::Model::Job::GetTargetSelection ( ) const
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 149 of file Job.h.

◆ GetTimeoutConfig()

const TimeoutConfig& Aws::IoT::Model::Job::GetTimeoutConfig ( ) const
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 663 of file Job.h.

◆ JobArnHasBeenSet()

bool Aws::IoT::Model::Job::JobArnHasBeenSet ( ) const
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 61 of file Job.h.

◆ JobExecutionsRolloutConfigHasBeenSet()

bool Aws::IoT::Model::Job::JobExecutionsRolloutConfigHasBeenSet ( ) const
inline

Allows you to create a staged rollout of a job.

Definition at line 478 of file Job.h.

◆ JobIdHasBeenSet()

bool Aws::IoT::Model::Job::JobIdHasBeenSet ( ) const
inline

The unique identifier you assigned to this job when it was created.

Definition at line 108 of file Job.h.

◆ JobProcessDetailsHasBeenSet()

bool Aws::IoT::Model::Job::JobProcessDetailsHasBeenSet ( ) const
inline

Details about the job process.

Definition at line 633 of file Job.h.

◆ JobTemplateArnHasBeenSet()

bool Aws::IoT::Model::Job::JobTemplateArnHasBeenSet ( ) const
inline

The ARN of the job template used to create the job.

Definition at line 808 of file Job.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::Job::Jsonize ( ) const

◆ LastUpdatedAtHasBeenSet()

bool Aws::IoT::Model::Job::LastUpdatedAtHasBeenSet ( ) const
inline

The time, in seconds since the epoch, when the job was last updated.

Definition at line 571 of file Job.h.

◆ NamespaceIdHasBeenSet()

bool Aws::IoT::Model::Job::NamespaceIdHasBeenSet ( ) const
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 731 of file Job.h.

◆ operator=()

Job& Aws::IoT::Model::Job::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PresignedUrlConfigHasBeenSet()

bool Aws::IoT::Model::Job::PresignedUrlConfigHasBeenSet ( ) const
inline

Configuration for pre-signed S3 URLs.

Definition at line 447 of file Job.h.

◆ ReasonCodeHasBeenSet()

bool Aws::IoT::Model::Job::ReasonCodeHasBeenSet ( ) const
inline

If the job was updated, provides the reason code for the update.

Definition at line 278 of file Job.h.

◆ SetAbortConfig() [1/2]

void Aws::IoT::Model::Job::SetAbortConfig ( AbortConfig &&  value)
inline

Configuration for criteria to abort the job.

Definition at line 519 of file Job.h.

◆ SetAbortConfig() [2/2]

void Aws::IoT::Model::Job::SetAbortConfig ( const AbortConfig value)
inline

Configuration for criteria to abort the job.

Definition at line 514 of file Job.h.

◆ SetComment() [1/3]

void Aws::IoT::Model::Job::SetComment ( Aws::String &&  value)
inline

If the job was updated, describes the reason for the update.

Definition at line 329 of file Job.h.

◆ SetComment() [2/3]

void Aws::IoT::Model::Job::SetComment ( const Aws::String value)
inline

If the job was updated, describes the reason for the update.

Definition at line 324 of file Job.h.

◆ SetComment() [3/3]

void Aws::IoT::Model::Job::SetComment ( const char *  value)
inline

If the job was updated, describes the reason for the update.

Definition at line 334 of file Job.h.

◆ SetCompletedAt() [1/2]

void Aws::IoT::Model::Job::SetCompletedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job was completed.

Definition at line 612 of file Job.h.

◆ SetCompletedAt() [2/2]

void Aws::IoT::Model::Job::SetCompletedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job was completed.

Definition at line 607 of file Job.h.

◆ SetCreatedAt() [1/2]

void Aws::IoT::Model::Job::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job was created.

Definition at line 550 of file Job.h.

◆ SetCreatedAt() [2/2]

void Aws::IoT::Model::Job::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job was created.

Definition at line 545 of file Job.h.

◆ SetDescription() [1/3]

void Aws::IoT::Model::Job::SetDescription ( Aws::String &&  value)
inline

A short text description of the job.

Definition at line 416 of file Job.h.

◆ SetDescription() [2/3]

void Aws::IoT::Model::Job::SetDescription ( const Aws::String value)
inline

A short text description of the job.

Definition at line 411 of file Job.h.

◆ SetDescription() [3/3]

void Aws::IoT::Model::Job::SetDescription ( const char *  value)
inline

A short text description of the job.

Definition at line 421 of file Job.h.

◆ SetDocumentParameters() [1/2]

void Aws::IoT::Model::Job::SetDocumentParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 867 of file Job.h.

◆ SetDocumentParameters() [2/2]

void Aws::IoT::Model::Job::SetDocumentParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 860 of file Job.h.

◆ SetForceCanceled()

void Aws::IoT::Model::Job::SetForceCanceled ( bool  value)
inline

Will be true if the job was canceled with the optional force parameter set to true.

Definition at line 261 of file Job.h.

◆ SetJobArn() [1/3]

void Aws::IoT::Model::Job::SetJobArn ( Aws::String &&  value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 73 of file Job.h.

◆ SetJobArn() [2/3]

void Aws::IoT::Model::Job::SetJobArn ( const Aws::String value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 67 of file Job.h.

◆ SetJobArn() [3/3]

void Aws::IoT::Model::Job::SetJobArn ( const char *  value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 79 of file Job.h.

◆ SetJobExecutionsRolloutConfig() [1/2]

void Aws::IoT::Model::Job::SetJobExecutionsRolloutConfig ( const JobExecutionsRolloutConfig value)
inline

Allows you to create a staged rollout of a job.

Definition at line 483 of file Job.h.

◆ SetJobExecutionsRolloutConfig() [2/2]

void Aws::IoT::Model::Job::SetJobExecutionsRolloutConfig ( JobExecutionsRolloutConfig &&  value)
inline

Allows you to create a staged rollout of a job.

Definition at line 488 of file Job.h.

◆ SetJobId() [1/3]

void Aws::IoT::Model::Job::SetJobId ( Aws::String &&  value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 118 of file Job.h.

◆ SetJobId() [2/3]

void Aws::IoT::Model::Job::SetJobId ( const Aws::String value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 113 of file Job.h.

◆ SetJobId() [3/3]

void Aws::IoT::Model::Job::SetJobId ( const char *  value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 123 of file Job.h.

◆ SetJobProcessDetails() [1/2]

void Aws::IoT::Model::Job::SetJobProcessDetails ( const JobProcessDetails value)
inline

Details about the job process.

Definition at line 638 of file Job.h.

◆ SetJobProcessDetails() [2/2]

void Aws::IoT::Model::Job::SetJobProcessDetails ( JobProcessDetails &&  value)
inline

Details about the job process.

Definition at line 643 of file Job.h.

◆ SetJobTemplateArn() [1/3]

void Aws::IoT::Model::Job::SetJobTemplateArn ( Aws::String &&  value)
inline

The ARN of the job template used to create the job.

Definition at line 818 of file Job.h.

◆ SetJobTemplateArn() [2/3]

void Aws::IoT::Model::Job::SetJobTemplateArn ( const Aws::String value)
inline

The ARN of the job template used to create the job.

Definition at line 813 of file Job.h.

◆ SetJobTemplateArn() [3/3]

void Aws::IoT::Model::Job::SetJobTemplateArn ( const char *  value)
inline

The ARN of the job template used to create the job.

Definition at line 823 of file Job.h.

◆ SetLastUpdatedAt() [1/2]

void Aws::IoT::Model::Job::SetLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job was last updated.

Definition at line 581 of file Job.h.

◆ SetLastUpdatedAt() [2/2]

void Aws::IoT::Model::Job::SetLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job was last updated.

Definition at line 576 of file Job.h.

◆ SetNamespaceId() [1/3]

void Aws::IoT::Model::Job::SetNamespaceId ( Aws::String &&  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 753 of file Job.h.

◆ SetNamespaceId() [2/3]

void Aws::IoT::Model::Job::SetNamespaceId ( const Aws::String value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 742 of file Job.h.

◆ SetNamespaceId() [3/3]

void Aws::IoT::Model::Job::SetNamespaceId ( const char *  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 764 of file Job.h.

◆ SetPresignedUrlConfig() [1/2]

void Aws::IoT::Model::Job::SetPresignedUrlConfig ( const PresignedUrlConfig value)
inline

Configuration for pre-signed S3 URLs.

Definition at line 452 of file Job.h.

◆ SetPresignedUrlConfig() [2/2]

void Aws::IoT::Model::Job::SetPresignedUrlConfig ( PresignedUrlConfig &&  value)
inline

Configuration for pre-signed S3 URLs.

Definition at line 457 of file Job.h.

◆ SetReasonCode() [1/3]

void Aws::IoT::Model::Job::SetReasonCode ( Aws::String &&  value)
inline

If the job was updated, provides the reason code for the update.

Definition at line 288 of file Job.h.

◆ SetReasonCode() [2/3]

void Aws::IoT::Model::Job::SetReasonCode ( const Aws::String value)
inline

If the job was updated, provides the reason code for the update.

Definition at line 283 of file Job.h.

◆ SetReasonCode() [3/3]

void Aws::IoT::Model::Job::SetReasonCode ( const char *  value)
inline

If the job was updated, provides the reason code for the update.

Definition at line 293 of file Job.h.

◆ SetStatus() [1/2]

void Aws::IoT::Model::Job::SetStatus ( const JobStatus value)
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 221 of file Job.h.

◆ SetStatus() [2/2]

void Aws::IoT::Model::Job::SetStatus ( JobStatus &&  value)
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 228 of file Job.h.

◆ SetTargets() [1/2]

void Aws::IoT::Model::Job::SetTargets ( Aws::Vector< Aws::String > &&  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 370 of file Job.h.

◆ SetTargets() [2/2]

void Aws::IoT::Model::Job::SetTargets ( const Aws::Vector< Aws::String > &  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 365 of file Job.h.

◆ SetTargetSelection() [1/2]

void Aws::IoT::Model::Job::SetTargetSelection ( const TargetSelection value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 169 of file Job.h.

◆ SetTargetSelection() [2/2]

void Aws::IoT::Model::Job::SetTargetSelection ( TargetSelection &&  value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 179 of file Job.h.

◆ SetTimeoutConfig() [1/2]

void Aws::IoT::Model::Job::SetTimeoutConfig ( const TimeoutConfig value)
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 681 of file Job.h.

◆ SetTimeoutConfig() [2/2]

void Aws::IoT::Model::Job::SetTimeoutConfig ( TimeoutConfig &&  value)
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 690 of file Job.h.

◆ StatusHasBeenSet()

bool Aws::IoT::Model::Job::StatusHasBeenSet ( ) const
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 214 of file Job.h.

◆ TargetSelectionHasBeenSet()

bool Aws::IoT::Model::Job::TargetSelectionHasBeenSet ( ) const
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 159 of file Job.h.

◆ TargetsHasBeenSet()

bool Aws::IoT::Model::Job::TargetsHasBeenSet ( ) const
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 360 of file Job.h.

◆ TimeoutConfigHasBeenSet()

bool Aws::IoT::Model::Job::TimeoutConfigHasBeenSet ( ) const
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 672 of file Job.h.

◆ WithAbortConfig() [1/2]

Job& Aws::IoT::Model::Job::WithAbortConfig ( AbortConfig &&  value)
inline

Configuration for criteria to abort the job.

Definition at line 529 of file Job.h.

◆ WithAbortConfig() [2/2]

Job& Aws::IoT::Model::Job::WithAbortConfig ( const AbortConfig value)
inline

Configuration for criteria to abort the job.

Definition at line 524 of file Job.h.

◆ WithComment() [1/3]

Job& Aws::IoT::Model::Job::WithComment ( Aws::String &&  value)
inline

If the job was updated, describes the reason for the update.

Definition at line 344 of file Job.h.

◆ WithComment() [2/3]

Job& Aws::IoT::Model::Job::WithComment ( const Aws::String value)
inline

If the job was updated, describes the reason for the update.

Definition at line 339 of file Job.h.

◆ WithComment() [3/3]

Job& Aws::IoT::Model::Job::WithComment ( const char *  value)
inline

If the job was updated, describes the reason for the update.

Definition at line 349 of file Job.h.

◆ WithCompletedAt() [1/2]

Job& Aws::IoT::Model::Job::WithCompletedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job was completed.

Definition at line 622 of file Job.h.

◆ WithCompletedAt() [2/2]

Job& Aws::IoT::Model::Job::WithCompletedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job was completed.

Definition at line 617 of file Job.h.

◆ WithCreatedAt() [1/2]

Job& Aws::IoT::Model::Job::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job was created.

Definition at line 560 of file Job.h.

◆ WithCreatedAt() [2/2]

Job& Aws::IoT::Model::Job::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job was created.

Definition at line 555 of file Job.h.

◆ WithDescription() [1/3]

Job& Aws::IoT::Model::Job::WithDescription ( Aws::String &&  value)
inline

A short text description of the job.

Definition at line 431 of file Job.h.

◆ WithDescription() [2/3]

Job& Aws::IoT::Model::Job::WithDescription ( const Aws::String value)
inline

A short text description of the job.

Definition at line 426 of file Job.h.

◆ WithDescription() [3/3]

Job& Aws::IoT::Model::Job::WithDescription ( const char *  value)
inline

A short text description of the job.

Definition at line 436 of file Job.h.

◆ WithDocumentParameters() [1/2]

Job& Aws::IoT::Model::Job::WithDocumentParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 881 of file Job.h.

◆ WithDocumentParameters() [2/2]

Job& Aws::IoT::Model::Job::WithDocumentParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Definition at line 874 of file Job.h.

◆ WithForceCanceled()

Job& Aws::IoT::Model::Job::WithForceCanceled ( bool  value)
inline

Will be true if the job was canceled with the optional force parameter set to true.

Definition at line 267 of file Job.h.

◆ WithJobArn() [1/3]

Job& Aws::IoT::Model::Job::WithJobArn ( Aws::String &&  value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 91 of file Job.h.

◆ WithJobArn() [2/3]

Job& Aws::IoT::Model::Job::WithJobArn ( const Aws::String value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 85 of file Job.h.

◆ WithJobArn() [3/3]

Job& Aws::IoT::Model::Job::WithJobArn ( const char *  value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 97 of file Job.h.

◆ WithJobExecutionsRolloutConfig() [1/2]

Job& Aws::IoT::Model::Job::WithJobExecutionsRolloutConfig ( const JobExecutionsRolloutConfig value)
inline

Allows you to create a staged rollout of a job.

Definition at line 493 of file Job.h.

◆ WithJobExecutionsRolloutConfig() [2/2]

Job& Aws::IoT::Model::Job::WithJobExecutionsRolloutConfig ( JobExecutionsRolloutConfig &&  value)
inline

Allows you to create a staged rollout of a job.

Definition at line 498 of file Job.h.

◆ WithJobId() [1/3]

Job& Aws::IoT::Model::Job::WithJobId ( Aws::String &&  value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 133 of file Job.h.

◆ WithJobId() [2/3]

Job& Aws::IoT::Model::Job::WithJobId ( const Aws::String value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 128 of file Job.h.

◆ WithJobId() [3/3]

Job& Aws::IoT::Model::Job::WithJobId ( const char *  value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 138 of file Job.h.

◆ WithJobProcessDetails() [1/2]

Job& Aws::IoT::Model::Job::WithJobProcessDetails ( const JobProcessDetails value)
inline

Details about the job process.

Definition at line 648 of file Job.h.

◆ WithJobProcessDetails() [2/2]

Job& Aws::IoT::Model::Job::WithJobProcessDetails ( JobProcessDetails &&  value)
inline

Details about the job process.

Definition at line 653 of file Job.h.

◆ WithJobTemplateArn() [1/3]

Job& Aws::IoT::Model::Job::WithJobTemplateArn ( Aws::String &&  value)
inline

The ARN of the job template used to create the job.

Definition at line 833 of file Job.h.

◆ WithJobTemplateArn() [2/3]

Job& Aws::IoT::Model::Job::WithJobTemplateArn ( const Aws::String value)
inline

The ARN of the job template used to create the job.

Definition at line 828 of file Job.h.

◆ WithJobTemplateArn() [3/3]

Job& Aws::IoT::Model::Job::WithJobTemplateArn ( const char *  value)
inline

The ARN of the job template used to create the job.

Definition at line 838 of file Job.h.

◆ WithLastUpdatedAt() [1/2]

Job& Aws::IoT::Model::Job::WithLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job was last updated.

Definition at line 591 of file Job.h.

◆ WithLastUpdatedAt() [2/2]

Job& Aws::IoT::Model::Job::WithLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job was last updated.

Definition at line 586 of file Job.h.

◆ WithNamespaceId() [1/3]

Job& Aws::IoT::Model::Job::WithNamespaceId ( Aws::String &&  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 786 of file Job.h.

◆ WithNamespaceId() [2/3]

Job& Aws::IoT::Model::Job::WithNamespaceId ( const Aws::String value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 775 of file Job.h.

◆ WithNamespaceId() [3/3]

Job& Aws::IoT::Model::Job::WithNamespaceId ( const char *  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 797 of file Job.h.

◆ WithPresignedUrlConfig() [1/2]

Job& Aws::IoT::Model::Job::WithPresignedUrlConfig ( const PresignedUrlConfig value)
inline

Configuration for pre-signed S3 URLs.

Definition at line 462 of file Job.h.

◆ WithPresignedUrlConfig() [2/2]

Job& Aws::IoT::Model::Job::WithPresignedUrlConfig ( PresignedUrlConfig &&  value)
inline

Configuration for pre-signed S3 URLs.

Definition at line 467 of file Job.h.

◆ WithReasonCode() [1/3]

Job& Aws::IoT::Model::Job::WithReasonCode ( Aws::String &&  value)
inline

If the job was updated, provides the reason code for the update.

Definition at line 303 of file Job.h.

◆ WithReasonCode() [2/3]

Job& Aws::IoT::Model::Job::WithReasonCode ( const Aws::String value)
inline

If the job was updated, provides the reason code for the update.

Definition at line 298 of file Job.h.

◆ WithReasonCode() [3/3]

Job& Aws::IoT::Model::Job::WithReasonCode ( const char *  value)
inline

If the job was updated, provides the reason code for the update.

Definition at line 308 of file Job.h.

◆ WithStatus() [1/2]

Job& Aws::IoT::Model::Job::WithStatus ( const JobStatus value)
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 235 of file Job.h.

◆ WithStatus() [2/2]

Job& Aws::IoT::Model::Job::WithStatus ( JobStatus &&  value)
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 242 of file Job.h.

◆ WithTargets() [1/2]

Job& Aws::IoT::Model::Job::WithTargets ( Aws::Vector< Aws::String > &&  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 380 of file Job.h.

◆ WithTargets() [2/2]

Job& Aws::IoT::Model::Job::WithTargets ( const Aws::Vector< Aws::String > &  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 375 of file Job.h.

◆ WithTargetSelection() [1/2]

Job& Aws::IoT::Model::Job::WithTargetSelection ( const TargetSelection value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 189 of file Job.h.

◆ WithTargetSelection() [2/2]

Job& Aws::IoT::Model::Job::WithTargetSelection ( TargetSelection &&  value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 199 of file Job.h.

◆ WithTimeoutConfig() [1/2]

Job& Aws::IoT::Model::Job::WithTimeoutConfig ( const TimeoutConfig value)
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 699 of file Job.h.

◆ WithTimeoutConfig() [2/2]

Job& Aws::IoT::Model::Job::WithTimeoutConfig ( TimeoutConfig &&  value)
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 708 of file Job.h.


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