Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RobOMaker.DescribeSimulationJobBatch

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a simulation job batch.

Synopsis

Creating a Request

data DescribeSimulationJobBatch Source #

See: newDescribeSimulationJobBatch smart constructor.

Constructors

DescribeSimulationJobBatch'
Fields batch :: Text The id of the batch to describe.

Instances

Instances details

Eq DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods (==) :: DescribeSimulationJobBatch -> DescribeSimulationJobBatch -> Bool # (/=) :: DescribeSimulationJobBatch -> DescribeSimulationJobBatch -> Bool #
Read DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods readsPrec :: Int -> ReadS DescribeSimulationJobBatch # readList :: ReadS [DescribeSimulationJobBatch] # readPrec :: ReadPrec DescribeSimulationJobBatch # readListPrec :: ReadPrec [DescribeSimulationJobBatch] #
Show DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods showsPrec :: Int -> DescribeSimulationJobBatch -> ShowS # show :: DescribeSimulationJobBatch -> String # showList :: [DescribeSimulationJobBatch] -> ShowS #
Generic DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Associated Types type Rep DescribeSimulationJobBatch :: Type -> Type # Methods from :: DescribeSimulationJobBatch -> Rep DescribeSimulationJobBatch x # to :: Rep DescribeSimulationJobBatch x -> DescribeSimulationJobBatch #
NFData DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods rnf :: DescribeSimulationJobBatch -> () #
Hashable DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods hashWithSalt :: Int -> DescribeSimulationJobBatch -> Int # hash :: DescribeSimulationJobBatch -> Int #
ToJSON DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods toJSON :: DescribeSimulationJobBatch -> Value # toEncoding :: DescribeSimulationJobBatch -> Encoding # toJSONList :: [DescribeSimulationJobBatch] -> Value # toEncodingList :: [DescribeSimulationJobBatch] -> Encoding #
AWSRequest DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Associated Types type AWSResponse DescribeSimulationJobBatch # Methods request :: DescribeSimulationJobBatch -> Request DescribeSimulationJobBatch # response :: MonadResource m => Logger -> Service -> Proxy DescribeSimulationJobBatch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSimulationJobBatch))) #
ToHeaders DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods toHeaders :: DescribeSimulationJobBatch -> [Header] #
ToPath DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods toPath :: DescribeSimulationJobBatch -> ByteString #
ToQuery DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods toQuery :: DescribeSimulationJobBatch -> QueryString #
type Rep DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch type Rep DescribeSimulationJobBatch = D1 ('MetaData "DescribeSimulationJobBatch" "Amazonka.RobOMaker.DescribeSimulationJobBatch" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "DescribeSimulationJobBatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "batch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeSimulationJobBatch Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch type AWSResponse DescribeSimulationJobBatch = DescribeSimulationJobBatchResponse

newDescribeSimulationJobBatch Source #

Arguments

:: Text	`$sel:batch:DescribeSimulationJobBatch'`
-> DescribeSimulationJobBatch

Create a value of DescribeSimulationJobBatch 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:batch:DescribeSimulationJobBatch', describeSimulationJobBatch_batch - The id of the batch to describe.

Request Lenses

describeSimulationJobBatch_batch :: Lens' DescribeSimulationJobBatch Text Source #

The id of the batch to describe.

Destructuring the Response

data DescribeSimulationJobBatchResponse Source #

See: newDescribeSimulationJobBatchResponse smart constructor.

Constructors

DescribeSimulationJobBatchResponse'

Fields

failureReason :: Maybe Text
The reason the simulation job batch failed.
status :: Maybe SimulationJobBatchStatus
The status of the 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.
lastUpdatedAt :: Maybe POSIX
The time, in milliseconds since the epoch, when the simulation job batch was last updated.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the batch.
createdAt :: Maybe POSIX
The time, in milliseconds since the epoch, when the simulation job batch was created.
failureCode :: Maybe SimulationJobBatchErrorCode
The failure code of the simulation job batch.
failedRequests :: Maybe [FailedCreateSimulationJobRequest]
A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
batchPolicy :: Maybe BatchPolicy
The batch policy.
createdRequests :: Maybe [SimulationJobSummary]
A list of created simulation job summaries.
pendingRequests :: Maybe (NonEmpty SimulationJobRequest)
A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
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 simulation job batch.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeSimulationJobBatchResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods (==) :: DescribeSimulationJobBatchResponse -> DescribeSimulationJobBatchResponse -> Bool # (/=) :: DescribeSimulationJobBatchResponse -> DescribeSimulationJobBatchResponse -> Bool #
Read DescribeSimulationJobBatchResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods readsPrec :: Int -> ReadS DescribeSimulationJobBatchResponse # readList :: ReadS [DescribeSimulationJobBatchResponse] # readPrec :: ReadPrec DescribeSimulationJobBatchResponse # readListPrec :: ReadPrec [DescribeSimulationJobBatchResponse] #
Show DescribeSimulationJobBatchResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods showsPrec :: Int -> DescribeSimulationJobBatchResponse -> ShowS # show :: DescribeSimulationJobBatchResponse -> String # showList :: [DescribeSimulationJobBatchResponse] -> ShowS #
Generic DescribeSimulationJobBatchResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Associated Types type Rep DescribeSimulationJobBatchResponse :: Type -> Type # Methods from :: DescribeSimulationJobBatchResponse -> Rep DescribeSimulationJobBatchResponse x # to :: Rep DescribeSimulationJobBatchResponse x -> DescribeSimulationJobBatchResponse #
NFData DescribeSimulationJobBatchResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch Methods rnf :: DescribeSimulationJobBatchResponse -> () #
type Rep DescribeSimulationJobBatchResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeSimulationJobBatch type Rep DescribeSimulationJobBatchResponse = D1 ('MetaData "DescribeSimulationJobBatchResponse" "Amazonka.RobOMaker.DescribeSimulationJobBatch" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "DescribeSimulationJobBatchResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobBatchStatus)) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobBatchErrorCode))))) :: ((S1 ('MetaSel ('Just "failedRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FailedCreateSimulationJobRequest])) :: (S1 ('MetaSel ('Just "batchPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchPolicy)) :: S1 ('MetaSel ('Just "createdRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SimulationJobSummary])))) :: ((S1 ('MetaSel ('Just "pendingRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SimulationJobRequest))) :: 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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeSimulationJobBatchResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSimulationJobBatchResponse'`
-> DescribeSimulationJobBatchResponse

Create a value of DescribeSimulationJobBatchResponse 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:failureReason:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_failureReason - The reason the simulation job batch failed.

$sel:status:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_status - The status of the 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.

$sel:lastUpdatedAt:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_lastUpdatedAt - The time, in milliseconds since the epoch, when the simulation job batch was last updated.

$sel:arn:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_arn - The Amazon Resource Name (ARN) of the batch.

$sel:createdAt:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_createdAt - The time, in milliseconds since the epoch, when the simulation job batch was created.

$sel:failureCode:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_failureCode - The failure code of the simulation job batch.

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

$sel:batchPolicy:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_batchPolicy - The batch policy.

$sel:createdRequests:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_createdRequests - A list of created simulation job summaries.

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

$sel:clientRequestToken:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:tags:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_tags - A map that contains tag keys and tag values that are attached to the simulation job batch.

$sel:httpStatus:DescribeSimulationJobBatchResponse', describeSimulationJobBatchResponse_httpStatus - The response's http status code.

Response Lenses

describeSimulationJobBatchResponse_failureReason :: Lens' DescribeSimulationJobBatchResponse (Maybe Text) Source #

The reason the simulation job batch failed.

describeSimulationJobBatchResponse_status :: Lens' DescribeSimulationJobBatchResponse (Maybe SimulationJobBatchStatus) Source #

The status of the 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.

describeSimulationJobBatchResponse_lastUpdatedAt :: Lens' DescribeSimulationJobBatchResponse (Maybe UTCTime) Source #

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

describeSimulationJobBatchResponse_arn :: Lens' DescribeSimulationJobBatchResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the batch.

describeSimulationJobBatchResponse_createdAt :: Lens' DescribeSimulationJobBatchResponse (Maybe UTCTime) Source #

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

describeSimulationJobBatchResponse_failureCode :: Lens' DescribeSimulationJobBatchResponse (Maybe SimulationJobBatchErrorCode) Source #

The failure code of the simulation job batch.

describeSimulationJobBatchResponse_failedRequests :: Lens' DescribeSimulationJobBatchResponse (Maybe [FailedCreateSimulationJobRequest]) Source #

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

describeSimulationJobBatchResponse_batchPolicy :: Lens' DescribeSimulationJobBatchResponse (Maybe BatchPolicy) Source #

The batch policy.

describeSimulationJobBatchResponse_createdRequests :: Lens' DescribeSimulationJobBatchResponse (Maybe [SimulationJobSummary]) Source #

A list of created simulation job summaries.

describeSimulationJobBatchResponse_pendingRequests :: Lens' DescribeSimulationJobBatchResponse (Maybe (NonEmpty SimulationJobRequest)) Source #

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

describeSimulationJobBatchResponse_clientRequestToken :: Lens' DescribeSimulationJobBatchResponse (Maybe Text) Source #

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

describeSimulationJobBatchResponse_tags :: Lens' DescribeSimulationJobBatchResponse (Maybe (HashMap Text Text)) Source #

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

describeSimulationJobBatchResponse_httpStatus :: Lens' DescribeSimulationJobBatchResponse Int Source #

The response's http status code.