Struct aws_sdk_batch::input::SubmitJobInput

#[non_exhaustive]
pub struct SubmitJobInput {

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

Contains the parameters for SubmitJob.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_name: Option<String>

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

job_queue: Option<String>

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

share_identifier: Option<String>

The share identifier for the job.

scheduling_priority_override: i32

The scheduling priority for the job. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority. This will override any scheduling priority in the job definition.

The minimum supported value is 0 and the maximum supported value is 9999.

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 Batch User Guide.

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: Option<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.

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.

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.

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 that are running on Fargate resources; use containerOverrides instead.

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.

propagate_tags: 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.

timeout: Option<JobTimeout>

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which 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.

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 Amazon Web Services Resources in Amazon Web Services General Reference.

Implementations

impl SubmitJobInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<SubmitJob, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<SubmitJob>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SubmitJobInput

impl SubmitJobInput

pub fn job_name(&self) -> Option<&str>

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

pub fn job_queue(&self) -> Option<&str>

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

pub fn share_identifier(&self) -> Option<&str>

The share identifier for the job.

pub fn scheduling_priority_override(&self) -> i32

The scheduling priority for the job. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority. This will override any scheduling priority in the job definition.

The minimum supported value is 0 and the maximum supported value is 9999.

pub fn array_properties(&self) -> 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 Batch User Guide.

pub fn depends_on(&self) -> Option<&[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.

pub fn job_definition(&self) -> Option<&str>

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.

pub fn parameters(&self) -> 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.

pub fn container_overrides(&self) -> 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.

pub fn node_overrides(&self) -> 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 that are running on Fargate resources; use containerOverrides instead.

pub fn retry_strategy(&self) -> 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.

pub fn propagate_tags(&self) -> 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.

pub fn timeout(&self) -> Option<&JobTimeout>

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which 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.

pub fn tags(&self) -> 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 Amazon Web Services Resources in Amazon Web Services General Reference.

Trait Implementations

impl Clone for SubmitJobInput

fn clone(&self) -> SubmitJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubmitJobInput

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

Formats the value using the given formatter.

impl PartialEq<SubmitJobInput> for SubmitJobInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for SubmitJobInput