Amazon GameLift · JSON Structure

Gamelift Script Structure

Properties describing a Realtime script.

Related actions

All APIs by task

Type: object Properties: 7
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

Script is a JSON Structure definition published by Amazon GameLift, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ScriptId ScriptArn Name Version SizeOnDisk CreationTime StorageLocation

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-script-structure.json",
  "name": "Script",
  "description": "<p>Properties describing a Realtime script.</p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>",
  "type": "object",
  "properties": {
    "ScriptId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScriptId"
        },
        {
          "description": "A unique identifier for the Realtime script"
        }
      ]
    },
    "ScriptArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScriptArn"
        },
        {
          "description": "The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) 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 <i>ScriptId</i> value."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A descriptive label that is associated with a script. Script names don't need to be unique."
        }
      ]
    },
    "Version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "Version information associated with a build or script. Version strings don't need to be unique."
        }
      ]
    },
    "SizeOnDisk": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PositiveLong"
        },
        {
          "description": "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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example <code>\"1469498468.057\"</code>)."
        }
      ]
    },
    "StorageLocation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Location"
        },
        {
          "description": "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 <code>ObjectVersion</code> parameter to specify an earlier version. "
        }
      ]
    }
  }
}