GameLift / Paginator / ListFleetDeployments

ListFleetDeployments

class GameLift.Paginator.ListFleetDeployments

paginator = client.get_paginator('list_fleet_deployments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GameLift.Client.list_fleet_deployments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FleetId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.

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

      • DeploymentStatus (string) –

        The status of fleet deployment activity in the location.

        • IN_PROGRESS – The deployment is in progress.

        • IMPAIRED – The deployment failed and the fleet has some impaired containers.

        • COMPLETE – The deployment has completed successfully.

        • ROLLBACK_IN_PROGRESS – The deployment failed and rollback has been initiated.

        • ROLLBACK_IN_COMPLETE – The deployment failed and rollback has been completed.

        • CANCELLED – The deployment was cancelled.

      • 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. With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.

        • MinimumHealthyPercentage (integer) –

          Sets a minimum level of healthy tasks to maintain during deployment activity.

        • ImpairmentStrategy (string) –

          Determines what actions to take if a deployment fails. If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.

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