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.CreateWorldGenerationJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates worlds using the specified template.

Synopsis

Creating a Request

data CreateWorldGenerationJob Source #

See: newCreateWorldGenerationJob smart constructor.

Constructors

CreateWorldGenerationJob'

Fields

worldTags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the generated worlds.
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 world generator job.
template :: Text
The Amazon Resource Name (arn) of the world template describing the worlds you want to create.
worldCount :: WorldCount
Information about the world count.

Instances

Instances details

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

newCreateWorldGenerationJob Source #

Arguments

:: Text	`$sel:template:CreateWorldGenerationJob'`
-> WorldCount	`$sel:worldCount:CreateWorldGenerationJob'`
-> CreateWorldGenerationJob

Create a value of CreateWorldGenerationJob 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:worldTags:CreateWorldGenerationJob', createWorldGenerationJob_worldTags - A map that contains tag keys and tag values that are attached to the generated worlds.

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

$sel:tags:CreateWorldGenerationJob', createWorldGenerationJob_tags - A map that contains tag keys and tag values that are attached to the world generator job.

$sel:template:CreateWorldGenerationJob', createWorldGenerationJob_template - The Amazon Resource Name (arn) of the world template describing the worlds you want to create.

$sel:worldCount:CreateWorldGenerationJob', createWorldGenerationJob_worldCount - Information about the world count.

Request Lenses

createWorldGenerationJob_worldTags :: Lens' CreateWorldGenerationJob (Maybe (HashMap Text Text)) Source #

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

createWorldGenerationJob_clientRequestToken :: Lens' CreateWorldGenerationJob (Maybe Text) Source #

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

createWorldGenerationJob_tags :: Lens' CreateWorldGenerationJob (Maybe (HashMap Text Text)) Source #

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

createWorldGenerationJob_template :: Lens' CreateWorldGenerationJob Text Source #

The Amazon Resource Name (arn) of the world template describing the worlds you want to create.

createWorldGenerationJob_worldCount :: Lens' CreateWorldGenerationJob WorldCount Source #

Information about the world count.

Destructuring the Response

data CreateWorldGenerationJobResponse Source #

See: newCreateWorldGenerationJobResponse smart constructor.

Constructors

CreateWorldGenerationJobResponse'

Fields

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.
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.
failureCode :: Maybe WorldGenerationJobErrorCode
The failure code of the world generator 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.
worldCount :: Maybe WorldCount
Information about the world count.
template :: Maybe Text
The Amazon Resource Name (arn) of the world template.
worldTags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the generated worlds.
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 world generator job.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newCreateWorldGenerationJobResponse Source #

Arguments

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

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

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

$sel:failureCode:CreateWorldGenerationJobResponse', createWorldGenerationJobResponse_failureCode - The failure code of the world generator 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.

$sel:worldCount:CreateWorldGenerationJob', createWorldGenerationJobResponse_worldCount - Information about the world count.

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

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

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

$sel:tags:CreateWorldGenerationJob', createWorldGenerationJobResponse_tags - A map that contains tag keys and tag values that are attached to the world generator job.

$sel:httpStatus:CreateWorldGenerationJobResponse', createWorldGenerationJobResponse_httpStatus - The response's http status code.

Response Lenses

createWorldGenerationJobResponse_status :: Lens' CreateWorldGenerationJobResponse (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.

createWorldGenerationJobResponse_arn :: Lens' CreateWorldGenerationJobResponse (Maybe Text) Source #

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

createWorldGenerationJobResponse_createdAt :: Lens' CreateWorldGenerationJobResponse (Maybe UTCTime) Source #

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

createWorldGenerationJobResponse_failureCode :: Lens' CreateWorldGenerationJobResponse (Maybe WorldGenerationJobErrorCode) Source #

The failure code of the world generator 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.

createWorldGenerationJobResponse_worldCount :: Lens' CreateWorldGenerationJobResponse (Maybe WorldCount) Source #

Information about the world count.

createWorldGenerationJobResponse_template :: Lens' CreateWorldGenerationJobResponse (Maybe Text) Source #

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

createWorldGenerationJobResponse_worldTags :: Lens' CreateWorldGenerationJobResponse (Maybe (HashMap Text Text)) Source #

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

createWorldGenerationJobResponse_clientRequestToken :: Lens' CreateWorldGenerationJobResponse (Maybe Text) Source #

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

createWorldGenerationJobResponse_tags :: Lens' CreateWorldGenerationJobResponse (Maybe (HashMap Text Text)) Source #

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

createWorldGenerationJobResponse_httpStatus :: Lens' CreateWorldGenerationJobResponse Int Source #

The response's http status code.