AWS SDK for C++  1.8.185
AWS SDK for C++
Public Member Functions | List of all members
Aws::Batch::Model::SubmitJobRequest Class Reference

#include <SubmitJobRequest.h>

+ Inheritance diagram for Aws::Batch::Model::SubmitJobRequest:

Public Member Functions

 SubmitJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetJobName () const
 
bool JobNameHasBeenSet () const
 
void SetJobName (const Aws::String &value)
 
void SetJobName (Aws::String &&value)
 
void SetJobName (const char *value)
 
SubmitJobRequestWithJobName (const Aws::String &value)
 
SubmitJobRequestWithJobName (Aws::String &&value)
 
SubmitJobRequestWithJobName (const char *value)
 
const Aws::StringGetJobQueue () const
 
bool JobQueueHasBeenSet () const
 
void SetJobQueue (const Aws::String &value)
 
void SetJobQueue (Aws::String &&value)
 
void SetJobQueue (const char *value)
 
SubmitJobRequestWithJobQueue (const Aws::String &value)
 
SubmitJobRequestWithJobQueue (Aws::String &&value)
 
SubmitJobRequestWithJobQueue (const char *value)
 
const ArrayPropertiesGetArrayProperties () const
 
bool ArrayPropertiesHasBeenSet () const
 
void SetArrayProperties (const ArrayProperties &value)
 
void SetArrayProperties (ArrayProperties &&value)
 
SubmitJobRequestWithArrayProperties (const ArrayProperties &value)
 
SubmitJobRequestWithArrayProperties (ArrayProperties &&value)
 
const Aws::Vector< JobDependency > & GetDependsOn () const
 
bool DependsOnHasBeenSet () const
 
void SetDependsOn (const Aws::Vector< JobDependency > &value)
 
void SetDependsOn (Aws::Vector< JobDependency > &&value)
 
SubmitJobRequestWithDependsOn (const Aws::Vector< JobDependency > &value)
 
SubmitJobRequestWithDependsOn (Aws::Vector< JobDependency > &&value)
 
SubmitJobRequestAddDependsOn (const JobDependency &value)
 
SubmitJobRequestAddDependsOn (JobDependency &&value)
 
const Aws::StringGetJobDefinition () const
 
bool JobDefinitionHasBeenSet () const
 
void SetJobDefinition (const Aws::String &value)
 
void SetJobDefinition (Aws::String &&value)
 
void SetJobDefinition (const char *value)
 
SubmitJobRequestWithJobDefinition (const Aws::String &value)
 
SubmitJobRequestWithJobDefinition (Aws::String &&value)
 
SubmitJobRequestWithJobDefinition (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
SubmitJobRequestWithParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
SubmitJobRequestWithParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
SubmitJobRequestAddParameters (const Aws::String &key, const Aws::String &value)
 
SubmitJobRequestAddParameters (Aws::String &&key, const Aws::String &value)
 
SubmitJobRequestAddParameters (const Aws::String &key, Aws::String &&value)
 
SubmitJobRequestAddParameters (Aws::String &&key, Aws::String &&value)
 
SubmitJobRequestAddParameters (const char *key, Aws::String &&value)
 
SubmitJobRequestAddParameters (Aws::String &&key, const char *value)
 
SubmitJobRequestAddParameters (const char *key, const char *value)
 
const ContainerOverridesGetContainerOverrides () const
 
bool ContainerOverridesHasBeenSet () const
 
void SetContainerOverrides (const ContainerOverrides &value)
 
void SetContainerOverrides (ContainerOverrides &&value)
 
SubmitJobRequestWithContainerOverrides (const ContainerOverrides &value)
 
SubmitJobRequestWithContainerOverrides (ContainerOverrides &&value)
 
const NodeOverridesGetNodeOverrides () const
 
bool NodeOverridesHasBeenSet () const
 
void SetNodeOverrides (const NodeOverrides &value)
 
void SetNodeOverrides (NodeOverrides &&value)
 
SubmitJobRequestWithNodeOverrides (const NodeOverrides &value)
 
SubmitJobRequestWithNodeOverrides (NodeOverrides &&value)
 
const RetryStrategyGetRetryStrategy () const
 
bool RetryStrategyHasBeenSet () const
 
void SetRetryStrategy (const RetryStrategy &value)
 
void SetRetryStrategy (RetryStrategy &&value)
 
SubmitJobRequestWithRetryStrategy (const RetryStrategy &value)
 
SubmitJobRequestWithRetryStrategy (RetryStrategy &&value)
 
bool GetPropagateTags () const
 
bool PropagateTagsHasBeenSet () const
 
void SetPropagateTags (bool value)
 
SubmitJobRequestWithPropagateTags (bool value)
 
const JobTimeoutGetTimeout () const
 
bool TimeoutHasBeenSet () const
 
void SetTimeout (const JobTimeout &value)
 
void SetTimeout (JobTimeout &&value)
 
SubmitJobRequestWithTimeout (const JobTimeout &value)
 
SubmitJobRequestWithTimeout (JobTimeout &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
SubmitJobRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
SubmitJobRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
SubmitJobRequestAddTags (const Aws::String &key, const Aws::String &value)
 
SubmitJobRequestAddTags (Aws::String &&key, const Aws::String &value)
 
SubmitJobRequestAddTags (const Aws::String &key, Aws::String &&value)
 
SubmitJobRequestAddTags (Aws::String &&key, Aws::String &&value)
 
SubmitJobRequestAddTags (const char *key, Aws::String &&value)
 
SubmitJobRequestAddTags (Aws::String &&key, const char *value)
 
SubmitJobRequestAddTags (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::Batch::BatchRequest
virtual ~BatchRequest ()
 
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::Batch::BatchRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Contains the parameters for SubmitJob.

See Also:

AWS API Reference

Definition at line 33 of file SubmitJobRequest.h.

Constructor & Destructor Documentation

◆ SubmitJobRequest()

Aws::Batch::Model::SubmitJobRequest::SubmitJobRequest ( )

Member Function Documentation

◆ AddDependsOn() [1/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddDependsOn ( const JobDependency value)
inline

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Definition at line 283 of file SubmitJobRequest.h.

◆ AddDependsOn() [2/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddDependsOn ( JobDependency &&  value)
inline

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Definition at line 294 of file SubmitJobRequest.h.

◆ AddParameters() [1/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 440 of file SubmitJobRequest.h.

◆ AddParameters() [2/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 424 of file SubmitJobRequest.h.

◆ AddParameters() [3/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddParameters ( Aws::String &&  key,
const char *  value 
)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 456 of file SubmitJobRequest.h.

◆ AddParameters() [4/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 432 of file SubmitJobRequest.h.

◆ AddParameters() [5/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddParameters ( const Aws::String key,
const Aws::String value 
)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 416 of file SubmitJobRequest.h.

◆ AddParameters() [6/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddParameters ( const char *  key,
Aws::String &&  value 
)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 448 of file SubmitJobRequest.h.

◆ AddParameters() [7/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddParameters ( const char *  key,
const char *  value 
)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 464 of file SubmitJobRequest.h.

◆ AddTags() [1/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 832 of file SubmitJobRequest.h.

◆ AddTags() [2/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 814 of file SubmitJobRequest.h.

◆ AddTags() [3/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 850 of file SubmitJobRequest.h.

◆ AddTags() [4/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 823 of file SubmitJobRequest.h.

◆ AddTags() [5/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 805 of file SubmitJobRequest.h.

◆ AddTags() [6/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 841 of file SubmitJobRequest.h.

◆ AddTags() [7/7]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::AddTags ( const char *  key,
const char *  value 
)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 859 of file SubmitJobRequest.h.

◆ ArrayPropertiesHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::ArrayPropertiesHasBeenSet ( ) const
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Definition at line 169 of file SubmitJobRequest.h.

◆ ContainerOverridesHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::ContainerOverridesHasBeenSet ( ) const
inline

A list of container overrides in the JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

Definition at line 485 of file SubmitJobRequest.h.

◆ DependsOnHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::DependsOnHasBeenSet ( ) const
inline

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Definition at line 228 of file SubmitJobRequest.h.

◆ GetArrayProperties()

const ArrayProperties& Aws::Batch::Model::SubmitJobRequest::GetArrayProperties ( ) const
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Definition at line 160 of file SubmitJobRequest.h.

◆ GetContainerOverrides()

const ContainerOverrides& Aws::Batch::Model::SubmitJobRequest::GetContainerOverrides ( ) const
inline

A list of container overrides in the JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

Definition at line 475 of file SubmitJobRequest.h.

◆ GetDependsOn()

const Aws::Vector<JobDependency>& Aws::Batch::Model::SubmitJobRequest::GetDependsOn ( ) const
inline

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Definition at line 217 of file SubmitJobRequest.h.

◆ GetJobDefinition()

const Aws::String& Aws::Batch::Model::SubmitJobRequest::GetJobDefinition ( ) const
inline

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

Definition at line 303 of file SubmitJobRequest.h.

◆ GetJobName()

const Aws::String& Aws::Batch::Model::SubmitJobRequest::GetJobName ( ) const
inline

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 52 of file SubmitJobRequest.h.

◆ GetJobQueue()

const Aws::String& Aws::Batch::Model::SubmitJobRequest::GetJobQueue ( ) const
inline

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Definition at line 108 of file SubmitJobRequest.h.

◆ GetNodeOverrides()

const NodeOverrides& Aws::Batch::Model::SubmitJobRequest::GetNodeOverrides ( ) const
inline

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides instead.

Definition at line 534 of file SubmitJobRequest.h.

◆ GetParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::Batch::Model::SubmitJobRequest::GetParameters ( ) const
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 368 of file SubmitJobRequest.h.

◆ GetPropagateTags()

bool Aws::Batch::Model::SubmitJobRequest::GetPropagateTags ( ) const
inline

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.

Definition at line 629 of file SubmitJobRequest.h.

◆ GetRetryStrategy()

const RetryStrategy& Aws::Batch::Model::SubmitJobRequest::GetRetryStrategy ( ) const
inline

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Definition at line 582 of file SubmitJobRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Batch::Model::SubmitJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file SubmitJobRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Batch::Model::SubmitJobRequest::GetTags ( ) const
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 751 of file SubmitJobRequest.h.

◆ GetTimeout()

const JobTimeout& Aws::Batch::Model::SubmitJobRequest::GetTimeout ( ) const
inline

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Definition at line 676 of file SubmitJobRequest.h.

◆ JobDefinitionHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::JobDefinitionHasBeenSet ( ) const
inline

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

Definition at line 311 of file SubmitJobRequest.h.

◆ JobNameHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::JobNameHasBeenSet ( ) const
inline

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 59 of file SubmitJobRequest.h.

◆ JobQueueHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::JobQueueHasBeenSet ( ) const
inline

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Definition at line 114 of file SubmitJobRequest.h.

◆ NodeOverridesHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::NodeOverridesHasBeenSet ( ) const
inline

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides instead.

Definition at line 542 of file SubmitJobRequest.h.

◆ ParametersHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::ParametersHasBeenSet ( ) const
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 376 of file SubmitJobRequest.h.

◆ PropagateTagsHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::PropagateTagsHasBeenSet ( ) const
inline

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.

Definition at line 640 of file SubmitJobRequest.h.

◆ RetryStrategyHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::RetryStrategyHasBeenSet ( ) const
inline

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Definition at line 589 of file SubmitJobRequest.h.

◆ SerializePayload()

Aws::String Aws::Batch::Model::SubmitJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetArrayProperties() [1/2]

void Aws::Batch::Model::SubmitJobRequest::SetArrayProperties ( ArrayProperties &&  value)
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Definition at line 187 of file SubmitJobRequest.h.

◆ SetArrayProperties() [2/2]

void Aws::Batch::Model::SubmitJobRequest::SetArrayProperties ( const ArrayProperties value)
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Definition at line 178 of file SubmitJobRequest.h.

◆ SetContainerOverrides() [1/2]

void Aws::Batch::Model::SubmitJobRequest::SetContainerOverrides ( const ContainerOverrides value)
inline

A list of container overrides in the JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

Definition at line 495 of file SubmitJobRequest.h.

◆ SetContainerOverrides() [2/2]

void Aws::Batch::Model::SubmitJobRequest::SetContainerOverrides ( ContainerOverrides &&  value)
inline

A list of container overrides in the JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

Definition at line 505 of file SubmitJobRequest.h.

◆ SetDependsOn() [1/2]

void Aws::Batch::Model::SubmitJobRequest::SetDependsOn ( Aws::Vector< JobDependency > &&  value)
inline

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Definition at line 250 of file SubmitJobRequest.h.

◆ SetDependsOn() [2/2]

void Aws::Batch::Model::SubmitJobRequest::SetDependsOn ( const Aws::Vector< JobDependency > &  value)
inline

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Definition at line 239 of file SubmitJobRequest.h.

◆ SetJobDefinition() [1/3]

void Aws::Batch::Model::SubmitJobRequest::SetJobDefinition ( Aws::String &&  value)
inline

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

Definition at line 327 of file SubmitJobRequest.h.

◆ SetJobDefinition() [2/3]

void Aws::Batch::Model::SubmitJobRequest::SetJobDefinition ( const Aws::String value)
inline

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

Definition at line 319 of file SubmitJobRequest.h.

◆ SetJobDefinition() [3/3]

void Aws::Batch::Model::SubmitJobRequest::SetJobDefinition ( const char *  value)
inline

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

Definition at line 335 of file SubmitJobRequest.h.

◆ SetJobName() [1/3]

void Aws::Batch::Model::SubmitJobRequest::SetJobName ( Aws::String &&  value)
inline

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 73 of file SubmitJobRequest.h.

◆ SetJobName() [2/3]

void Aws::Batch::Model::SubmitJobRequest::SetJobName ( const Aws::String value)
inline

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 66 of file SubmitJobRequest.h.

◆ SetJobName() [3/3]

void Aws::Batch::Model::SubmitJobRequest::SetJobName ( const char *  value)
inline

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 80 of file SubmitJobRequest.h.

◆ SetJobQueue() [1/3]

void Aws::Batch::Model::SubmitJobRequest::SetJobQueue ( Aws::String &&  value)
inline

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Definition at line 126 of file SubmitJobRequest.h.

◆ SetJobQueue() [2/3]

void Aws::Batch::Model::SubmitJobRequest::SetJobQueue ( const Aws::String value)
inline

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Definition at line 120 of file SubmitJobRequest.h.

◆ SetJobQueue() [3/3]

void Aws::Batch::Model::SubmitJobRequest::SetJobQueue ( const char *  value)
inline

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Definition at line 132 of file SubmitJobRequest.h.

◆ SetNodeOverrides() [1/2]

void Aws::Batch::Model::SubmitJobRequest::SetNodeOverrides ( const NodeOverrides value)
inline

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides instead.

Definition at line 550 of file SubmitJobRequest.h.

◆ SetNodeOverrides() [2/2]

void Aws::Batch::Model::SubmitJobRequest::SetNodeOverrides ( NodeOverrides &&  value)
inline

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides instead.

Definition at line 558 of file SubmitJobRequest.h.

◆ SetParameters() [1/2]

void Aws::Batch::Model::SubmitJobRequest::SetParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 392 of file SubmitJobRequest.h.

◆ SetParameters() [2/2]

void Aws::Batch::Model::SubmitJobRequest::SetParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 384 of file SubmitJobRequest.h.

◆ SetPropagateTags()

void Aws::Batch::Model::SubmitJobRequest::SetPropagateTags ( bool  value)
inline

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.

Definition at line 651 of file SubmitJobRequest.h.

◆ SetRetryStrategy() [1/2]

void Aws::Batch::Model::SubmitJobRequest::SetRetryStrategy ( const RetryStrategy value)
inline

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Definition at line 596 of file SubmitJobRequest.h.

◆ SetRetryStrategy() [2/2]

void Aws::Batch::Model::SubmitJobRequest::SetRetryStrategy ( RetryStrategy &&  value)
inline

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Definition at line 603 of file SubmitJobRequest.h.

◆ SetTags() [1/2]

void Aws::Batch::Model::SubmitJobRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 778 of file SubmitJobRequest.h.

◆ SetTags() [2/2]

void Aws::Batch::Model::SubmitJobRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 769 of file SubmitJobRequest.h.

◆ SetTimeout() [1/2]

void Aws::Batch::Model::SubmitJobRequest::SetTimeout ( const JobTimeout value)
inline

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Definition at line 702 of file SubmitJobRequest.h.

◆ SetTimeout() [2/2]

void Aws::Batch::Model::SubmitJobRequest::SetTimeout ( JobTimeout &&  value)
inline

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Definition at line 715 of file SubmitJobRequest.h.

◆ TagsHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::TagsHasBeenSet ( ) const
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 760 of file SubmitJobRequest.h.

◆ TimeoutHasBeenSet()

bool Aws::Batch::Model::SubmitJobRequest::TimeoutHasBeenSet ( ) const
inline

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Definition at line 689 of file SubmitJobRequest.h.

◆ WithArrayProperties() [1/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithArrayProperties ( ArrayProperties &&  value)
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Definition at line 205 of file SubmitJobRequest.h.

◆ WithArrayProperties() [2/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithArrayProperties ( const ArrayProperties value)
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Definition at line 196 of file SubmitJobRequest.h.

◆ WithContainerOverrides() [1/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithContainerOverrides ( const ContainerOverrides value)
inline

A list of container overrides in the JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

Definition at line 515 of file SubmitJobRequest.h.

◆ WithContainerOverrides() [2/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithContainerOverrides ( ContainerOverrides &&  value)
inline

A list of container overrides in the JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

Definition at line 525 of file SubmitJobRequest.h.

◆ WithDependsOn() [1/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithDependsOn ( Aws::Vector< JobDependency > &&  value)
inline

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Definition at line 272 of file SubmitJobRequest.h.

◆ WithDependsOn() [2/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithDependsOn ( const Aws::Vector< JobDependency > &  value)
inline

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Definition at line 261 of file SubmitJobRequest.h.

◆ WithJobDefinition() [1/3]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithJobDefinition ( Aws::String &&  value)
inline

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

Definition at line 351 of file SubmitJobRequest.h.

◆ WithJobDefinition() [2/3]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithJobDefinition ( const Aws::String value)
inline

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

Definition at line 343 of file SubmitJobRequest.h.

◆ WithJobDefinition() [3/3]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithJobDefinition ( const char *  value)
inline

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

Definition at line 359 of file SubmitJobRequest.h.

◆ WithJobName() [1/3]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithJobName ( Aws::String &&  value)
inline

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 94 of file SubmitJobRequest.h.

◆ WithJobName() [2/3]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithJobName ( const Aws::String value)
inline

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 87 of file SubmitJobRequest.h.

◆ WithJobName() [3/3]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithJobName ( const char *  value)
inline

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 101 of file SubmitJobRequest.h.

◆ WithJobQueue() [1/3]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithJobQueue ( Aws::String &&  value)
inline

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Definition at line 144 of file SubmitJobRequest.h.

◆ WithJobQueue() [2/3]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithJobQueue ( const Aws::String value)
inline

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Definition at line 138 of file SubmitJobRequest.h.

◆ WithJobQueue() [3/3]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithJobQueue ( const char *  value)
inline

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Definition at line 150 of file SubmitJobRequest.h.

◆ WithNodeOverrides() [1/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithNodeOverrides ( const NodeOverrides value)
inline

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides instead.

Definition at line 566 of file SubmitJobRequest.h.

◆ WithNodeOverrides() [2/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithNodeOverrides ( NodeOverrides &&  value)
inline

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides instead.

Definition at line 574 of file SubmitJobRequest.h.

◆ WithParameters() [1/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 408 of file SubmitJobRequest.h.

◆ WithParameters() [2/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Definition at line 400 of file SubmitJobRequest.h.

◆ WithPropagateTags()

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithPropagateTags ( bool  value)
inline

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.

Definition at line 662 of file SubmitJobRequest.h.

◆ WithRetryStrategy() [1/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithRetryStrategy ( const RetryStrategy value)
inline

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Definition at line 610 of file SubmitJobRequest.h.

◆ WithRetryStrategy() [2/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithRetryStrategy ( RetryStrategy &&  value)
inline

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Definition at line 617 of file SubmitJobRequest.h.

◆ WithTags() [1/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 796 of file SubmitJobRequest.h.

◆ WithTags() [2/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Definition at line 787 of file SubmitJobRequest.h.

◆ WithTimeout() [1/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithTimeout ( const JobTimeout value)
inline

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Definition at line 728 of file SubmitJobRequest.h.

◆ WithTimeout() [2/2]

SubmitJobRequest& Aws::Batch::Model::SubmitJobRequest::WithTimeout ( JobTimeout &&  value)
inline

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Definition at line 741 of file SubmitJobRequest.h.


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