Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RobOMaker.DescribeWorldGenerationJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a world generation job.

Synopsis

Creating a Request

data DescribeWorldGenerationJob Source #

See: newDescribeWorldGenerationJob smart constructor.

Constructors

DescribeWorldGenerationJob'
Fields job :: Text The Amazon Resource Name (arn) of the world generation job to describe.

Instances

Instances details

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

newDescribeWorldGenerationJob Source #

Arguments

:: Text	`$sel:job:DescribeWorldGenerationJob'`
-> DescribeWorldGenerationJob

Create a value of DescribeWorldGenerationJob 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:job:DescribeWorldGenerationJob', describeWorldGenerationJob_job - The Amazon Resource Name (arn) of the world generation job to describe.

Request Lenses

describeWorldGenerationJob_job :: Lens' DescribeWorldGenerationJob Text Source #

The Amazon Resource Name (arn) of the world generation job to describe.

Destructuring the Response

data DescribeWorldGenerationJobResponse Source #

See: newDescribeWorldGenerationJobResponse smart constructor.

Constructors

DescribeWorldGenerationJobResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the world generation job.
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 world generation job was created.
failureCode :: Maybe WorldGenerationJobErrorCode
The failure code of the world generation job if it failed:
InternalServiceError
Internal service error.
LimitExceeded
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound
The specified resource could not be found.
RequestThrottled
The request was throttled.
InvalidInput
An input parameter in the request is not valid.
failureReason :: Maybe Text
The reason why the world generation job failed.
finishedWorldsSummary :: Maybe FinishedWorldsSummary
Summary information about finished worlds.
status :: Maybe WorldGenerationJobStatus
The status of the world generation job:
Pending
The world generation job request is pending.
Running
The world generation job is running.
Completed
The world generation job completed.
Failed
The world generation job failed. See failureCode for more information.
PartialFailed
Some worlds did not generate.
Canceled
The world generation job was cancelled.
Canceling
The world generation job is being cancelled.
tags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the world generation job.
template :: Maybe Text
The Amazon Resource Name (arn) of the world template.
worldCount :: Maybe WorldCount
Information about the world count.
worldTags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the generated worlds.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeWorldGenerationJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorldGenerationJob Associated Types type Rep DescribeWorldGenerationJobResponse :: Type -> Type # Methods from :: DescribeWorldGenerationJobResponse -> Rep DescribeWorldGenerationJobResponse x # to :: Rep DescribeWorldGenerationJobResponse x -> DescribeWorldGenerationJobResponse #
Read DescribeWorldGenerationJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorldGenerationJob Methods readsPrec :: Int -> ReadS DescribeWorldGenerationJobResponse # readList :: ReadS [DescribeWorldGenerationJobResponse] # readPrec :: ReadPrec DescribeWorldGenerationJobResponse # readListPrec :: ReadPrec [DescribeWorldGenerationJobResponse] #
Show DescribeWorldGenerationJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorldGenerationJob Methods showsPrec :: Int -> DescribeWorldGenerationJobResponse -> ShowS # show :: DescribeWorldGenerationJobResponse -> String # showList :: [DescribeWorldGenerationJobResponse] -> ShowS #
NFData DescribeWorldGenerationJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorldGenerationJob Methods rnf :: DescribeWorldGenerationJobResponse -> () #
Eq DescribeWorldGenerationJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorldGenerationJob Methods (==) :: DescribeWorldGenerationJobResponse -> DescribeWorldGenerationJobResponse -> Bool # (/=) :: DescribeWorldGenerationJobResponse -> DescribeWorldGenerationJobResponse -> Bool #
type Rep DescribeWorldGenerationJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorldGenerationJob type Rep DescribeWorldGenerationJobResponse = D1 ('MetaData "DescribeWorldGenerationJobResponse" "Amazonka.RobOMaker.DescribeWorldGenerationJob" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "DescribeWorldGenerationJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clientRequestToken") '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 WorldGenerationJobErrorCode)) :: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "finishedWorldsSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FinishedWorldsSummary))))) :: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorldGenerationJobStatus)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "worldCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorldCount)) :: (S1 ('MetaSel ('Just "worldTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeWorldGenerationJobResponse Source #

Arguments

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

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

DescribeWorldGenerationJobResponse, describeWorldGenerationJobResponse_arn - The Amazon Resource Name (ARN) of the world generation job.

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

DescribeWorldGenerationJobResponse, describeWorldGenerationJobResponse_createdAt - The time, in milliseconds since the epoch, when the world generation job was created.

DescribeWorldGenerationJobResponse, describeWorldGenerationJobResponse_failureCode - The failure code of the world generation job if it failed:

InternalServiceError: Internal service error.
LimitExceeded: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound: The specified resource could not be found.
RequestThrottled: The request was throttled.
InvalidInput: An input parameter in the request is not valid.

DescribeWorldGenerationJobResponse, describeWorldGenerationJobResponse_failureReason - The reason why the world generation job failed.

$sel:finishedWorldsSummary:DescribeWorldGenerationJobResponse', describeWorldGenerationJobResponse_finishedWorldsSummary - Summary information about finished worlds.

DescribeWorldGenerationJobResponse, describeWorldGenerationJobResponse_status - The status of the world generation job:

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

DescribeWorldGenerationJobResponse, describeWorldGenerationJobResponse_tags - A map that contains tag keys and tag values that are attached to the world generation job.

DescribeWorldGenerationJobResponse, describeWorldGenerationJobResponse_template - The Amazon Resource Name (arn) of the world template.

DescribeWorldGenerationJobResponse, describeWorldGenerationJobResponse_worldCount - Information about the world count.

$sel:worldTags:DescribeWorldGenerationJobResponse', describeWorldGenerationJobResponse_worldTags - A map that contains tag keys and tag values that are attached to the generated worlds.

$sel:httpStatus:DescribeWorldGenerationJobResponse', describeWorldGenerationJobResponse_httpStatus - The response's http status code.

Response Lenses

describeWorldGenerationJobResponse_arn :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

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

describeWorldGenerationJobResponse_clientRequestToken :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

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

describeWorldGenerationJobResponse_createdAt :: Lens' DescribeWorldGenerationJobResponse (Maybe UTCTime) Source #

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

describeWorldGenerationJobResponse_failureCode :: Lens' DescribeWorldGenerationJobResponse (Maybe WorldGenerationJobErrorCode) Source #

The failure code of the world generation job if it failed:

InternalServiceError: Internal service error.
LimitExceeded: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound: The specified resource could not be found.
RequestThrottled: The request was throttled.
InvalidInput: An input parameter in the request is not valid.

describeWorldGenerationJobResponse_failureReason :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

The reason why the world generation job failed.

describeWorldGenerationJobResponse_finishedWorldsSummary :: Lens' DescribeWorldGenerationJobResponse (Maybe FinishedWorldsSummary) Source #

Summary information about finished worlds.

describeWorldGenerationJobResponse_status :: Lens' DescribeWorldGenerationJobResponse (Maybe WorldGenerationJobStatus) Source #

The status of the world generation job:

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

describeWorldGenerationJobResponse_tags :: Lens' DescribeWorldGenerationJobResponse (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the world generation job.

describeWorldGenerationJobResponse_template :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

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

describeWorldGenerationJobResponse_worldCount :: Lens' DescribeWorldGenerationJobResponse (Maybe WorldCount) Source #

Information about the world count.

describeWorldGenerationJobResponse_worldTags :: Lens' DescribeWorldGenerationJobResponse (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the generated worlds.

describeWorldGenerationJobResponse_httpStatus :: Lens' DescribeWorldGenerationJobResponse Int Source #

The response's http status code.