Struct aws_sdk_batch::types::JobDetail
source · #[non_exhaustive]pub struct JobDetail { /* private fields */ }Expand description
An object that represents an Batch job.
Implementations§
source§impl JobDetail
impl JobDetail
sourcepub fn job_queue(&self) -> Option<&str>
pub fn job_queue(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
sourcepub fn status(&self) -> Option<&JobStatus>
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.
The share identifier for the job.
sourcepub fn scheduling_priority(&self) -> Option<i32>
pub fn scheduling_priority(&self) -> Option<i32>
The scheduling policy of the job definition. 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.
sourcepub fn attempts(&self) -> Option<&[AttemptDetail]>
pub fn attempts(&self) -> Option<&[AttemptDetail]>
A list of job attempts that are associated with this job.
sourcepub fn status_reason(&self) -> Option<&str>
pub fn status_reason(&self) -> Option<&str>
A short, human-readable string to provide more details for the current status of the job.
sourcepub fn created_at(&self) -> Option<i64>
pub fn created_at(&self) -> Option<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. This is specifically 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.
sourcepub fn retry_strategy(&self) -> Option<&RetryStrategy>
pub fn retry_strategy(&self) -> Option<&RetryStrategy>
The retry strategy to use for this job if an attempt fails.
sourcepub fn started_at(&self) -> Option<i64>
pub fn started_at(&self) -> Option<i64>
The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's 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.
sourcepub fn stopped_at(&self) -> Option<i64>
pub fn stopped_at(&self) -> Option<i64>
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.
sourcepub fn depends_on(&self) -> Option<&[JobDependency]>
pub fn depends_on(&self) -> Option<&[JobDependency]>
A list of job IDs that this job depends on.
sourcepub fn job_definition(&self) -> Option<&str>
pub fn job_definition(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the job definition that this job uses.
sourcepub fn parameters(&self) -> Option<&HashMap<String, String>>
pub fn parameters(&self) -> Option<&HashMap<String, String>>
Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
sourcepub fn container(&self) -> Option<&ContainerDetail>
pub fn container(&self) -> Option<&ContainerDetail>
An object that represents the details for the container that's associated with the job.
sourcepub fn node_details(&self) -> Option<&NodeDetails>
pub fn node_details(&self) -> Option<&NodeDetails>
An object that represents the details of a node that's associated with a multi-node parallel job.
sourcepub fn node_properties(&self) -> Option<&NodeProperties>
pub fn node_properties(&self) -> Option<&NodeProperties>
An object that represents the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
sourcepub fn array_properties(&self) -> Option<&ArrayPropertiesDetail>
pub fn array_properties(&self) -> Option<&ArrayPropertiesDetail>
The array properties of the job, if it's an array job.
sourcepub fn timeout(&self) -> Option<&JobTimeout>
pub fn timeout(&self) -> Option<&JobTimeout>
The timeout configuration for the job.
The tags that are applied to the job.
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 when the tasks are created. 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.
sourcepub fn platform_capabilities(&self) -> Option<&[PlatformCapability]>
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.
sourcepub fn eks_properties(&self) -> Option<&EksPropertiesDetail>
pub fn eks_properties(&self) -> Option<&EksPropertiesDetail>
An object with various properties that are specific to Amazon EKS based jobs. Only one of container, eksProperties, or nodeDetails is specified.
sourcepub fn eks_attempts(&self) -> Option<&[EksAttemptDetail]>
pub fn eks_attempts(&self) -> Option<&[EksAttemptDetail]>
A list of job attempts that are associated with this job.
sourcepub fn is_cancelled(&self) -> Option<bool>
pub fn is_cancelled(&self) -> Option<bool>
Indicates whether the job is canceled.
sourcepub fn is_terminated(&self) -> Option<bool>
pub fn is_terminated(&self) -> Option<bool>
Indicates whether the job is terminated.