Struct SubmitJobRequest

pub struct SubmitJobRequest {
    pub array_properties: Option<ArrayProperties>,
    pub container_overrides: Option<ContainerOverrides>,
    pub depends_on: Option<Vec<JobDependency>>,
    pub job_definition: String,
    pub job_name: String,
    pub job_queue: String,
    pub node_overrides: Option<NodeOverrides>,
    pub parameters: Option<HashMap<String, String>>,
    pub propagate_tags: Option<bool>,
    pub retry_strategy: Option<RetryStrategy>,
    pub tags: Option<HashMap<String, String>>,
    pub timeout: Option<JobTimeout>,
}

Contains the parameters for SubmitJob.

Fields

array_properties: Option<ArrayProperties>

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.

container_overrides: Option<ContainerOverrides>

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.

depends_on: Option<Vec<JobDependency>>

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.

job_definition: String

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.

job_name: String

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.

job_queue: String

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

node_overrides: Option<NodeOverrides>

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.

parameters: Option<HashMap<String, String>>

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.

propagate_tags: Option<bool>

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.

retry_strategy: Option<RetryStrategy>

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.

tags: Option<HashMap<String, String>>

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.

timeout: Option<JobTimeout>

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.

Trait Implementations

impl Clone for SubmitJobRequest

fn clone(&self) -> SubmitJobRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SubmitJobRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SubmitJobRequest

fn default() -> SubmitJobRequest

Returns the “default value” for a type.

impl PartialEq for SubmitJobRequest

fn eq(&self, other: &SubmitJobRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SubmitJobRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SubmitJobRequest