Struct aws_sdk_batch::client::fluent_builders::SubmitJob
source · pub struct SubmitJob { /* private fields */ }Expand description
Fluent builder constructing a request to SubmitJob.
Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a resourceRequirements object that's included in the containerOverrides parameter.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.
Implementations§
source§impl SubmitJob
impl SubmitJob
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<SubmitJob, AwsResponseRetryClassifier>, SdkError<SubmitJobError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<SubmitJob, AwsResponseRetryClassifier>, SdkError<SubmitJobError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(self) -> Result<SubmitJobOutput, SdkError<SubmitJobError>>
pub async fn send(self) -> Result<SubmitJobOutput, SdkError<SubmitJobError>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn job_name(self, input: impl Into<String>) -> Self
pub fn job_name(self, input: impl Into<String>) -> Self
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 (_).
sourcepub fn set_job_name(self, input: Option<String>) -> Self
pub fn set_job_name(self, input: Option<String>) -> Self
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 (_).
sourcepub fn job_queue(self, input: impl Into<String>) -> Self
pub fn job_queue(self, input: impl Into<String>) -> Self
The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
sourcepub fn set_job_queue(self, input: Option<String>) -> Self
pub fn set_job_queue(self, input: Option<String>) -> Self
The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
The share identifier for the job. If the job queue doesn't have a scheduling policy, then this parameter must not be specified. If the job queue has a scheduling policy, then this parameter must be specified.
The share identifier for the job. If the job queue doesn't have a scheduling policy, then this parameter must not be specified. If the job queue has a scheduling policy, then this parameter must be specified.
sourcepub fn scheduling_priority_override(self, input: i32) -> Self
pub fn scheduling_priority_override(self, input: i32) -> Self
The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition.
The minimum supported value is 0 and the maximum supported value is 9999.
sourcepub fn set_scheduling_priority_override(self, input: Option<i32>) -> Self
pub fn set_scheduling_priority_override(self, input: Option<i32>) -> Self
The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition.
The minimum supported value is 0 and the maximum supported value is 9999.
sourcepub fn array_properties(self, input: ArrayProperties) -> Self
pub fn array_properties(self, input: ArrayProperties) -> Self
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.
sourcepub fn set_array_properties(self, input: Option<ArrayProperties>) -> Self
pub fn set_array_properties(self, input: Option<ArrayProperties>) -> Self
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.
sourcepub fn depends_on(self, input: JobDependency) -> Self
pub fn depends_on(self, input: JobDependency) -> Self
Appends an item to dependsOn.
To override the contents of this collection use set_depends_on.
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.
sourcepub fn set_depends_on(self, input: Option<Vec<JobDependency>>) -> Self
pub fn set_depends_on(self, input: Option<Vec<JobDependency>>) -> Self
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.
sourcepub fn job_definition(self, input: impl Into<String>) -> Self
pub fn job_definition(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_job_definition(self, input: Option<String>) -> Self
pub fn set_job_definition(self, input: Option<String>) -> Self
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.
sourcepub fn parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to parameters.
To override the contents of this collection use set_parameters.
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.
sourcepub fn set_parameters(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_parameters(self, input: Option<HashMap<String, String>>) -> Self
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.
sourcepub fn container_overrides(self, input: ContainerOverrides) -> Self
pub fn container_overrides(self, input: ContainerOverrides) -> Self
An object with various properties that override the defaults for the job definition 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.
sourcepub fn set_container_overrides(self, input: Option<ContainerOverrides>) -> Self
pub fn set_container_overrides(self, input: Option<ContainerOverrides>) -> Self
An object with various properties that override the defaults for the job definition 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.
sourcepub fn node_overrides(self, input: NodeOverrides) -> Self
pub fn node_overrides(self, input: NodeOverrides) -> Self
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.
sourcepub fn set_node_overrides(self, input: Option<NodeOverrides>) -> Self
pub fn set_node_overrides(self, input: Option<NodeOverrides>) -> Self
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.
sourcepub fn retry_strategy(self, input: RetryStrategy) -> Self
pub fn retry_strategy(self, input: RetryStrategy) -> Self
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.
sourcepub fn set_retry_strategy(self, input: Option<RetryStrategy>) -> Self
pub fn set_retry_strategy(self, input: Option<RetryStrategy>) -> Self
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.
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.
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.
sourcepub fn timeout(self, input: JobTimeout) -> Self
pub fn timeout(self, input: JobTimeout) -> Self
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.
sourcepub fn set_timeout(self, input: Option<JobTimeout>) -> Self
pub fn set_timeout(self, input: Option<JobTimeout>) -> Self
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.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
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.
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.
sourcepub fn eks_properties_override(self, input: EksPropertiesOverride) -> Self
pub fn eks_properties_override(self, input: EksPropertiesOverride) -> Self
An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.
sourcepub fn set_eks_properties_override(
self,
input: Option<EksPropertiesOverride>
) -> Self
pub fn set_eks_properties_override(
self,
input: Option<EksPropertiesOverride>
) -> Self
An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.