Amazonka.RobOMaker.StartSimulationJobBatch

Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.

Creating a Request

data StartSimulationJobBatch

See: newStartSimulationJobBatch smart constructor.

Constructors

StartSimulationJobBatch'

Fields

• batchPolicy :: Maybe BatchPolicy

  The batch policy.

• clientRequestToken :: Maybe Text

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• tags :: Maybe (HashMap Text Text)

  A map that contains tag keys and tag values that are attached to the deployment job batch.

• createSimulationJobRequests :: NonEmpty SimulationJobRequest

  A list of simulation job requests to create in the batch.

Instances

ToJSON StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

toJSON :: StartSimulationJobBatch -> Value

toEncoding :: StartSimulationJobBatch -> Encoding

toJSONList :: [StartSimulationJobBatch] -> Value

toEncodingList :: [StartSimulationJobBatch] -> Encoding

ToHeaders StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

toHeaders :: StartSimulationJobBatch -> [Header]

ToPath StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

toPath :: StartSimulationJobBatch -> ByteString

ToQuery StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

toQuery :: StartSimulationJobBatch -> QueryString

AWSRequest StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Associated Types

type AWSResponse StartSimulationJobBatch

Methods

request :: (Service -> Service) -> StartSimulationJobBatch -> Request StartSimulationJobBatch

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartSimulationJobBatch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartSimulationJobBatch)))

Generic StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Associated Types

type Rep StartSimulationJobBatch :: Type -> Type

Methods

from :: StartSimulationJobBatch -> Rep StartSimulationJobBatch x

to :: Rep StartSimulationJobBatch x -> StartSimulationJobBatch

Read StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

readsPrec :: Int -> ReadS StartSimulationJobBatch

readList :: ReadS [StartSimulationJobBatch]

readPrec :: ReadPrec StartSimulationJobBatch

readListPrec :: ReadPrec [StartSimulationJobBatch]

Show StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

showsPrec :: Int -> StartSimulationJobBatch -> ShowS

show :: StartSimulationJobBatch -> String

showList :: [StartSimulationJobBatch] -> ShowS

NFData StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

rnf :: StartSimulationJobBatch -> ()

Eq StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

(==) :: StartSimulationJobBatch -> StartSimulationJobBatch -> Bool

(/=) :: StartSimulationJobBatch -> StartSimulationJobBatch -> Bool

Hashable StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

hashWithSalt :: Int -> StartSimulationJobBatch -> Int

hash :: StartSimulationJobBatch -> Int

type AWSResponse StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

type AWSResponse StartSimulationJobBatch = StartSimulationJobBatchResponse

type Rep StartSimulationJobBatch

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

type Rep StartSimulationJobBatch = D1 ('MetaData "StartSimulationJobBatch" "Amazonka.RobOMaker.StartSimulationJobBatch" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "StartSimulationJobBatch'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "batchPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchPolicy)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "createSimulationJobRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty SimulationJobRequest)))))

newStartSimulationJobBatch

Arguments

:: NonEmpty SimulationJobRequest

$sel:createSimulationJobRequests:StartSimulationJobBatch'

-> StartSimulationJobBatch

Create a value of StartSimulationJobBatch 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:

StartSimulationJobBatch, startSimulationJobBatch_batchPolicy - The batch policy.

StartSimulationJobBatch, startSimulationJobBatch_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

StartSimulationJobBatch, startSimulationJobBatch_tags - A map that contains tag keys and tag values that are attached to the deployment job batch.

$sel:createSimulationJobRequests:StartSimulationJobBatch', startSimulationJobBatch_createSimulationJobRequests - A list of simulation job requests to create in the batch.

Request Lenses

startSimulationJobBatch_batchPolicy :: Lens' StartSimulationJobBatch (Maybe BatchPolicy)

The batch policy.

startSimulationJobBatch_clientRequestToken :: Lens' StartSimulationJobBatch (Maybe Text)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

startSimulationJobBatch_tags :: Lens' StartSimulationJobBatch (Maybe (HashMap Text Text))

A map that contains tag keys and tag values that are attached to the deployment job batch.

startSimulationJobBatch_createSimulationJobRequests :: Lens' StartSimulationJobBatch (NonEmpty SimulationJobRequest)

A list of simulation job requests to create in the batch.

Destructuring the Response

data StartSimulationJobBatchResponse

See: newStartSimulationJobBatchResponse smart constructor.

Constructors

StartSimulationJobBatchResponse'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (arn) of the batch.

• batchPolicy :: Maybe BatchPolicy

  The batch policy.

• clientRequestToken :: Maybe Text

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• createdAt :: Maybe POSIX

  The time, in milliseconds since the epoch, when the simulation job batch was created.

• createdRequests :: Maybe [SimulationJobSummary]

  A list of created simulation job request summaries.

• failedRequests :: Maybe [FailedCreateSimulationJobRequest]

  A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

• failureCode :: Maybe SimulationJobBatchErrorCode

  The failure code if the simulation job batch failed.

• failureReason :: Maybe Text

  The reason the simulation job batch failed.

• pendingRequests :: Maybe (NonEmpty SimulationJobRequest)

  A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

• status :: Maybe SimulationJobBatchStatus

  The status of the simulation job batch.

  Pending

  The simulation job batch request is pending.

  InProgress

  The simulation job batch is in progress.

  Failed

  The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

  Completed

  The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

  Canceled

  The simulation batch job was cancelled.

  Canceling

  The simulation batch job is being cancelled.

  Completing

  The simulation batch job is completing.

  TimingOut

  The simulation job batch is timing out.

  If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

  TimedOut

  The simulation batch job timed out.

• tags :: Maybe (HashMap Text Text)

  A map that contains tag keys and tag values that are attached to the deployment job batch.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartSimulationJobBatchResponse

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Associated Types

type Rep StartSimulationJobBatchResponse :: Type -> Type

Methods

from :: StartSimulationJobBatchResponse -> Rep StartSimulationJobBatchResponse x

to :: Rep StartSimulationJobBatchResponse x -> StartSimulationJobBatchResponse

Read StartSimulationJobBatchResponse

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

readsPrec :: Int -> ReadS StartSimulationJobBatchResponse

readList :: ReadS [StartSimulationJobBatchResponse]

readPrec :: ReadPrec StartSimulationJobBatchResponse

readListPrec :: ReadPrec [StartSimulationJobBatchResponse]

Show StartSimulationJobBatchResponse

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

showsPrec :: Int -> StartSimulationJobBatchResponse -> ShowS

show :: StartSimulationJobBatchResponse -> String

showList :: [StartSimulationJobBatchResponse] -> ShowS

NFData StartSimulationJobBatchResponse

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

rnf :: StartSimulationJobBatchResponse -> ()

Eq StartSimulationJobBatchResponse

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

Methods

(==) :: StartSimulationJobBatchResponse -> StartSimulationJobBatchResponse -> Bool

(/=) :: StartSimulationJobBatchResponse -> StartSimulationJobBatchResponse -> Bool

type Rep StartSimulationJobBatchResponse

Defined in Amazonka.RobOMaker.StartSimulationJobBatch

type Rep StartSimulationJobBatchResponse = D1 ('MetaData "StartSimulationJobBatchResponse" "Amazonka.RobOMaker.StartSimulationJobBatch" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "StartSimulationJobBatchResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "batchPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchPolicy)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "createdRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SimulationJobSummary])) :*: S1 ('MetaSel ('Just "failedRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FailedCreateSimulationJobRequest]))))) :*: ((S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobBatchErrorCode)) :*: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pendingRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SimulationJobRequest))))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobBatchStatus)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newStartSimulationJobBatchResponse

Arguments

:: Int

$sel:httpStatus:StartSimulationJobBatchResponse'

-> StartSimulationJobBatchResponse

Create a value of StartSimulationJobBatchResponse 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:

StartSimulationJobBatchResponse, startSimulationJobBatchResponse_arn - The Amazon Resource Name (arn) of the batch.

StartSimulationJobBatch, startSimulationJobBatchResponse_batchPolicy - The batch policy.

StartSimulationJobBatch, startSimulationJobBatchResponse_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

StartSimulationJobBatchResponse, startSimulationJobBatchResponse_createdAt - The time, in milliseconds since the epoch, when the simulation job batch was created.

$sel:createdRequests:StartSimulationJobBatchResponse', startSimulationJobBatchResponse_createdRequests - A list of created simulation job request summaries.

$sel:failedRequests:StartSimulationJobBatchResponse', startSimulationJobBatchResponse_failedRequests - A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

StartSimulationJobBatchResponse, startSimulationJobBatchResponse_failureCode - The failure code if the simulation job batch failed.

StartSimulationJobBatchResponse, startSimulationJobBatchResponse_failureReason - The reason the simulation job batch failed.

$sel:pendingRequests:StartSimulationJobBatchResponse', startSimulationJobBatchResponse_pendingRequests - A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

StartSimulationJobBatchResponse, startSimulationJobBatchResponse_status - The status of the simulation job batch.

Pending

The simulation job batch request is pending.

InProgress

The simulation job batch is in progress.

Failed

The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

Completed

The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

Canceled

The simulation batch job was cancelled.

Canceling

The simulation batch job is being cancelled.

Completing

The simulation batch job is completing.

TimingOut

The simulation job batch is timing out.

If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

TimedOut

The simulation batch job timed out.

StartSimulationJobBatch, startSimulationJobBatchResponse_tags - A map that contains tag keys and tag values that are attached to the deployment job batch.

$sel:httpStatus:StartSimulationJobBatchResponse', startSimulationJobBatchResponse_httpStatus - The response's http status code.

Response Lenses

startSimulationJobBatchResponse_arn :: Lens' StartSimulationJobBatchResponse (Maybe Text)

The Amazon Resource Name (arn) of the batch.

startSimulationJobBatchResponse_batchPolicy :: Lens' StartSimulationJobBatchResponse (Maybe BatchPolicy)

The batch policy.

startSimulationJobBatchResponse_clientRequestToken :: Lens' StartSimulationJobBatchResponse (Maybe Text)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

startSimulationJobBatchResponse_createdAt :: Lens' StartSimulationJobBatchResponse (Maybe UTCTime)

The time, in milliseconds since the epoch, when the simulation job batch was created.

startSimulationJobBatchResponse_createdRequests :: Lens' StartSimulationJobBatchResponse (Maybe [SimulationJobSummary])

A list of created simulation job request summaries.

startSimulationJobBatchResponse_failedRequests :: Lens' StartSimulationJobBatchResponse (Maybe [FailedCreateSimulationJobRequest])

A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

startSimulationJobBatchResponse_failureCode :: Lens' StartSimulationJobBatchResponse (Maybe SimulationJobBatchErrorCode)

The failure code if the simulation job batch failed.

startSimulationJobBatchResponse_failureReason :: Lens' StartSimulationJobBatchResponse (Maybe Text)

The reason the simulation job batch failed.

startSimulationJobBatchResponse_pendingRequests :: Lens' StartSimulationJobBatchResponse (Maybe (NonEmpty SimulationJobRequest))

A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

startSimulationJobBatchResponse_status :: Lens' StartSimulationJobBatchResponse (Maybe SimulationJobBatchStatus)

The status of the simulation job batch.

Pending

The simulation job batch request is pending.

InProgress

The simulation job batch is in progress.

Failed

The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

Completed

The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

Canceled

The simulation batch job was cancelled.

Canceling

The simulation batch job is being cancelled.

Completing

The simulation batch job is completing.

TimingOut

The simulation job batch is timing out.

If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

TimedOut

The simulation batch job timed out.

startSimulationJobBatchResponse_tags :: Lens' StartSimulationJobBatchResponse (Maybe (HashMap Text Text))

A map that contains tag keys and tag values that are attached to the deployment job batch.

startSimulationJobBatchResponse_httpStatus :: Lens' StartSimulationJobBatchResponse Int

The response's http status code.