Skip to content

DescribeFleetCapacityInput

Source code in docs_src/capo_gamelift/types/describe_fleet_capacity_input.py
class DescribeFleetCapacityInput(TypedDict, closed=True):
    fleet_ids: NotRequired["capo_gamelift.types.fleet_id_or_arn_list.FleetIdOrArnList"]
    """<p>A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.</p>"""
    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. This parameter is ignored when the request specifies one or a list of fleet IDs.</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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>"""

fleet_ids instance-attribute

fleet_ids: NotRequired[FleetIdOrArnList]

A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.

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. This parameter is ignored when the request specifies one or a list of fleet IDs.

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. This parameter is ignored when the request specifies one or a list of fleet IDs.