GameLift / Client / describe_scaling_policies

describe_scaling_policies

GameLift.Client.describe_scaling_policies(**kwargs)

Retrieves all scaling policies applied to a fleet.

To get a fleet’s scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.

See also: AWS API Documentation

Request Syntax

response = client.describe_scaling_policies(
    FleetId='string',
    StatusFilter='ACTIVE'|'UPDATE_REQUESTED'|'UPDATING'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'ERROR',
    Limit=123,
    NextToken='string',
    Location='string'
)

Parameters:

• FleetId (string) –

  [REQUIRED]

  A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.

• StatusFilter (string) –

  Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

  • ACTIVE – The scaling policy is currently in force.

  • UPDATEREQUESTED – A request to update the scaling policy has been received.

  • UPDATING – A change is being made to the scaling policy.

  • DELETEREQUESTED – A request to delete the scaling policy has been received.

  • DELETING – The scaling policy is being deleted.

  • DELETED – The scaling policy has been deleted.

  • ERROR – An error occurred in creating the policy. It should be removed and recreated.

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

• Location (string) – The fleet location. If you don’t specify this value, the response contains the scaling policies of every location in the fleet.

Return type:

dict

Returns:

Response Syntax

{
    'ScalingPolicies': [
        {
            'FleetId': 'string',
            'FleetArn': 'string',
            'Name': 'string',
            'Status': 'ACTIVE'|'UPDATE_REQUESTED'|'UPDATING'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'ERROR',
            'ScalingAdjustment': 123,
            'ScalingAdjustmentType': 'ChangeInCapacity'|'ExactCapacity'|'PercentChangeInCapacity',
            'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
            'Threshold': 123.0,
            'EvaluationPeriods': 123,
            'MetricName': 'ActivatingGameSessions'|'ActiveGameSessions'|'ActiveInstances'|'AvailableGameSessions'|'AvailablePlayerSessions'|'CurrentPlayerSessions'|'IdleInstances'|'PercentAvailableGameSessions'|'PercentIdleInstances'|'QueueDepth'|'WaitTime'|'ConcurrentActivatableGameSessions',
            'PolicyType': 'RuleBased'|'TargetBased',
            'TargetConfiguration': {
                'TargetValue': 123.0
            },
            'UpdateStatus': 'PENDING_UPDATE',
            'Location': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ScalingPolicies (list) –

    A collection of objects containing the scaling policies matching the request.

    • (dict) –

      Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

      • FleetId (string) –

        A unique identifier for the fleet that is associated with this scaling policy.

      • FleetArn (string) –

        The Amazon Resource Name ( ARN) that is assigned to a Amazon 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.

      • Name (string) –

        A descriptive label that is associated with a fleet’s scaling policy. Policy names do not need to be unique.

      • Status (string) –

        Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.

        • ACTIVE – The scaling policy can be used for auto-scaling a fleet.

        • UPDATE_REQUESTED – A request to update the scaling policy has been received.

        • UPDATING – A change is being made to the scaling policy.

        • DELETE_REQUESTED – A request to delete the scaling policy has been received.

        • DELETING – The scaling policy is being deleted.

        • DELETED – The scaling policy has been deleted.

        • ERROR – An error occurred in creating the policy. It should be removed and recreated.

      • ScalingAdjustment (integer) –

        Amount of adjustment to make, based on the scaling adjustment type.

      • ScalingAdjustmentType (string) –

        The type of adjustment to make to a fleet’s instance count.

        • ChangeInCapacity – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.

        • ExactCapacity – set the instance count to the scaling adjustment value.

        • PercentChangeInCapacity – increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.

      • ComparisonOperator (string) –

        Comparison operator to use when measuring a metric against the threshold value.

      • Threshold (float) –

        Metric value used to trigger a scaling event.

      • EvaluationPeriods (integer) –

        Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

      • MetricName (string) –

        Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

        • ActivatingGameSessions – Game sessions in the process of being created.

        • ActiveGameSessions – Game sessions that are currently running.

        • ActiveInstances – Fleet instances that are currently running at least one game session.

        • AvailableGameSessions – Additional game sessions that fleet could host simultaneously, given current capacity.

        • AvailablePlayerSessions – Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.

        • CurrentPlayerSessions – Player slots in active game sessions that are being used by a player or are reserved for a player.

        • IdleInstances – Active instances that are currently hosting zero game sessions.

        • PercentAvailableGameSessions – Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.

        • PercentIdleInstances – Percentage of the total number of active instances that are hosting zero game sessions.

        • QueueDepth – Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

        • WaitTime – Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

      • PolicyType (string) –

        The type of scaling policy to create. For a target-based policy, set the parameter MetricName to ‘PercentAvailableGameSessions’ and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

      • TargetConfiguration (dict) –

        An object that contains settings for a target-based scaling policy.

        • TargetValue (float) –

          Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet’s buffer (the percent of capacity that should be idle and ready for new game sessions).

      • UpdateStatus (string) –

        The current status of the fleet’s scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

      • Location (string) –

        The fleet location.

  • 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

• GameLift.Client.exceptions.InternalServiceException

• GameLift.Client.exceptions.InvalidRequestException

• GameLift.Client.exceptions.UnauthorizedException

• GameLift.Client.exceptions.NotFoundException

• GameLift.Client.exceptions.UnsupportedRegionException