Struct aws_sdk_batch::input::SubmitJobInput
source · [−]#[non_exhaustive]pub struct SubmitJobInput {Show 14 fields
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>>,
}Expand description
Contains the parameters for SubmitJob.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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.
The share identifier for the job.
scheduling_priority_override: i32The 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.
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.
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
sourceimpl SubmitJobInput
impl SubmitJobInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<SubmitJob, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<SubmitJob, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<SubmitJob>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture SubmitJobInput
sourceimpl SubmitJobInput
impl SubmitJobInput
sourcepub fn job_name(&self) -> Option<&str>
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 (_).
sourcepub fn job_queue(&self) -> Option<&str>
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.
The share identifier for the job.
sourcepub fn scheduling_priority_override(&self) -> i32
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.
sourcepub fn array_properties(&self) -> Option<&ArrayProperties>
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.
sourcepub fn depends_on(&self) -> Option<&[JobDependency]>
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.
sourcepub fn job_definition(&self) -> Option<&str>
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.
sourcepub fn parameters(&self) -> Option<&HashMap<String, String>>
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.
sourcepub fn container_overrides(&self) -> Option<&ContainerOverrides>
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.
sourcepub fn node_overrides(&self) -> Option<&NodeOverrides>
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.
sourcepub fn retry_strategy(&self) -> Option<&RetryStrategy>
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.
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) -> Option<&JobTimeout>
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.
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
sourceimpl Clone for SubmitJobInput
impl Clone for SubmitJobInput
sourcefn clone(&self) -> SubmitJobInput
fn clone(&self) -> SubmitJobInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl Debug for SubmitJobInput
impl Debug for SubmitJobInput
sourceimpl PartialEq<SubmitJobInput> for SubmitJobInput
impl PartialEq<SubmitJobInput> for SubmitJobInput
sourcefn eq(&self, other: &SubmitJobInput) -> bool
fn eq(&self, other: &SubmitJobInput) -> bool
This method tests for self and other values to be equal, and is used
by ==. Read more
sourcefn ne(&self, other: &SubmitJobInput) -> bool
fn ne(&self, other: &SubmitJobInput) -> bool
This method tests for !=.
impl StructuralPartialEq for SubmitJobInput
Auto Trait Implementations
impl RefUnwindSafe for SubmitJobInput
impl Send for SubmitJobInput
impl Sync for SubmitJobInput
impl Unpin for SubmitJobInput
impl UnwindSafe for SubmitJobInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more