amazonka-robomaker-2.0: Amazon RoboMaker 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.RobOMaker.Types.WorldGenerationJobSummary

Description

 
Synopsis

Documentation

data WorldGenerationJobSummary Source #

Information about a world generator job.

See: newWorldGenerationJobSummary smart constructor.

Constructors

WorldGenerationJobSummary' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the world generator job.

  • createdAt :: Maybe POSIX

    The time, in milliseconds since the epoch, when the world generator job was created.

  • failedWorldCount :: Maybe Int

    The number of worlds that failed.

  • status :: Maybe WorldGenerationJobStatus

    The status of the world generator job:

    Pending
    The world generator job request is pending.
    Running
    The world generator job is running.
    Completed
    The world generator job completed.
    Failed
    The world generator job failed. See failureCode for more information.
    PartialFailed
    Some worlds did not generate.
    Canceled
    The world generator job was cancelled.
    Canceling
    The world generator job is being cancelled.
  • succeededWorldCount :: Maybe Int

    The number of worlds that were generated.

  • template :: Maybe Text

    The Amazon Resource Name (arn) of the world template.

  • worldCount :: Maybe WorldCount

    Information about the world count.

Instances

Instances details
FromJSON WorldGenerationJobSummary Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.WorldGenerationJobSummary

Generic WorldGenerationJobSummary Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.WorldGenerationJobSummary

Associated Types

type Rep WorldGenerationJobSummary :: Type -> Type #

Read WorldGenerationJobSummary Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.WorldGenerationJobSummary

Show WorldGenerationJobSummary Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.WorldGenerationJobSummary

NFData WorldGenerationJobSummary Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.WorldGenerationJobSummary

Eq WorldGenerationJobSummary Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.WorldGenerationJobSummary

Hashable WorldGenerationJobSummary Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.WorldGenerationJobSummary

type Rep WorldGenerationJobSummary Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.WorldGenerationJobSummary

type Rep WorldGenerationJobSummary = D1 ('MetaData "WorldGenerationJobSummary" "Amazonka.RobOMaker.Types.WorldGenerationJobSummary" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "WorldGenerationJobSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "failedWorldCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorldGenerationJobStatus)) :*: S1 ('MetaSel ('Just "succeededWorldCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "worldCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorldCount))))))

newWorldGenerationJobSummary :: WorldGenerationJobSummary Source #

Create a value of WorldGenerationJobSummary 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:arn:WorldGenerationJobSummary', worldGenerationJobSummary_arn - The Amazon Resource Name (ARN) of the world generator job.

$sel:createdAt:WorldGenerationJobSummary', worldGenerationJobSummary_createdAt - The time, in milliseconds since the epoch, when the world generator job was created.

$sel:failedWorldCount:WorldGenerationJobSummary', worldGenerationJobSummary_failedWorldCount - The number of worlds that failed.

$sel:status:WorldGenerationJobSummary', worldGenerationJobSummary_status - The status of the world generator job:

Pending
The world generator job request is pending.
Running
The world generator job is running.
Completed
The world generator job completed.
Failed
The world generator job failed. See failureCode for more information.
PartialFailed
Some worlds did not generate.
Canceled
The world generator job was cancelled.
Canceling
The world generator job is being cancelled.

$sel:succeededWorldCount:WorldGenerationJobSummary', worldGenerationJobSummary_succeededWorldCount - The number of worlds that were generated.

$sel:template:WorldGenerationJobSummary', worldGenerationJobSummary_template - The Amazon Resource Name (arn) of the world template.

$sel:worldCount:WorldGenerationJobSummary', worldGenerationJobSummary_worldCount - Information about the world count.

worldGenerationJobSummary_arn :: Lens' WorldGenerationJobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world generator job.

worldGenerationJobSummary_createdAt :: Lens' WorldGenerationJobSummary (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world generator job was created.

worldGenerationJobSummary_status :: Lens' WorldGenerationJobSummary (Maybe WorldGenerationJobStatus) Source #

The status of the world generator job:

Pending
The world generator job request is pending.
Running
The world generator job is running.
Completed
The world generator job completed.
Failed
The world generator job failed. See failureCode for more information.
PartialFailed
Some worlds did not generate.
Canceled
The world generator job was cancelled.
Canceling
The world generator job is being cancelled.

worldGenerationJobSummary_template :: Lens' WorldGenerationJobSummary (Maybe Text) Source #

The Amazon Resource Name (arn) of the world template.