GameLift / Client / stop_fleet_actions

stop_fleet_actions#

GameLift.Client.stop_fleet_actions(**kwargs)#

Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.

Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.

This operation can be used in the following ways:

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

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

If successful, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

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

  • Actions (list) –

    [REQUIRED]

    List of actions to suspend on the fleet.

    • (string) –

  • Location (string) – The fleet location to stop 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 stop 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