describe_build

describe_build(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_build(
    BuildId='string'
)

Parameters

BuildId (string) --

[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'Build': {
        'BuildId': 'string',
        'BuildArn': 'string',
        'Name': 'string',
        'Version': 'string',
        'Status': 'INITIALIZED'|'READY'|'FAILED',
        'SizeOnDisk': 123,
        'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2',
        'CreationTime': datetime(2015, 1, 1),
        'ServerSdkVersion': 'string'
    }
}

Response Structure

• (dict) --
  • Build (dict) --

    Set of properties describing the requested build.

    • BuildId (string) --

      A unique identifier for the build.

    • BuildArn (string) --

      The Amazon Resource Name ( ARN ) assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift build ARN, the resource ID matches the BuildId value.

    • Name (string) --

      A descriptive label associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

    • Version (string) --

      Version information associated with a build or script. Version strings do not need to be unique.

    • Status (string) --

      Current status of the build.

      Possible build statuses include the following:

      • INITIALIZED -- 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.
      • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.
      • FAILED -- The game build upload failed. You cannot create new fleets for this build.
    • SizeOnDisk (integer) --

      File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED or when using a custom Amazon S3 storage location, this value is 0.

    • OperatingSystem (string) --

      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 (datetime) --

      A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

    • ServerSdkVersion (string) --

      The GameLift Server SDK version used to develop your game server.

Exceptions

• GameLift.Client.exceptions.UnauthorizedException
• GameLift.Client.exceptions.InvalidRequestException
• GameLift.Client.exceptions.NotFoundException
• GameLift.Client.exceptions.InternalServiceException