# UpdateBuild
<a name="API_UpdateBuild"></a>

 **This API works with the following fleet types:** EC2

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](https://docs.amazonaws.cn/gamelift/latest/developerguide/gamelift-build-intro.html) 

 [All APIs by task](https://docs.amazonaws.cn/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) 

## Request Syntax
<a name="API_UpdateBuild_RequestSyntax"></a>

```
{
   "BuildId": "string",
   "Name": "string",
   "Version": "string"
}
```

## Request Parameters
<a name="API_UpdateBuild_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

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

 ** [BuildId](#API_UpdateBuild_RequestSyntax) **   <a name="gameliftservers-UpdateBuild-request-BuildId"></a>
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

 ** [Name](#API_UpdateBuild_RequestSyntax) **   <a name="gameliftservers-UpdateBuild-request-Name"></a>
A descriptive label that is associated with a build. Build names do not need to be unique.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [Version](#API_UpdateBuild_RequestSyntax) **   <a name="gameliftservers-UpdateBuild-request-Version"></a>
Version information that is associated with a build or script. Version strings do not need to be unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_UpdateBuild_ResponseSyntax"></a>

```
{
   "Build": { 
      "BuildArn": "string",
      "BuildId": "string",
      "CreationTime": number,
      "Name": "string",
      "OperatingSystem": "string",
      "ServerSdkVersion": "string",
      "SizeOnDisk": number,
      "Status": "string",
      "Version": "string"
   }
}
```

## Response Elements
<a name="API_UpdateBuild_ResponseElements"></a>

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](#API_UpdateBuild_ResponseSyntax) **   <a name="gameliftservers-UpdateBuild-response-Build"></a>
The updated build resource.  
Type: [Build](API_Build.md) object

## Errors
<a name="API_UpdateBuild_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** NotFoundException **   
The requested resources was not found. The resource was either not created yet or deleted.  
HTTP Status Code: 400

 ** UnauthorizedException **   
The client failed authentication. Clients should not retry such requests.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateBuild_Examples"></a>

### Change a build resource
<a name="API_UpdateBuild_Example_1"></a>

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](https://docs.amazonaws.cn/general/latest/gr/signature-version-4.html) signature in the `Authorization` header field.

#### Sample Request
<a name="API_UpdateBuild_Example_1_Request"></a>

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

#### Sample Response
<a name="API_UpdateBuild_Example_1_Response"></a>

```
{
    "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",
        "SizeOnDisk": 1304924, 
        "Status": "READY", 
        "Version": "12345.f00"
    }
}
```

## See Also
<a name="API_UpdateBuild_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/gamelift-2015-10-01/UpdateBuild) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/gamelift-2015-10-01/UpdateBuild) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/gamelift-2015-10-01/UpdateBuild) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/gamelift-2015-10-01/UpdateBuild) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/gamelift-2015-10-01/UpdateBuild) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/gamelift-2015-10-01/UpdateBuild) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/gamelift-2015-10-01/UpdateBuild) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/gamelift-2015-10-01/UpdateBuild) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/gamelift-2015-10-01/UpdateBuild) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/gamelift-2015-10-01/UpdateBuild)