Build

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-schema/gamelift-build-schema.json",
  "title": "Build",
  "description": "<p>Properties describing a custom game build.</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": {
    "BuildId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BuildId"
        },
        {
          "description": "A unique identifier for the build."
        }
      ]
    },
    "BuildArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BuildArn"
        },
        {
          "description": "The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) assigned to a Amazon GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift build ARN, the resource ID matches the <i>BuildId</i> value."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FreeText"
        },
        {
          "description": "A descriptive label associated with a build. Build names don't need to be unique. It can be set using <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html\">CreateBuild</a> or <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/UpdateBuild\">UpdateBuild</a>."
        }
      ]
    },
    "Version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FreeText"
        },
        {
          "description": "Version information associated with a build or script. Version strings don't need to be unique."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BuildStatus"
        },
        {
          "description": "<p>Current status of the build.</p> <p>Possible build statuses include the following:</p> <ul> <li> <p> <b>INITIALIZED</b> -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value. </p> </li> <li> <p> <b>READY</b> -- The game build has been successfully uploaded. You can now create new fleets for this build.</p> </li> <li> <p> <b>FAILED</b> -- The game build upload failed. You cannot create new fleets for this build. </p> </li> </ul>"
        }
      ]
    },
    "SizeOnDisk": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PositiveLong"
        },
        {
          "description": "File size of the uploaded game build, expressed in bytes. When the build status is <code>INITIALIZED</code> or when using a custom Amazon S3 storage location, this value is 0."
        }
      ]
    },
    "OperatingSystem": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OperatingSystem"
        },
        {
          "description": "Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build."
        }
      ]
    },
    "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>)."
        }
      ]
    },
    "ServerSdkVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServerSdkVersion"
        },
        {
          "description": "The Amazon GameLift Server SDK version used to develop your game server."
        }
      ]
    }
  }
}