UpdateBuild - Amazon GameLift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

Learn more

Upload a Custom Server Build

All APIs by task

Request Syntax

{ "BuildId": "string", "Name": "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.


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


A unique identifier for the build to update. You can use either the build ID or ARN value.

Type: String

Pattern: ^build-\S+|^arn:.*:build\/build-\S+

Required: Yes


A descriptive label associated with a build. Build names don't need to be unique.

Type: String

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

Required: No


Version information associated with a build or script. Version strings don't need to be unique.

Type: String

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

Required: No

Response Syntax

{ "Build": { "BuildArn": "string", "BuildId": "string", "CreationTime": number, "Name": "string", "OperatingSystem": "string", "ServerSdkVersion": "string", "SizeOnDisk": number, "Status": "string", "Version": "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.


The updated build resource.

Type: Build object


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


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


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

HTTP Status Code: 400


The requested resources was not found. The resource was either not created yet or deleted.

HTTP Status Code: 400


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

HTTP Status Code: 400


Change a build resource

This example updates a build resource with a new name and version number, which are the only elements that can be changed. The returned build object verifies that the changes were made successfully.

HTTP requests are authenticated using an Amazon Signature Version 4 signature in the Authorization header field.

Sample Request

{ "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", "Name": "My_Game_Server_Build_Foo", "Version": "12345.f00" }

Sample Response

{ "Build": { "BuildArn": "arn:aws:gamelift:us-west-2::build/build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", "CreationTime": 1496708916.18, "Name": "My_Game_Server_Build_Foo", "OperatingSystem": "AMAZON_LINUX_2023", "OperatingSystem": "AMAZON_LINUX_2", "SizeOnDisk": 1304924, "Status": "READY", "Version": "12345.f00" } }

See Also

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