amazonka-batch-2.0: Amazon Batch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Batch.Types.JobSummary

Description

 
Synopsis

Documentation

data JobSummary Source #

An object that represents summary details of a job.

See: newJobSummary smart constructor.

Constructors

JobSummary' 

Fields

  • arrayProperties :: Maybe ArrayPropertiesSummary

    The array properties of the job, if it's an array job.

  • container :: Maybe ContainerSummary

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

  • createdAt :: Maybe Integer

    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.

  • jobArn :: Maybe Text

    The Amazon Resource Name (ARN) of the job.

  • jobDefinition :: Maybe Text

    The Amazon Resource Name (ARN) of the job definition.

  • nodeProperties :: Maybe NodePropertiesSummary

    The node properties for a single node in a job summary list.

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

  • startedAt :: Maybe Integer

    The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

  • status :: Maybe JobStatus

    The current status for the job.

  • statusReason :: Maybe Text

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

  • stoppedAt :: Maybe Integer

    The Unix timestamp 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.

  • jobId :: Text

    The job ID.

  • jobName :: Text

    The job name.

Instances

Instances details
FromJSON JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Generic JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Associated Types

type Rep JobSummary :: Type -> Type #

Read JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Show JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

NFData JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Methods

rnf :: JobSummary -> () #

Eq JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Hashable JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

type Rep JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

type Rep JobSummary = D1 ('MetaData "JobSummary" "Amazonka.Batch.Types.JobSummary" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "JobSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arrayProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArrayPropertiesSummary)) :*: (S1 ('MetaSel ('Just "container") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerSummary)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nodeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodePropertiesSummary))))) :*: ((S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "stoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newJobSummary Source #

Create a value of JobSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arrayProperties:JobSummary', jobSummary_arrayProperties - The array properties of the job, if it's an array job.

$sel:container:JobSummary', jobSummary_container - An object that represents the details of the container that's associated with the job.

$sel:createdAt:JobSummary', jobSummary_createdAt - 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.

$sel:jobArn:JobSummary', jobSummary_jobArn - The Amazon Resource Name (ARN) of the job.

$sel:jobDefinition:JobSummary', jobSummary_jobDefinition - The Amazon Resource Name (ARN) of the job definition.

$sel:nodeProperties:JobSummary', jobSummary_nodeProperties - The node properties for a single node in a job summary list.

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

$sel:startedAt:JobSummary', jobSummary_startedAt - The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

$sel:status:JobSummary', jobSummary_status - The current status for the job.

$sel:statusReason:JobSummary', jobSummary_statusReason - A short, human-readable string to provide more details for the current status of the job.

$sel:stoppedAt:JobSummary', jobSummary_stoppedAt - The Unix timestamp 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.

$sel:jobId:JobSummary', jobSummary_jobId - The job ID.

$sel:jobName:JobSummary', jobSummary_jobName - The job name.

jobSummary_arrayProperties :: Lens' JobSummary (Maybe ArrayPropertiesSummary) Source #

The array properties of the job, if it's an array job.

jobSummary_container :: Lens' JobSummary (Maybe ContainerSummary) Source #

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

jobSummary_createdAt :: Lens' JobSummary (Maybe Integer) Source #

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.

jobSummary_jobArn :: Lens' JobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the job.

jobSummary_jobDefinition :: Lens' JobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the job definition.

jobSummary_nodeProperties :: Lens' JobSummary (Maybe NodePropertiesSummary) Source #

The node properties for a single node in a job summary list.

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

jobSummary_startedAt :: Lens' JobSummary (Maybe Integer) Source #

The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

jobSummary_status :: Lens' JobSummary (Maybe JobStatus) Source #

The current status for the job.

jobSummary_statusReason :: Lens' JobSummary (Maybe Text) Source #

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

jobSummary_stoppedAt :: Lens' JobSummary (Maybe Integer) Source #

The Unix timestamp 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.