/AWS1/CL_GML=>UPDATESCRIPT()

About UpdateScript

Updates Realtime script metadata and content.

To update script metadata, specify the script ID and provide updated name and/or version values.

To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.

If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

Method Signature

IMPORTING

Required arguments:

IV_SCRIPTID TYPE /AWS1/GMLSCRIPTIDORARN /AWS1/GMLSCRIPTIDORARN

A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.

Optional arguments:

IV_NAME TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

A descriptive label that is associated with a script. Script names don't need to be unique.

IV_VERSION TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

Version information associated with a build or script. Version strings don't need to be unique.

IO_STORAGELOCATION TYPE REF TO /AWS1/CL_GMLS3LOCATION /AWS1/CL_GMLS3LOCATION

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.

IV_ZIPFILE TYPE /AWS1/GMLZIPBLOB /AWS1/GMLZIPBLOB

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_GMLUPDATESCRIPTOUTPUT /AWS1/CL_GMLUPDATESCRIPTOUTPUT