Skip to content

Paginators#

Index > GameLift > Paginators

Auto-generated documentation for GameLift type annotations stubs module mypy-boto3-gamelift.

DescribeFleetAttributesPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_fleet_attributes"). boto3 documentation

# DescribeFleetAttributesPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeFleetAttributesPaginator

def get_describe_fleet_attributes_paginator() -> DescribeFleetAttributesPaginator:
    return Session().client("gamelift").get_paginator("describe_fleet_attributes")
# DescribeFleetAttributesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeFleetAttributesPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeFleetAttributesPaginator = client.get_paginator("describe_fleet_attributes")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeFleetAttributesPaginator
  3. item: DescribeFleetAttributesOutputTypeDef

paginate#

Type annotations and code completion for DescribeFleetAttributesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    FleetIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeFleetAttributesOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeFleetAttributesOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeFleetAttributesInputDescribeFleetAttributesPaginateTypeDef = {  # (1)
    "FleetIds": ...,
}

parent.paginate(**kwargs)
  1. See DescribeFleetAttributesInputDescribeFleetAttributesPaginateTypeDef

DescribeFleetCapacityPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_fleet_capacity"). boto3 documentation

# DescribeFleetCapacityPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeFleetCapacityPaginator

def get_describe_fleet_capacity_paginator() -> DescribeFleetCapacityPaginator:
    return Session().client("gamelift").get_paginator("describe_fleet_capacity")
# DescribeFleetCapacityPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeFleetCapacityPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeFleetCapacityPaginator = client.get_paginator("describe_fleet_capacity")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeFleetCapacityPaginator
  3. item: DescribeFleetCapacityOutputTypeDef

paginate#

Type annotations and code completion for DescribeFleetCapacityPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    FleetIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeFleetCapacityOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeFleetCapacityOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeFleetCapacityInputDescribeFleetCapacityPaginateTypeDef = {  # (1)
    "FleetIds": ...,
}

parent.paginate(**kwargs)
  1. See DescribeFleetCapacityInputDescribeFleetCapacityPaginateTypeDef

DescribeFleetEventsPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_fleet_events"). boto3 documentation

# DescribeFleetEventsPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeFleetEventsPaginator

def get_describe_fleet_events_paginator() -> DescribeFleetEventsPaginator:
    return Session().client("gamelift").get_paginator("describe_fleet_events")
# DescribeFleetEventsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeFleetEventsPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeFleetEventsPaginator = client.get_paginator("describe_fleet_events")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeFleetEventsPaginator
  3. item: DescribeFleetEventsOutputTypeDef

paginate#

Type annotations and code completion for DescribeFleetEventsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    FleetId: str,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeFleetEventsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeFleetEventsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeFleetEventsInputDescribeFleetEventsPaginateTypeDef = {  # (1)
    "FleetId": ...,
}

parent.paginate(**kwargs)
  1. See DescribeFleetEventsInputDescribeFleetEventsPaginateTypeDef

DescribeFleetUtilizationPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_fleet_utilization"). boto3 documentation

# DescribeFleetUtilizationPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeFleetUtilizationPaginator

def get_describe_fleet_utilization_paginator() -> DescribeFleetUtilizationPaginator:
    return Session().client("gamelift").get_paginator("describe_fleet_utilization")
# DescribeFleetUtilizationPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeFleetUtilizationPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeFleetUtilizationPaginator = client.get_paginator("describe_fleet_utilization")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeFleetUtilizationPaginator
  3. item: DescribeFleetUtilizationOutputTypeDef

paginate#

Type annotations and code completion for DescribeFleetUtilizationPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    FleetIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeFleetUtilizationOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeFleetUtilizationOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeFleetUtilizationInputDescribeFleetUtilizationPaginateTypeDef = {  # (1)
    "FleetIds": ...,
}

parent.paginate(**kwargs)
  1. See DescribeFleetUtilizationInputDescribeFleetUtilizationPaginateTypeDef

DescribeGameServerInstancesPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_game_server_instances"). boto3 documentation

# DescribeGameServerInstancesPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeGameServerInstancesPaginator

def get_describe_game_server_instances_paginator() -> DescribeGameServerInstancesPaginator:
    return Session().client("gamelift").get_paginator("describe_game_server_instances")
# DescribeGameServerInstancesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeGameServerInstancesPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeGameServerInstancesPaginator = client.get_paginator("describe_game_server_instances")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeGameServerInstancesPaginator
  3. item: DescribeGameServerInstancesOutputTypeDef

paginate#

Type annotations and code completion for DescribeGameServerInstancesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    GameServerGroupName: str,
    InstanceIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeGameServerInstancesOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeGameServerInstancesOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeGameServerInstancesInputDescribeGameServerInstancesPaginateTypeDef = {  # (1)
    "GameServerGroupName": ...,
}

parent.paginate(**kwargs)
  1. See DescribeGameServerInstancesInputDescribeGameServerInstancesPaginateTypeDef

DescribeGameSessionDetailsPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_game_session_details"). boto3 documentation

# DescribeGameSessionDetailsPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeGameSessionDetailsPaginator

def get_describe_game_session_details_paginator() -> DescribeGameSessionDetailsPaginator:
    return Session().client("gamelift").get_paginator("describe_game_session_details")
# DescribeGameSessionDetailsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeGameSessionDetailsPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeGameSessionDetailsPaginator = client.get_paginator("describe_game_session_details")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeGameSessionDetailsPaginator
  3. item: DescribeGameSessionDetailsOutputTypeDef

paginate#

Type annotations and code completion for DescribeGameSessionDetailsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    FleetId: str = ...,
    GameSessionId: str = ...,
    AliasId: str = ...,
    Location: str = ...,
    StatusFilter: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeGameSessionDetailsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeGameSessionDetailsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeGameSessionDetailsInputDescribeGameSessionDetailsPaginateTypeDef = {  # (1)
    "FleetId": ...,
}

parent.paginate(**kwargs)
  1. See DescribeGameSessionDetailsInputDescribeGameSessionDetailsPaginateTypeDef

DescribeGameSessionQueuesPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_game_session_queues"). boto3 documentation

# DescribeGameSessionQueuesPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeGameSessionQueuesPaginator

def get_describe_game_session_queues_paginator() -> DescribeGameSessionQueuesPaginator:
    return Session().client("gamelift").get_paginator("describe_game_session_queues")
# DescribeGameSessionQueuesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeGameSessionQueuesPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeGameSessionQueuesPaginator = client.get_paginator("describe_game_session_queues")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeGameSessionQueuesPaginator
  3. item: DescribeGameSessionQueuesOutputPaginatorTypeDef

paginate#

Type annotations and code completion for DescribeGameSessionQueuesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Names: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeGameSessionQueuesOutputPaginatorTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeGameSessionQueuesOutputPaginatorTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeGameSessionQueuesInputDescribeGameSessionQueuesPaginateTypeDef = {  # (1)
    "Names": ...,
}

parent.paginate(**kwargs)
  1. See DescribeGameSessionQueuesInputDescribeGameSessionQueuesPaginateTypeDef

DescribeGameSessionsPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_game_sessions"). boto3 documentation

# DescribeGameSessionsPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeGameSessionsPaginator

def get_describe_game_sessions_paginator() -> DescribeGameSessionsPaginator:
    return Session().client("gamelift").get_paginator("describe_game_sessions")
# DescribeGameSessionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeGameSessionsPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeGameSessionsPaginator = client.get_paginator("describe_game_sessions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeGameSessionsPaginator
  3. item: DescribeGameSessionsOutputTypeDef

paginate#

Type annotations and code completion for DescribeGameSessionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    FleetId: str = ...,
    GameSessionId: str = ...,
    AliasId: str = ...,
    Location: str = ...,
    StatusFilter: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeGameSessionsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeGameSessionsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeGameSessionsInputDescribeGameSessionsPaginateTypeDef = {  # (1)
    "FleetId": ...,
}

parent.paginate(**kwargs)
  1. See DescribeGameSessionsInputDescribeGameSessionsPaginateTypeDef

DescribeInstancesPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_instances"). boto3 documentation

# DescribeInstancesPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeInstancesPaginator

def get_describe_instances_paginator() -> DescribeInstancesPaginator:
    return Session().client("gamelift").get_paginator("describe_instances")
# DescribeInstancesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeInstancesPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeInstancesPaginator = client.get_paginator("describe_instances")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeInstancesPaginator
  3. item: DescribeInstancesOutputTypeDef

paginate#

Type annotations and code completion for DescribeInstancesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    FleetId: str,
    InstanceId: str = ...,
    Location: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeInstancesOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeInstancesOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeInstancesInputDescribeInstancesPaginateTypeDef = {  # (1)
    "FleetId": ...,
}

parent.paginate(**kwargs)
  1. See DescribeInstancesInputDescribeInstancesPaginateTypeDef

DescribeMatchmakingConfigurationsPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_matchmaking_configurations"). boto3 documentation

# DescribeMatchmakingConfigurationsPaginator usage example

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeMatchmakingConfigurationsPaginator

def get_describe_matchmaking_configurations_paginator() -> DescribeMatchmakingConfigurationsPaginator:
    return Session().client("gamelift").get_paginator("describe_matchmaking_configurations")
# DescribeMatchmakingConfigurationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_gamelift.paginator import DescribeMatchmakingConfigurationsPaginator

session = Session()

client = Session().client("gamelift")  # (1)
paginator: DescribeMatchmakingConfigurationsPaginator = client.get_paginator("describe_matchmaking_configurations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GameLiftClient
  2. paginator: DescribeMatchmakingConfigurationsPaginator
  3. item: DescribeMatchmakingConfigurationsOutputTypeDef

paginate#

Type annotations and code completion for DescribeMatchmakingConfigurationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Names: Sequence[str] = ...,
    RuleSetName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeMatchmakingConfigurationsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeMatchmakingConfigurationsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeMatchmakingConfigurationsInputDescribeMatchmakingConfigurationsPaginateTypeDef = {  # (1)
    "Names": ...,
}

parent.paginate(**kwargs)
  1. See DescribeMatchmakingConfigurationsInputDescribeMatchmakingConfigurationsPaginateTypeDef

DescribeMatchmakingRuleSetsPaginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator("describe_matchmaking_rule_sets").