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

#include <CreateJobRequest.h>

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

Public Member Functions

 CreateJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
CreateJobRequestWithJobId (const Aws::String &value)
 
CreateJobRequestWithJobId (Aws::String &&value)
 
CreateJobRequestWithJobId (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)
 
CreateJobRequestWithTargets (const Aws::Vector< Aws::String > &value)
 
CreateJobRequestWithTargets (Aws::Vector< Aws::String > &&value)
 
CreateJobRequestAddTargets (const Aws::String &value)
 
CreateJobRequestAddTargets (Aws::String &&value)
 
CreateJobRequestAddTargets (const char *value)
 
const Aws::StringGetDocumentSource () const
 
bool DocumentSourceHasBeenSet () const
 
void SetDocumentSource (const Aws::String &value)
 
void SetDocumentSource (Aws::String &&value)
 
void SetDocumentSource (const char *value)
 
CreateJobRequestWithDocumentSource (const Aws::String &value)
 
CreateJobRequestWithDocumentSource (Aws::String &&value)
 
CreateJobRequestWithDocumentSource (const char *value)
 
const Aws::StringGetDocument () const
 
bool DocumentHasBeenSet () const
 
void SetDocument (const Aws::String &value)
 
void SetDocument (Aws::String &&value)
 
void SetDocument (const char *value)
 
CreateJobRequestWithDocument (const Aws::String &value)
 
CreateJobRequestWithDocument (Aws::String &&value)
 
CreateJobRequestWithDocument (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)
 
CreateJobRequestWithDescription (const Aws::String &value)
 
CreateJobRequestWithDescription (Aws::String &&value)
 
CreateJobRequestWithDescription (const char *value)
 
const PresignedUrlConfigGetPresignedUrlConfig () const
 
bool PresignedUrlConfigHasBeenSet () const
 
void SetPresignedUrlConfig (const PresignedUrlConfig &value)
 
void SetPresignedUrlConfig (PresignedUrlConfig &&value)
 
CreateJobRequestWithPresignedUrlConfig (const PresignedUrlConfig &value)
 
CreateJobRequestWithPresignedUrlConfig (PresignedUrlConfig &&value)
 
const TargetSelectionGetTargetSelection () const
 
bool TargetSelectionHasBeenSet () const
 
void SetTargetSelection (const TargetSelection &value)
 
void SetTargetSelection (TargetSelection &&value)
 
CreateJobRequestWithTargetSelection (const TargetSelection &value)
 
CreateJobRequestWithTargetSelection (TargetSelection &&value)
 
const JobExecutionsRolloutConfigGetJobExecutionsRolloutConfig () const
 
bool JobExecutionsRolloutConfigHasBeenSet () const
 
void SetJobExecutionsRolloutConfig (const JobExecutionsRolloutConfig &value)
 
void SetJobExecutionsRolloutConfig (JobExecutionsRolloutConfig &&value)
 
CreateJobRequestWithJobExecutionsRolloutConfig (const JobExecutionsRolloutConfig &value)
 
CreateJobRequestWithJobExecutionsRolloutConfig (JobExecutionsRolloutConfig &&value)
 
const AbortConfigGetAbortConfig () const
 
bool AbortConfigHasBeenSet () const
 
void SetAbortConfig (const AbortConfig &value)
 
void SetAbortConfig (AbortConfig &&value)
 
CreateJobRequestWithAbortConfig (const AbortConfig &value)
 
CreateJobRequestWithAbortConfig (AbortConfig &&value)
 
const TimeoutConfigGetTimeoutConfig () const
 
bool TimeoutConfigHasBeenSet () const
 
void SetTimeoutConfig (const TimeoutConfig &value)
 
void SetTimeoutConfig (TimeoutConfig &&value)
 
CreateJobRequestWithTimeoutConfig (const TimeoutConfig &value)
 
CreateJobRequestWithTimeoutConfig (TimeoutConfig &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateJobRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateJobRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateJobRequestAddTags (const Tag &value)
 
CreateJobRequestAddTags (Tag &&value)
 
const Aws::StringGetNamespaceId () const
 
bool NamespaceIdHasBeenSet () const
 
void SetNamespaceId (const Aws::String &value)
 
void SetNamespaceId (Aws::String &&value)
 
void SetNamespaceId (const char *value)
 
CreateJobRequestWithNamespaceId (const Aws::String &value)
 
CreateJobRequestWithNamespaceId (Aws::String &&value)
 
CreateJobRequestWithNamespaceId (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)
 
CreateJobRequestWithJobTemplateArn (const Aws::String &value)
 
CreateJobRequestWithJobTemplateArn (Aws::String &&value)
 
CreateJobRequestWithJobTemplateArn (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)
 
CreateJobRequestWithDocumentParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateJobRequestWithDocumentParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateJobRequestAddDocumentParameters (const Aws::String &key, const Aws::String &value)
 
CreateJobRequestAddDocumentParameters (Aws::String &&key, const Aws::String &value)
 
CreateJobRequestAddDocumentParameters (const Aws::String &key, Aws::String &&value)
 
CreateJobRequestAddDocumentParameters (Aws::String &&key, Aws::String &&value)
 
CreateJobRequestAddDocumentParameters (const char *key, Aws::String &&value)
 
CreateJobRequestAddDocumentParameters (Aws::String &&key, const char *value)
 
CreateJobRequestAddDocumentParameters (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::IoT::IoTRequest
virtual ~IoTRequest ()
 
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::IoT::IoTRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- 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::IoT::Model::CreateJobRequest::CreateJobRequest ( )

Member Function Documentation

◆ AbortConfigHasBeenSet()

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

Allows you to create criteria to abort a job.

Definition at line 456 of file CreateJobRequest.h.

◆ AddDocumentParameters() [1/7]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 763 of file CreateJobRequest.h.

◆ AddDocumentParameters() [2/7]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 751 of file CreateJobRequest.h.

◆ AddDocumentParameters() [3/7]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 775 of file CreateJobRequest.h.

◆ AddDocumentParameters() [4/7]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 757 of file CreateJobRequest.h.

◆ AddDocumentParameters() [5/7]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 745 of file CreateJobRequest.h.

◆ AddDocumentParameters() [6/7]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 769 of file CreateJobRequest.h.

◆ AddDocumentParameters() [7/7]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 781 of file CreateJobRequest.h.

◆ AddTags() [1/2]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::AddTags ( const Tag value)
inline

Metadata which can be used to manage the job.

Definition at line 567 of file CreateJobRequest.h.

◆ AddTags() [2/2]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::AddTags ( Tag &&  value)
inline

Metadata which can be used to manage the job.

Definition at line 572 of file CreateJobRequest.h.

◆ AddTargets() [1/3]

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

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

Definition at line 138 of file CreateJobRequest.h.

◆ AddTargets() [2/3]

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

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

Definition at line 133 of file CreateJobRequest.h.

◆ AddTargets() [3/3]

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

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

Definition at line 143 of file CreateJobRequest.h.

◆ DescriptionHasBeenSet()

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

A short text description of the job.

Definition at line 292 of file CreateJobRequest.h.

◆ DocumentHasBeenSet()

bool Aws::IoT::Model::CreateJobRequest::DocumentHasBeenSet ( ) const
inline

The job document. Required if you don't specify a value for documentSource.

Definition at line 245 of file CreateJobRequest.h.

◆ DocumentParametersHasBeenSet()

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 715 of file CreateJobRequest.h.

◆ DocumentSourceHasBeenSet()

bool Aws::IoT::Model::CreateJobRequest::DocumentSourceHasBeenSet ( ) const
inline

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Definition at line 166 of file CreateJobRequest.h.

◆ GetAbortConfig()

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

Allows you to create criteria to abort a job.

Definition at line 451 of file CreateJobRequest.h.

◆ GetDescription()

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

A short text description of the job.

Definition at line 287 of file CreateJobRequest.h.

◆ GetDocument()

const Aws::String& Aws::IoT::Model::CreateJobRequest::GetDocument ( ) const
inline

The job document. Required if you don't specify a value for documentSource.

Definition at line 239 of file CreateJobRequest.h.

◆ GetDocumentParameters()

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 709 of file CreateJobRequest.h.

◆ GetDocumentSource()

const Aws::String& Aws::IoT::Model::CreateJobRequest::GetDocumentSource ( ) const
inline

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Definition at line 155 of file CreateJobRequest.h.

◆ GetJobExecutionsRolloutConfig()

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

Allows you to create a staged rollout of the job.

Definition at line 420 of file CreateJobRequest.h.

◆ GetJobId()

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

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Definition at line 48 of file CreateJobRequest.h.

◆ GetJobTemplateArn()

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

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

Definition at line 667 of file CreateJobRequest.h.

◆ GetNamespaceId()

const Aws::String& Aws::IoT::Model::CreateJobRequest::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 584 of file CreateJobRequest.h.

◆ GetPresignedUrlConfig()

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

Configuration information for pre-signed S3 URLs.

Definition at line 328 of file CreateJobRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateJobRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::IoT::Model::CreateJobRequest::GetTags ( ) const
inline

Metadata which can be used to manage the job.

Definition at line 537 of file CreateJobRequest.h.

◆ GetTargets()

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

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

Definition at line 103 of file CreateJobRequest.h.

◆ GetTargetSelection()

const TargetSelection& Aws::IoT::Model::CreateJobRequest::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 364 of file CreateJobRequest.h.

◆ GetTimeoutConfig()

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

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 486 of file CreateJobRequest.h.

◆ JobExecutionsRolloutConfigHasBeenSet()

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

Allows you to create a staged rollout of the job.

Definition at line 425 of file CreateJobRequest.h.

◆ JobIdHasBeenSet()

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

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Definition at line 55 of file CreateJobRequest.h.

◆ JobTemplateArnHasBeenSet()

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

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

Definition at line 672 of file CreateJobRequest.h.

◆ NamespaceIdHasBeenSet()

bool Aws::IoT::Model::CreateJobRequest::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 595 of file CreateJobRequest.h.

◆ PresignedUrlConfigHasBeenSet()

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

Configuration information for pre-signed S3 URLs.

Definition at line 333 of file CreateJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAbortConfig() [1/2]

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

Allows you to create criteria to abort a job.

Definition at line 466 of file CreateJobRequest.h.

◆ SetAbortConfig() [2/2]

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

Allows you to create criteria to abort a job.

Definition at line 461 of file CreateJobRequest.h.

◆ SetDescription() [1/3]

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

A short text description of the job.

Definition at line 302 of file CreateJobRequest.h.

◆ SetDescription() [2/3]

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

A short text description of the job.

Definition at line 297 of file CreateJobRequest.h.

◆ SetDescription() [3/3]

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

A short text description of the job.

Definition at line 307 of file CreateJobRequest.h.

◆ SetDocument() [1/3]

void Aws::IoT::Model::CreateJobRequest::SetDocument ( Aws::String &&  value)
inline

The job document. Required if you don't specify a value for documentSource.

Definition at line 257 of file CreateJobRequest.h.

◆ SetDocument() [2/3]

void Aws::IoT::Model::CreateJobRequest::SetDocument ( const Aws::String value)
inline

The job document. Required if you don't specify a value for documentSource.

Definition at line 251 of file CreateJobRequest.h.

◆ SetDocument() [3/3]

void Aws::IoT::Model::CreateJobRequest::SetDocument ( const char *  value)
inline

The job document. Required if you don't specify a value for documentSource.

Definition at line 263 of file CreateJobRequest.h.

◆ SetDocumentParameters() [1/2]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 727 of file CreateJobRequest.h.

◆ SetDocumentParameters() [2/2]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 721 of file CreateJobRequest.h.

◆ SetDocumentSource() [1/3]

void Aws::IoT::Model::CreateJobRequest::SetDocumentSource ( Aws::String &&  value)
inline

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Definition at line 188 of file CreateJobRequest.h.

◆ SetDocumentSource() [2/3]

void Aws::IoT::Model::CreateJobRequest::SetDocumentSource ( const Aws::String value)
inline

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Definition at line 177 of file CreateJobRequest.h.

◆ SetDocumentSource() [3/3]

void Aws::IoT::Model::CreateJobRequest::SetDocumentSource ( const char *  value)
inline

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Definition at line 199 of file CreateJobRequest.h.

◆ SetJobExecutionsRolloutConfig() [1/2]

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

Allows you to create a staged rollout of the job.

Definition at line 430 of file CreateJobRequest.h.

◆ SetJobExecutionsRolloutConfig() [2/2]

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

Allows you to create a staged rollout of the job.

Definition at line 435 of file CreateJobRequest.h.

◆ SetJobId() [1/3]

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

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Definition at line 69 of file CreateJobRequest.h.

◆ SetJobId() [2/3]

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

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Definition at line 62 of file CreateJobRequest.h.

◆ SetJobId() [3/3]

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

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Definition at line 76 of file CreateJobRequest.h.

◆ SetJobTemplateArn() [1/3]

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

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

Definition at line 682 of file CreateJobRequest.h.

◆ SetJobTemplateArn() [2/3]

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

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

Definition at line 677 of file CreateJobRequest.h.

◆ SetJobTemplateArn() [3/3]

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

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

Definition at line 687 of file CreateJobRequest.h.

◆ SetNamespaceId() [1/3]

void Aws::IoT::Model::CreateJobRequest::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 617 of file CreateJobRequest.h.

◆ SetNamespaceId() [2/3]

void Aws::IoT::Model::CreateJobRequest::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 606 of file CreateJobRequest.h.

◆ SetNamespaceId() [3/3]

void Aws::IoT::Model::CreateJobRequest::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 628 of file CreateJobRequest.h.

◆ SetPresignedUrlConfig() [1/2]

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

Configuration information for pre-signed S3 URLs.

Definition at line 338 of file CreateJobRequest.h.

◆ SetPresignedUrlConfig() [2/2]

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

Configuration information for pre-signed S3 URLs.

Definition at line 343 of file CreateJobRequest.h.

◆ SetTags() [1/2]

void Aws::IoT::Model::CreateJobRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Metadata which can be used to manage the job.

Definition at line 552 of file CreateJobRequest.h.

◆ SetTags() [2/2]

void Aws::IoT::Model::CreateJobRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Metadata which can be used to manage the job.

Definition at line 547 of file CreateJobRequest.h.

◆ SetTargets() [1/2]

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

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

Definition at line 118 of file CreateJobRequest.h.

◆ SetTargets() [2/2]

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

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

Definition at line 113 of file CreateJobRequest.h.

◆ SetTargetSelection() [1/2]

void Aws::IoT::Model::CreateJobRequest::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 384 of file CreateJobRequest.h.

◆ SetTargetSelection() [2/2]

void Aws::IoT::Model::CreateJobRequest::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 394 of file CreateJobRequest.h.

◆ SetTimeoutConfig() [1/2]

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

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 504 of file CreateJobRequest.h.

◆ SetTimeoutConfig() [2/2]

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

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 513 of file CreateJobRequest.h.

◆ TagsHasBeenSet()

bool Aws::IoT::Model::CreateJobRequest::TagsHasBeenSet ( ) const
inline

Metadata which can be used to manage the job.

Definition at line 542 of file CreateJobRequest.h.

◆ TargetSelectionHasBeenSet()

bool Aws::IoT::Model::CreateJobRequest::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 374 of file CreateJobRequest.h.

◆ TargetsHasBeenSet()

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

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

Definition at line 108 of file CreateJobRequest.h.

◆ TimeoutConfigHasBeenSet()

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

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 495 of file CreateJobRequest.h.

◆ WithAbortConfig() [1/2]

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

Allows you to create criteria to abort a job.

Definition at line 476 of file CreateJobRequest.h.

◆ WithAbortConfig() [2/2]

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

Allows you to create criteria to abort a job.

Definition at line 471 of file CreateJobRequest.h.

◆ WithDescription() [1/3]

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

A short text description of the job.

Definition at line 317 of file CreateJobRequest.h.

◆ WithDescription() [2/3]

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

A short text description of the job.

Definition at line 312 of file CreateJobRequest.h.

◆ WithDescription() [3/3]

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

A short text description of the job.

Definition at line 322 of file CreateJobRequest.h.

◆ WithDocument() [1/3]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::WithDocument ( Aws::String &&  value)
inline

The job document. Required if you don't specify a value for documentSource.

Definition at line 275 of file CreateJobRequest.h.

◆ WithDocument() [2/3]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::WithDocument ( const Aws::String value)
inline

The job document. Required if you don't specify a value for documentSource.

Definition at line 269 of file CreateJobRequest.h.

◆ WithDocument() [3/3]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::WithDocument ( const char *  value)
inline

The job document. Required if you don't specify a value for documentSource.

Definition at line 281 of file CreateJobRequest.h.

◆ WithDocumentParameters() [1/2]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 739 of file CreateJobRequest.h.

◆ WithDocumentParameters() [2/2]

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

Parameters of a managed template that you can specify to create the job document.

Definition at line 733 of file CreateJobRequest.h.

◆ WithDocumentSource() [1/3]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::WithDocumentSource ( Aws::String &&  value)
inline

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Definition at line 221 of file CreateJobRequest.h.

◆ WithDocumentSource() [2/3]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::WithDocumentSource ( const Aws::String value)
inline

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Definition at line 210 of file CreateJobRequest.h.

◆ WithDocumentSource() [3/3]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::WithDocumentSource ( const char *  value)
inline

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Definition at line 232 of file CreateJobRequest.h.

◆ WithJobExecutionsRolloutConfig() [1/2]

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

Allows you to create a staged rollout of the job.

Definition at line 440 of file CreateJobRequest.h.

◆ WithJobExecutionsRolloutConfig() [2/2]

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

Allows you to create a staged rollout of the job.

Definition at line 445 of file CreateJobRequest.h.

◆ WithJobId() [1/3]

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

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Definition at line 90 of file CreateJobRequest.h.

◆ WithJobId() [2/3]

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

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Definition at line 83 of file CreateJobRequest.h.

◆ WithJobId() [3/3]

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

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Definition at line 97 of file CreateJobRequest.h.

◆ WithJobTemplateArn() [1/3]

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

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

Definition at line 697 of file CreateJobRequest.h.

◆ WithJobTemplateArn() [2/3]

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

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

Definition at line 692 of file CreateJobRequest.h.

◆ WithJobTemplateArn() [3/3]

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

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

Definition at line 702 of file CreateJobRequest.h.

◆ WithNamespaceId() [1/3]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::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 650 of file CreateJobRequest.h.

◆ WithNamespaceId() [2/3]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::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 639 of file CreateJobRequest.h.

◆ WithNamespaceId() [3/3]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::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 661 of file CreateJobRequest.h.

◆ WithPresignedUrlConfig() [1/2]

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

Configuration information for pre-signed S3 URLs.

Definition at line 348 of file CreateJobRequest.h.

◆ WithPresignedUrlConfig() [2/2]

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

Configuration information for pre-signed S3 URLs.

Definition at line 353 of file CreateJobRequest.h.

◆ WithTags() [1/2]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Metadata which can be used to manage the job.

Definition at line 562 of file CreateJobRequest.h.

◆ WithTags() [2/2]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Metadata which can be used to manage the job.

Definition at line 557 of file CreateJobRequest.h.

◆ WithTargets() [1/2]

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

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

Definition at line 128 of file CreateJobRequest.h.

◆ WithTargets() [2/2]

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

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

Definition at line 123 of file CreateJobRequest.h.

◆ WithTargetSelection() [1/2]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 404 of file CreateJobRequest.h.

◆ WithTargetSelection() [2/2]

CreateJobRequest& Aws::IoT::Model::CreateJobRequest::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 414 of file CreateJobRequest.h.

◆ WithTimeoutConfig() [1/2]

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

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 522 of file CreateJobRequest.h.

◆ WithTimeoutConfig() [2/2]

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

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 531 of file CreateJobRequest.h.


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