Skip to content

DescribeInstancesInput

Source code in docs_src/capo_gamelift/types/describe_instances_input.py
class DescribeInstancesInput(TypedDict, closed=True):
    fleet_id: NotRequired["capo_gamelift.types.fleet_id_or_arn.FleetIdOrArn"]
    """<p>A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.</p>"""
    instance_id: NotRequired["capo_gamelift.types.instance_id.InstanceId"]
    """<p>A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.</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.</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 name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. </p>"""

fleet_id instance-attribute

fleet_id: NotRequired[FleetIdOrArn]

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

instance_id instance-attribute

instance_id: NotRequired[InstanceId]

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

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 name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

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.