Amazonka.RobOMaker.CreateWorldGenerationJob

Creates worlds using the specified template.

Creating a Request

data CreateWorldGenerationJob

See: newCreateWorldGenerationJob smart constructor.

Constructors

CreateWorldGenerationJob'

Fields

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

• worldTags :: Maybe (HashMap Text Text)

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

• 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

ToJSON CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

toJSON :: CreateWorldGenerationJob -> Value

toEncoding :: CreateWorldGenerationJob -> Encoding

toJSONList :: [CreateWorldGenerationJob] -> Value

toEncodingList :: [CreateWorldGenerationJob] -> Encoding

ToHeaders CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

toHeaders :: CreateWorldGenerationJob -> [Header]

ToPath CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

toPath :: CreateWorldGenerationJob -> ByteString

ToQuery CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

toQuery :: CreateWorldGenerationJob -> QueryString

AWSRequest CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Associated Types

type AWSResponse CreateWorldGenerationJob

Methods

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

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

Generic CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Associated Types

type Rep CreateWorldGenerationJob :: Type -> Type

Methods

from :: CreateWorldGenerationJob -> Rep CreateWorldGenerationJob x

to :: Rep CreateWorldGenerationJob x -> CreateWorldGenerationJob

Read CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

readsPrec :: Int -> ReadS CreateWorldGenerationJob

readList :: ReadS [CreateWorldGenerationJob]

readPrec :: ReadPrec CreateWorldGenerationJob

readListPrec :: ReadPrec [CreateWorldGenerationJob]

Show CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

showsPrec :: Int -> CreateWorldGenerationJob -> ShowS

show :: CreateWorldGenerationJob -> String

showList :: [CreateWorldGenerationJob] -> ShowS

NFData CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

rnf :: CreateWorldGenerationJob -> ()

Eq CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

(==) :: CreateWorldGenerationJob -> CreateWorldGenerationJob -> Bool

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

Hashable CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

hashWithSalt :: Int -> CreateWorldGenerationJob -> Int

hash :: CreateWorldGenerationJob -> Int

type AWSResponse CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

type AWSResponse CreateWorldGenerationJob = CreateWorldGenerationJobResponse

type Rep CreateWorldGenerationJob

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

type Rep CreateWorldGenerationJob = D1 ('MetaData "CreateWorldGenerationJob" "Amazonka.RobOMaker.CreateWorldGenerationJob" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "CreateWorldGenerationJob'" 'PrefixI 'True) ((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 "worldTags") '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)))))

newCreateWorldGenerationJob

Arguments

:: Text

CreateWorldGenerationJob

-> 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:

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

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

CreateWorldGenerationJob, createWorldGenerationJob_worldTags - A map that contains tag keys and tag values that are attached to the generated worlds.

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

CreateWorldGenerationJob, createWorldGenerationJob_worldCount - Information about the world count.

Request Lenses

createWorldGenerationJob_clientRequestToken :: Lens' CreateWorldGenerationJob (Maybe Text)

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

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

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

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

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

createWorldGenerationJob_template :: Lens' CreateWorldGenerationJob Text

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

createWorldGenerationJob_worldCount :: Lens' CreateWorldGenerationJob WorldCount

Information about the world count.

Destructuring the Response

data CreateWorldGenerationJobResponse

See: newCreateWorldGenerationJobResponse smart constructor.

Constructors

CreateWorldGenerationJobResponse'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the world generator 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 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.

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

• tags :: Maybe (HashMap Text Text)

  A map that contains tag keys and tag values that are attached to the world generator 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

Generic CreateWorldGenerationJobResponse

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Associated Types

type Rep CreateWorldGenerationJobResponse :: Type -> Type

Methods

from :: CreateWorldGenerationJobResponse -> Rep CreateWorldGenerationJobResponse x

to :: Rep CreateWorldGenerationJobResponse x -> CreateWorldGenerationJobResponse

Read CreateWorldGenerationJobResponse

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

readsPrec :: Int -> ReadS CreateWorldGenerationJobResponse

readList :: ReadS [CreateWorldGenerationJobResponse]

readPrec :: ReadPrec CreateWorldGenerationJobResponse

readListPrec :: ReadPrec [CreateWorldGenerationJobResponse]

Show CreateWorldGenerationJobResponse

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

showsPrec :: Int -> CreateWorldGenerationJobResponse -> ShowS

show :: CreateWorldGenerationJobResponse -> String

showList :: [CreateWorldGenerationJobResponse] -> ShowS

NFData CreateWorldGenerationJobResponse

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

rnf :: CreateWorldGenerationJobResponse -> ()

Eq CreateWorldGenerationJobResponse

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

Methods

(==) :: CreateWorldGenerationJobResponse -> CreateWorldGenerationJobResponse -> Bool

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

type Rep CreateWorldGenerationJobResponse

Defined in Amazonka.RobOMaker.CreateWorldGenerationJob

type Rep CreateWorldGenerationJobResponse = D1 ('MetaData "CreateWorldGenerationJobResponse" "Amazonka.RobOMaker.CreateWorldGenerationJob" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "CreateWorldGenerationJobResponse'" '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 "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))))))

newCreateWorldGenerationJobResponse

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:

CreateWorldGenerationJobResponse, createWorldGenerationJobResponse_arn - The Amazon Resource Name (ARN) of the world generator job.

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

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

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.

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.

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

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

CreateWorldGenerationJob, createWorldGenerationJobResponse_worldCount - Information about the world count.

CreateWorldGenerationJob, createWorldGenerationJobResponse_worldTags - A map that contains tag keys and tag values that are attached to the generated worlds.

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

Response Lenses

createWorldGenerationJobResponse_arn :: Lens' CreateWorldGenerationJobResponse (Maybe Text)

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

createWorldGenerationJobResponse_clientRequestToken :: Lens' CreateWorldGenerationJobResponse (Maybe Text)

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

createWorldGenerationJobResponse_createdAt :: Lens' CreateWorldGenerationJobResponse (Maybe UTCTime)

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

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

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

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

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

createWorldGenerationJobResponse_template :: Lens' CreateWorldGenerationJobResponse (Maybe Text)

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

createWorldGenerationJobResponse_worldCount :: Lens' CreateWorldGenerationJobResponse (Maybe WorldCount)

Information about the world count.

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

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

createWorldGenerationJobResponse_httpStatus :: Lens' CreateWorldGenerationJobResponse Int

The response's http status code.