GameLift / Client / delete_container_group_definition

delete_container_group_definition#

GameLift.Client.delete_container_group_definition(**kwargs)#

Deletes a container group definition. You can delete a container group definition if there are no fleets using the definition.

Delete an entire container group definition, including all versions. Specify the container group definition name, or use an ARN value without the version number.
Delete a particular version. Specify the container group definition name and a version number, or use an ARN value that includes the version number.
Keep the newest versions and delete all older versions. Specify the container group definition name and the number of versions to retain. For example, set VersionCountToRetain to 5 to delete all but the five most recent versions.

response = client.delete_container_group_definition(
    Name='string',
    VersionNumber=123,
    VersionCountToRetain=123
)

Parameters:

Name (string) –
[REQUIRED]

The unique identifier for the container group definition to delete. You can use either the Name or ARN value.
VersionNumber (integer) – The specific version to delete.
VersionCountToRetain (integer) – The number of most recent versions to keep while deleting all older versions.

Return type:

dict

Returns:

{}