Menu
Amazon GameLift Service
API Reference (API Version 2015-10-01)

CreateBuild

Creates a new Amazon GameLift build from a set of game server binary files stored in an Amazon Simple Storage Service (Amazon S3) location. To use this API call, create a .zip file containing all of the files for the build and store it in an Amazon S3 bucket under your AWS account. For help on packaging your build files and creating a build, see Uploading Your Game to Amazon GameLift.

Important

Use this API action ONLY if you are storing your game build files in an Amazon S3 bucket. To create a build using files stored locally, use the CLI command upload-build , which uploads the build files from a file location you specify.

To create a new build using CreateBuild, identify the storage location and operating system of your game build. You also have the option of specifying a build name and version. If successful, this action creates a new build record with an unique build ID and in INITIALIZED status. Use the API call DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets to host your game.

Build-related operations include:

Request Syntax

Copy
{ "Name": "string", "OperatingSystem": "string", "StorageLocation": { "Bucket": "string", "Key": "string", "RoleArn": "string" }, "Version": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Name

Descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

OperatingSystem

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. If your game build contains multiple executables, they all must run on the same operating system.

Type: String

Valid Values: WINDOWS_2012 | AMAZON_LINUX

Required: No

StorageLocation

Amazon S3 location of the game build files to be uploaded. The S3 bucket must be owned by the same AWS account that you're using to manage Amazon GameLift. It also must in the same region that you want to create a new build in. Before calling CreateBuild with this location, you must allow Amazon GameLift to access your Amazon S3 bucket (see Create a Build with Files in Amazon S3).

Type: S3Location object

Required: No

Version

Version that is associated with this build. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax

Copy
{ "Build": { "BuildId": "string", "CreationTime": number, "Name": "string", "OperatingSystem": "string", "SizeOnDisk": number, "Status": "string", "Version": "string" }, "StorageLocation": { "Bucket": "string", "Key": "string", "RoleArn": "string" }, "UploadCredentials": { "AccessKeyId": "string", "SecretAccessKey": "string", "SessionToken": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Build

The newly created build record, including a unique build ID and status.

Type: Build object

StorageLocation

Amazon S3 location specified in the request.

Type: S3Location object

UploadCredentials

This element is not currently in use.

Type: AwsCredentials object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

HTTP Status Code: 400

InternalServiceException

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

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

UnauthorizedException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: