DescribeBuild - Amazon GameLift

DescribeBuild

Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.

Learn more

Upload a Custom Server Build

All APIs by task

Request Syntax

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

BuildId

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

Type: String

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

Required: Yes

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.

Build

Set of properties describing the requested build.

Type: Build object

Errors

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

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

View a build resource

This example retrieves the information, including current status, about a specific build.

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

Sample Request

{ "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff" }

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_One", "OperatingSystem": "AMAZON_LINUX_2", "SizeOnDisk": 1304924, "Status": "READY", "Version": "12345.678" } }

See Also

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