GameLift / Client / list_builds
list_builds#
- GameLift.Client.list_builds(**kwargs)#
Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the
Status
parameter. Use the pagination parameters to retrieve results in a set of sequential pages.Note
Build resources are not listed in any particular order.
Learn more
See also: AWS API Documentation
Request Syntax
response = client.list_builds( Status='INITIALIZED'|'READY'|'FAILED', Limit=123, NextToken='string' )
- Parameters:
Status (string) –
Build status to filter results by. To retrieve all builds, leave this parameter empty.
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.
Limit (integer) – The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.NextToken (string) – A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, don’t specify a value.
- Return type:
dict
- Returns:
Response Syntax
{ 'Builds': [ { 'BuildId': 'string', 'BuildArn': 'string', 'Name': 'string', 'Version': 'string', 'Status': 'INITIALIZED'|'READY'|'FAILED', 'SizeOnDisk': 123, 'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'WINDOWS_2016'|'AMAZON_LINUX_2023', 'CreationTime': datetime(2015, 1, 1), 'ServerSdkVersion': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
Builds (list) –
A collection of build resources that match the request.
(dict) –
Properties describing a custom game build.
BuildId (string) –
A unique identifier for the build.
BuildArn (string) –
The Amazon Resource Name ( ARN) assigned to a Amazon 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 don’t need to be unique. It can be set using CreateBuild or UpdateBuild.
Version (string) –
Version information associated with a build or script. Version strings don’t 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 Amazon GameLift Server SDK version used to develop your game server.
NextToken (string) –
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
Exceptions