UpdateScriptCommand

Suggest an Edit

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 Amazon GameLift Realtime 

Related actions

All APIs by task 

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GameLiftClient, UpdateScriptCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
// const { GameLiftClient, UpdateScriptCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
const client = new GameLiftClient(config);
const input = { // UpdateScriptInput
  ScriptId: "STRING_VALUE", // required
  Name: "STRING_VALUE",
  Version: "STRING_VALUE",
  StorageLocation: { // S3Location
    Bucket: "STRING_VALUE",
    Key: "STRING_VALUE",
    RoleArn: "STRING_VALUE",
    ObjectVersion: "STRING_VALUE",
  },
  ZipFile: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
};
const command = new UpdateScriptCommand(input);
const response = await client.send(command);
// { // UpdateScriptOutput
//   Script: { // Script
//     ScriptId: "STRING_VALUE",
//     ScriptArn: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Version: "STRING_VALUE",
//     SizeOnDisk: Number("long"),
//     CreationTime: new Date("TIMESTAMP"),
//     StorageLocation: { // S3Location
//       Bucket: "STRING_VALUE",
//       Key: "STRING_VALUE",
//       RoleArn: "STRING_VALUE",
//       ObjectVersion: "STRING_VALUE",
//     },
//   },
// };

UpdateScriptCommand Input

See UpdateScriptCommandInput for more details

Parameter
Type
Description
ScriptId
Required
string | undefined

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

Name
string | undefined

A descriptive label that is associated with a script. Script names do not need to be unique.

StorageLocation
S3Location | undefined

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.

Version
string | undefined

Version information that is associated with a build or script. Version strings do not need to be unique.

ZipFile
Uint8Array | undefined

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.

UpdateScriptCommand Output

See UpdateScriptCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Script
Script | undefined

The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the CreateScript request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.

Throws

Name
Fault
Details
InternalServiceException
server

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException
client

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException
client

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException
client

The client failed authentication. Clients should not retry such requests.

GameLiftServiceException
Base exception class for all service exceptions from GameLift service.