Skip to content

DescribeGameServerInstancesInput

Source code in docs_src/capo_gamelift/types/describe_game_server_instances_input.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class DescribeGameServerInstancesInput(TypedDict, closed=True):
    game_server_group_name: NotRequired[
        "capo_gamelift.types.game_server_group_name_or_arn.GameServerGroupNameOrArn"
    ]
    """<p>A unique identifier for the game server group. Use either the name or ARN value.</p>"""
    instance_ids: NotRequired[
        "capo_gamelift.types.game_server_instance_ids.GameServerInstanceIds"
    ]
    """<p>The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>. To retrieve all instances in the game server group, leave this parameter empty. </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>"""

game_server_group_name instance-attribute 

game_server_group_name: NotRequired[GameServerGroupNameOrArn]

A unique identifier for the game server group. Use either the name or ARN value.

instance_ids instance-attribute 

instance_ids: NotRequired[GameServerInstanceIds]

The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

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.

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.