Struct aws_sdk_batch::model::JobDetail

#[non_exhaustive]
pub struct JobDetail {

    pub job_arn: Option<String>,
    pub job_name: Option<String>,
    pub job_id: Option<String>,
    pub job_queue: Option<String>,
    pub status: Option<JobStatus>,
    pub share_identifier: Option<String>,
    pub scheduling_priority: i32,
    pub attempts: Option<Vec<AttemptDetail>>,
    pub status_reason: Option<String>,
    pub created_at: i64,
    pub retry_strategy: Option<RetryStrategy>,
    pub started_at: i64,
    pub stopped_at: i64,
    pub depends_on: Option<Vec<JobDependency>>,
    pub job_definition: Option<String>,
    pub parameters: Option<HashMap<String, String>>,
    pub container: Option<ContainerDetail>,
    pub node_details: Option<NodeDetails>,
    pub node_properties: Option<NodeProperties>,
    pub array_properties: Option<ArrayPropertiesDetail>,
    pub timeout: Option<JobTimeout>,
    pub tags: Option<HashMap<String, String>>,
    pub propagate_tags: bool,
    pub platform_capabilities: Option<Vec<PlatformCapability>>,
}

An object representing an Batch job.

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_arn: Option<String>

The Amazon Resource Name (ARN) of the job.

job_name: Option<String>

The name of the job.

job_id: Option<String>

The ID for the job.

job_queue: Option<String>

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

status: Option<JobStatus>

The current status for the job.

If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the Batch User Guide.

share_identifier: Option<String>

The share identifier for the job.

scheduling_priority: i32

The scheduling policy of the job definition. 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.

attempts: Option<Vec<AttemptDetail>>

A list of job attempts associated with this job.

status_reason: Option<String>

A short, human-readable string to provide additional details about the current status of the job.

created_at: i64

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

retry_strategy: Option<RetryStrategy>

The retry strategy to use for this job if an attempt fails.

started_at: i64

The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

stopped_at: i64

The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

depends_on: Option<Vec<JobDependency>>

A list of job IDs that this job depends on.

job_definition: Option<String>

The job definition that's used by this job.

parameters: Option<HashMap<String, String>>

Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

container: Option<ContainerDetail>

An object representing the details of the container that's associated with the job.

node_details: Option<NodeDetails>

An object representing the details of a node that's associated with a multi-node parallel job.

node_properties: Option<NodeProperties>

An object representing the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

array_properties: Option<ArrayPropertiesDetail>

The array properties of the job, if it is an array job.

timeout: Option<JobTimeout>

The timeout configuration for the job.

tags: Option<HashMap<String, String>>

The tags applied to the job.

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.

platform_capabilities: Option<Vec<PlatformCapability>>

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Implementations

impl JobDetail

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

The Amazon Resource Name (ARN) of the job.

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

The name of the job.

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

The ID for the job.

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

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

pub fn status(&self) -> Option<&JobStatus>

The current status for the job.

If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the Batch User Guide.

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

The share identifier for the job.

pub fn scheduling_priority(&self) -> i32

The scheduling policy of the job definition. 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.

pub fn attempts(&self) -> Option<&[AttemptDetail]>

A list of job attempts associated with this job.

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

A short, human-readable string to provide additional details about the current status of the job.

pub fn created_at(&self) -> i64

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

pub fn retry_strategy(&self) -> Option<&RetryStrategy>

The retry strategy to use for this job if an attempt fails.

pub fn started_at(&self) -> i64

The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

pub fn stopped_at(&self) -> i64

The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

pub fn depends_on(&self) -> Option<&[JobDependency]>

A list of job IDs that this job depends on.

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

The job definition that's used by this job.

pub fn parameters(&self) -> Option<&HashMap<String, String>>

Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

pub fn container(&self) -> Option<&ContainerDetail>

An object representing the details of the container that's associated with the job.

pub fn node_details(&self) -> Option<&NodeDetails>

An object representing the details of a node that's associated with a multi-node parallel job.

pub fn node_properties(&self) -> Option<&NodeProperties>

An object representing the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

pub fn array_properties(&self) -> Option<&ArrayPropertiesDetail>

The array properties of the job, if it is an array job.

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

The timeout configuration for the job.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tags applied to the job.

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.

pub fn platform_capabilities(&self) -> Option<&[PlatformCapability]>

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

impl JobDetail

pub fn builder() -> Builder

Creates a new builder-style object to manufacture JobDetail

Trait Implementations

impl Clone for JobDetail

fn clone(&self) -> JobDetail

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobDetail

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

Formats the value using the given formatter.

impl PartialEq<JobDetail> for JobDetail

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

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

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

This method tests for !=.

impl StructuralPartialEq for JobDetail