GameLift / Client / create_script

create_script#

GameLift.Client.create_script(**kwargs)#

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.

To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:

  • A locally available directory. Use the ZipFile parameter for this option.

  • An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You’ll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.

If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record’s storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.

Learn more

Amazon GameLift Realtime Servers

Set Up a Role for Amazon GameLift Access

Related actions

All APIs by task

See also: AWS API Documentation

Request Syntax

response = client.create_script(
    Name='string',
    Version='string',
    StorageLocation={
        'Bucket': 'string',
        'Key': 'string',
        'RoleArn': 'string',
        'ObjectVersion': 'string'
    },
    ZipFile=b'bytes',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Name (string) – A descriptive label that is associated with a script. Script names don’t need to be unique. You can use UpdateScript to change this value later.

  • Version (string) – Version information associated with a build or script. Version strings don’t need to be unique. You can use UpdateScript to change this value later.

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

  • Tags (list) –

    A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.

    • (dict) –

      A label that you can assign to a Amazon GameLift resource.

      Learn more

      Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

      Amazon Web Services Tagging Strategies

      Related actions

      All APIs by task

      • Key (string) – [REQUIRED]

        The key for a developer-defined key value pair for tagging an Amazon Web Services resource.

      • Value (string) – [REQUIRED]

        The value for a developer-defined key value pair for tagging an Amazon Web Services resource.

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 and ARN. 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 don’t need to be unique.

      • Version (string) –

        Version information associated with a build or script. Version strings don’t 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