GameLift / Client / update_script

update_script#

GameLift.Client.update_script(**kwargs)#

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

Request Syntax

response = client.update_script(
    ScriptId='string',
    Name='string',
    Version='string',
    StorageLocation={
        'Bucket': 'string',
        'Key': 'string',
        'RoleArn': 'string',
        'ObjectVersion': 'string'
    },
    ZipFile=b'bytes'
)

Parameters:

ScriptId (string) –
[REQUIRED]

A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.
Name (string) – A descriptive label that is associated with a script. Script names do not need to be unique.
Version (string) – Version information that is associated with a build or script. Version strings do not need to be unique.
StorageLocation (dict) –
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.
- Bucket (string) –
  
  An Amazon S3 bucket identifier. Thename of the S3 bucket.
  
  Note
  Amazon GameLift doesn’t support uploading from Amazon S3 buckets with names that contain a dot (.).
- Key (string) –
  
  The name of the zip file that contains the build files or script files.
- RoleArn (string) –
  
  The Amazon Resource Name ( ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.
- ObjectVersion (string) –
  
  The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.
ZipFile (bytes) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'Script': {
        'ScriptId': 'string',
        'ScriptArn': 'string',
        'Name': 'string',
        'Version': 'string',
        'SizeOnDisk': 123,
        'CreationTime': datetime(2015, 1, 1),
        'StorageLocation': {
            'Bucket': 'string',
            'Key': 'string',
            'RoleArn': 'string',
            'ObjectVersion': 'string'
        }
    }
}

Response Structure

(dict) –
- Script (dict) –
  
  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.
  - ScriptId (string) –
    
    A unique identifier for the Realtime script
  - ScriptArn (string) –
    
    The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.
  - Name (string) –
    
    A descriptive label that is associated with a script. Script names do not need to be unique.
  - Version (string) –
    
    Version information that is associated with a build or script. Version strings do not need to be unique.
  - SizeOnDisk (integer) –
    
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at “0”.
  - CreationTime (datetime) –
    
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - StorageLocation (dict) –
    
    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.
    - Bucket (string) –
      
      An Amazon S3 bucket identifier. Thename of the S3 bucket.
      
      Note
      Amazon GameLift doesn’t support uploading from Amazon S3 buckets with names that contain a dot (.).
    - Key (string) –
      
      The name of the zip file that contains the build files or script files.
    - RoleArn (string) –
      
      The Amazon Resource Name ( ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.
    - ObjectVersion (string) –
      
      The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

Exceptions

GameLift.Client.exceptions.UnauthorizedException
GameLift.Client.exceptions.InvalidRequestException
GameLift.Client.exceptions.NotFoundException
GameLift.Client.exceptions.InternalServiceException