GameLift / Client / list_fleet_deployments

list_fleet_deployments

GameLift.Client.list_fleet_deployments(**kwargs)

This API works with the following fleet types: Container

Retrieves a collection of container fleet deployments in an Amazon Web Services Region. Use the pagination parameters to retrieve results as a set of sequential pages.

Request options

  • Get a list of all deployments. Call this operation without specifying a fleet ID.

  • Get a list of all deployments for a fleet. Specify the container fleet ID or ARN value.

Results

If successful, this operation returns a list of deployments that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve.

Note

Deployments are returned starting with the latest.

See also: AWS API Documentation

Request Syntax

response = client.list_fleet_deployments(
    FleetId='string',
    Limit=123,
    NextToken='string'
)
Parameters:

  • FleetId (string) – A unique identifier for the container fleet. You can use either the fleet ID or ARN value.

  • 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, do not specify a value.

Return type:

dict

Returns:

Response Syntax

{
    'FleetDeployments': [
        {
            'DeploymentId': 'string',
            'FleetId': 'string',
            'GameServerBinaryArn': 'string',
            'RollbackGameServerBinaryArn': 'string',
            'PerInstanceBinaryArn': 'string',
            'RollbackPerInstanceBinaryArn': 'string',
            'DeploymentStatus': 'IN_PROGRESS'|'IMPAIRED'|'COMPLETE'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETE'|'CANCELLED'|'PENDING',
            'DeploymentConfiguration': {
                'ProtectionStrategy': 'WITH_PROTECTION'|'IGNORE_PROTECTION',
                'MinimumHealthyPercentage': 123,
                'ImpairmentStrategy': 'MAINTAIN'|'ROLLBACK'
            },
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • FleetDeployments (list) –

      The requested deployment information.

      • (dict) –

        Describes a container fleet deployment with updates to the fleet.

        • DeploymentId (string) –

          A unique identifier for the deployment.

        • FleetId (string) –

          A unique identifier for the container fleet.

        • GameServerBinaryArn (string) –

          The unique identifier for the version of the game server container group definition that is being deployed.

        • RollbackGameServerBinaryArn (string) –

          The unique identifier for the version of the game server container group definition to roll back to if deployment fails. Amazon GameLift Servers sets this property to the container group definition version that the fleet used when it was last active.

        • PerInstanceBinaryArn (string) –

          The unique identifier for the version of the per-instance container group definition that is being deployed.

        • RollbackPerInstanceBinaryArn (string) –

          The unique identifier for the version of the per-instance container group definition to roll back to if deployment fails. Amazon GameLift Servers sets this property to the container group definition version that the fleet used when it was last active.

        • DeploymentStatus (string) –

          The status of the fleet deployment. For per-location status, see LocationalDeployment.

          • PENDING – Amazon GameLift Servers has accepted the deployment and hasn’t started it yet.

          • IN_PROGRESS – The deployment is in progress. This status covers validation as well as the replacement of the fleet’s containers.

          • IMPAIRED – The deployment failed validation, and the fleet kept the containers that failed validation so that you can inspect them. A deployment reaches this status when its impairment strategy is MAINTAIN.

          • COMPLETE – The deployment has completed successfully in every fleet location.

          • ROLLBACK_IN_PROGRESS – The deployment failed and rollback has been initiated. A deployment reaches this status when its impairment strategy is ROLLBACK.

          • ROLLBACK_COMPLETE – The deployment failed and rollback has been completed. The fleet is running the configuration from the last successful deployment.

          • CANCELLED – The deployment was cancelled because a new deployment started for the same fleet.

          For how to debug an impaired deployment or cancel one, see Container fleet deployments.

        • DeploymentConfiguration (dict) –

          Instructions for how to deploy updates to a container fleet and what actions to take if the deployment fails.

          • ProtectionStrategy (string) –

            Determines how fleet deployment activity affects active game sessions on the fleet. A protected game session can’t be terminated while it’s active; a fleet sets the default protection for its new game sessions with NewGameSessionProtectionPolicy.

            • WITH_PROTECTION – The deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends.

            • IGNORE_PROTECTION – The deployment replaces containers regardless of game session activity, including active game sessions. This option is useful during development and testing.

            This setting also affects how long deployment validation can take. When the fleet’s NewGameSessionProtectionPolicy is FullProtection and the deployment uses WITH_PROTECTION, validation waits for protected game sessions to end.

            Default value: WITH_PROTECTION

          • MinimumHealthyPercentage (integer) –

            Sets the minimum percentage of the fleet’s game server container groups to keep healthy during deployment activity. A low value favors deployment speed; a high value favors game server availability. For example, if the fleet runs 20 game server container groups and this value is 75, Amazon GameLift Servers keeps at least 15 of them healthy, so it replaces no more than 5 at a time.

            Default value: 75

          • ImpairmentStrategy (string) –

            Determines what actions to take if a deployment fails validation. If the fleet is multi-location, this strategy applies across all fleet locations.

            • ROLLBACK – Returns all of the fleet’s containers to the last successful deployment.

            • MAINTAIN – Keeps the containers that failed validation in place so that you can inspect them, and returns all other containers to the last successful deployment. Use this option when you’re deploying a container image that you want to be able to debug on failure.

            Default value: MAINTAIN

        • 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").

    • 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