Amazonka.GamesParks.StartGeneratedCodeJob

Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL.

Creating a Request

data StartGeneratedCodeJob

See: newStartGeneratedCodeJob smart constructor.

Constructors

StartGeneratedCodeJob'

Fields

• gameName :: Text

  The name of the game.

• generator :: Generator

  Properties of the generator to use for the job.

• snapshotId :: Text

  The identifier of the snapshot for which to generate code.

Instances

ToJSON StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

toJSON :: StartGeneratedCodeJob -> Value

toEncoding :: StartGeneratedCodeJob -> Encoding

toJSONList :: [StartGeneratedCodeJob] -> Value

toEncodingList :: [StartGeneratedCodeJob] -> Encoding

ToHeaders StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

toHeaders :: StartGeneratedCodeJob -> [Header]

ToPath StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

toPath :: StartGeneratedCodeJob -> ByteString

ToQuery StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

toQuery :: StartGeneratedCodeJob -> QueryString

AWSRequest StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Associated Types

type AWSResponse StartGeneratedCodeJob

Methods

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

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

Generic StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Associated Types

type Rep StartGeneratedCodeJob :: Type -> Type

Methods

from :: StartGeneratedCodeJob -> Rep StartGeneratedCodeJob x

to :: Rep StartGeneratedCodeJob x -> StartGeneratedCodeJob

Read StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

readsPrec :: Int -> ReadS StartGeneratedCodeJob

readList :: ReadS [StartGeneratedCodeJob]

readPrec :: ReadPrec StartGeneratedCodeJob

readListPrec :: ReadPrec [StartGeneratedCodeJob]

Show StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

showsPrec :: Int -> StartGeneratedCodeJob -> ShowS

show :: StartGeneratedCodeJob -> String

showList :: [StartGeneratedCodeJob] -> ShowS

NFData StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

rnf :: StartGeneratedCodeJob -> ()

Eq StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

(==) :: StartGeneratedCodeJob -> StartGeneratedCodeJob -> Bool

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

Hashable StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

hashWithSalt :: Int -> StartGeneratedCodeJob -> Int

hash :: StartGeneratedCodeJob -> Int

type AWSResponse StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

type AWSResponse StartGeneratedCodeJob = StartGeneratedCodeJobResponse

type Rep StartGeneratedCodeJob

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

type Rep StartGeneratedCodeJob = D1 ('MetaData "StartGeneratedCodeJob" "Amazonka.GamesParks.StartGeneratedCodeJob" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "StartGeneratedCodeJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "generator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Generator) :*: S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartGeneratedCodeJob

Arguments

:: Text

$sel:gameName:StartGeneratedCodeJob'

-> Generator

$sel:generator:StartGeneratedCodeJob'

-> Text

StartGeneratedCodeJob

-> StartGeneratedCodeJob

Create a value of StartGeneratedCodeJob 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:gameName:StartGeneratedCodeJob', startGeneratedCodeJob_gameName - The name of the game.

$sel:generator:StartGeneratedCodeJob', startGeneratedCodeJob_generator - Properties of the generator to use for the job.

StartGeneratedCodeJob, startGeneratedCodeJob_snapshotId - The identifier of the snapshot for which to generate code.

Request Lenses

startGeneratedCodeJob_gameName :: Lens' StartGeneratedCodeJob Text

The name of the game.

startGeneratedCodeJob_generator :: Lens' StartGeneratedCodeJob Generator

Properties of the generator to use for the job.

startGeneratedCodeJob_snapshotId :: Lens' StartGeneratedCodeJob Text

The identifier of the snapshot for which to generate code.

Destructuring the Response

data StartGeneratedCodeJobResponse

See: newStartGeneratedCodeJobResponse smart constructor.

Constructors

StartGeneratedCodeJobResponse'

Fields

• generatedCodeJobId :: Maybe Text

  The identifier of the code generation job. You can use this identifier in the GetGeneratedCodeJob operation.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartGeneratedCodeJobResponse

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Associated Types

type Rep StartGeneratedCodeJobResponse :: Type -> Type

Methods

from :: StartGeneratedCodeJobResponse -> Rep StartGeneratedCodeJobResponse x

to :: Rep StartGeneratedCodeJobResponse x -> StartGeneratedCodeJobResponse

Read StartGeneratedCodeJobResponse

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

readsPrec :: Int -> ReadS StartGeneratedCodeJobResponse

readList :: ReadS [StartGeneratedCodeJobResponse]

readPrec :: ReadPrec StartGeneratedCodeJobResponse

readListPrec :: ReadPrec [StartGeneratedCodeJobResponse]

Show StartGeneratedCodeJobResponse

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

showsPrec :: Int -> StartGeneratedCodeJobResponse -> ShowS

show :: StartGeneratedCodeJobResponse -> String

showList :: [StartGeneratedCodeJobResponse] -> ShowS

NFData StartGeneratedCodeJobResponse

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

rnf :: StartGeneratedCodeJobResponse -> ()

Eq StartGeneratedCodeJobResponse

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

Methods

(==) :: StartGeneratedCodeJobResponse -> StartGeneratedCodeJobResponse -> Bool

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

type Rep StartGeneratedCodeJobResponse

Defined in Amazonka.GamesParks.StartGeneratedCodeJob

type Rep StartGeneratedCodeJobResponse = D1 ('MetaData "StartGeneratedCodeJobResponse" "Amazonka.GamesParks.StartGeneratedCodeJob" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "StartGeneratedCodeJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "generatedCodeJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartGeneratedCodeJobResponse

Arguments

:: Int

$sel:httpStatus:StartGeneratedCodeJobResponse'

-> StartGeneratedCodeJobResponse

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

StartGeneratedCodeJobResponse, startGeneratedCodeJobResponse_generatedCodeJobId - The identifier of the code generation job. You can use this identifier in the GetGeneratedCodeJob operation.

$sel:httpStatus:StartGeneratedCodeJobResponse', startGeneratedCodeJobResponse_httpStatus - The response's http status code.

Response Lenses

startGeneratedCodeJobResponse_generatedCodeJobId :: Lens' StartGeneratedCodeJobResponse (Maybe Text)

The identifier of the code generation job. You can use this identifier in the GetGeneratedCodeJob operation.

startGeneratedCodeJobResponse_httpStatus :: Lens' StartGeneratedCodeJobResponse Int

The response's http status code.