GameLift / Client / start_fleet_actions

start_fleet_actions#

GameLift.Client.start_fleet_actions(**kwargs)#

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet’s auto-scaling activity.

This operation can be used in the following ways:

  • To restart actions on instances in the fleet’s home Region, provide a fleet ID and the type of actions to resume.

  • To restart actions on instances in one of the fleet’s remote locations, provide a fleet ID, a location name, and the type of actions to resume.

If successful, GameLift once again initiates scaling events as triggered by the fleet’s scaling policies. If actions on the fleet location were never stopped, this operation will have no effect.

Learn more

Setting up GameLift fleets

See also: AWS API Documentation

Request Syntax

response = client.start_fleet_actions(
    FleetId='string',
    Actions=[
        'AUTO_SCALING',
    ],
    Location='string'
)
Parameters:

  • FleetId (string) –

    [REQUIRED]

    A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.

  • Actions (list) –

    [REQUIRED]

    List of actions to restart on the fleet.

    • (string) –

  • Location (string) – The fleet location to restart fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Return type:

dict

Returns:

Response Syntax

{
    'FleetId': 'string',
    'FleetArn': 'string'
}

Response Structure

  • (dict) –

    • FleetId (string) –

      A unique identifier for the fleet to restart actions on.

    • FleetArn (string) –

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

Exceptions

  • GameLift.Client.exceptions.InternalServiceException

  • GameLift.Client.exceptions.InvalidRequestException

  • GameLift.Client.exceptions.UnauthorizedException

  • GameLift.Client.exceptions.NotFoundException

  • GameLift.Client.exceptions.UnsupportedRegionException