Skip to content

DescribeScalingPoliciesInput

Source code in docs_src/capo_gamelift/types/describe_scaling_policies_input.py
class DescribeScalingPoliciesInput(TypedDict, closed=True):
    fleet_id: NotRequired["capo_gamelift.types.fleet_id_or_arn.FleetIdOrArn"]
    """<p>A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.</p>"""
    status_filter: NotRequired[
        "capo_gamelift.types.scaling_status_type.ScalingStatusType"
    ]
    """<p>Scaling policy status to filter results on. A scaling policy is only in force when in an <code>ACTIVE</code> status.</p> <ul> <li> <p> <b>ACTIVE</b> -- The scaling policy is currently in force.</p> </li> <li> <p> <b>UPDATEREQUESTED</b> -- A request to update the scaling policy has been received.</p> </li> <li> <p> <b>UPDATING</b> -- A change is being made to the scaling policy.</p> </li> <li> <p> <b>DELETEREQUESTED</b> -- A request to delete the scaling policy has been received.</p> </li> <li> <p> <b>DELETING</b> -- The scaling policy is being deleted.</p> </li> <li> <p> <b>DELETED</b> -- The scaling policy has been deleted.</p> </li> <li> <p> <b>ERROR</b> -- An error occurred in creating the policy. It should be removed and recreated.</p> </li> </ul>"""
    limit: NotRequired["capo_gamelift.types.positive_integer.PositiveInteger"]
    """<p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>"""
    next_token: NotRequired[
        "capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"
    ]
    """<p>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.</p>"""
    location: NotRequired[
        "capo_gamelift.types.location_string_model.LocationStringModel"
    ]
    """<p> The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet. </p>"""

fleet_id instance-attribute

fleet_id: NotRequired[FleetIdOrArn]

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

limit instance-attribute

limit: NotRequired[PositiveInteger]

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

location instance-attribute

location: NotRequired[LocationStringModel]

The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet.

next_token instance-attribute

next_token: NotRequired[NonZeroAndMaxString]

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.

status_filter instance-attribute

status_filter: NotRequired[ScalingStatusType]

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.