Skip to content

GameLiftClient#

Index > GameLift > GameLiftClient

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

GameLiftClient#

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

# GameLiftClient usage example

from boto3.session import Session
from mypy_boto3_gamelift.client import GameLiftClient

def get_gamelift_client() -> GameLiftClient:
    return Session().client("gamelift")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("gamelift").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("gamelift")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.FleetCapacityExceededException,
    client.exceptions.GameSessionFullException,
    client.exceptions.IdempotentParameterMismatchException,
    client.exceptions.InternalServiceException,
    client.exceptions.InvalidFleetStatusException,
    client.exceptions.InvalidGameSessionStatusException,
    client.exceptions.InvalidRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.NotFoundException,
    client.exceptions.OutOfCapacityException,
    client.exceptions.TaggingFailedException,
    client.exceptions.TerminalRoutingStrategyException,
    client.exceptions.UnauthorizedException,
    client.exceptions.UnsupportedRegionException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_gamelift.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

accept_match#

Registers a player's acceptance or rejection of a proposed FlexMatch match.

Type annotations and code completion for boto3.client("gamelift").accept_match method. boto3 documentation

# accept_match method definition

def accept_match(
    self,
    *,
    TicketId: str,
    PlayerIds: Sequence[str],
    AcceptanceType: AcceptanceTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See AcceptanceTypeType
# accept_match method usage example with argument unpacking

kwargs: AcceptMatchInputRequestTypeDef = {  # (1)
    "TicketId": ...,
    "PlayerIds": ...,
    "AcceptanceType": ...,
}

parent.accept_match(**kwargs)
  1. See AcceptMatchInputRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("gamelift").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

claim_game_server#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups. Locates an available game server and temporarily reserves it to host gameplay and players.

Type annotations and code completion for boto3.client("gamelift").claim_game_server method. boto3 documentation

# claim_game_server method definition

def claim_game_server(
    self,
    *,
    GameServerGroupName: str,
    GameServerId: str = ...,
    GameServerData: str = ...,
    FilterOption: ClaimFilterOptionTypeDef = ...,  # (1)
) -> ClaimGameServerOutputTypeDef:  # (2)
    ...
  1. See ClaimFilterOptionTypeDef
  2. See ClaimGameServerOutputTypeDef
# claim_game_server method usage example with argument unpacking

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

parent.claim_game_server(**kwargs)
  1. See ClaimGameServerInputRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("gamelift").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_alias#

Creates an alias for a fleet.

Type annotations and code completion for boto3.client("gamelift").create_alias method. boto3 documentation

# create_alias method definition

def create_alias(
    self,
    *,
    Name: str,
    RoutingStrategy: RoutingStrategyTypeDef,  # (1)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateAliasOutputTypeDef:  # (3)
    ...
  1. See RoutingStrategyTypeDef
  2. See TagTypeDef
  3. See CreateAliasOutputTypeDef
# create_alias method usage example with argument unpacking

kwargs: CreateAliasInputRequestTypeDef = {  # (1)
    "Name": ...,
    "RoutingStrategy": ...,
}

parent.create_alias(**kwargs)
  1. See CreateAliasInputRequestTypeDef

create_build#

Creates a new Amazon GameLift build resource for your game server binary files.

Type annotations and code completion for boto3.client("gamelift").create_build method. boto3 documentation

# create_build method definition

def create_build(
    self,
    *,
    Name: str = ...,
    Version: str = ...,
    StorageLocation: S3LocationTypeDef = ...,  # (1)
    OperatingSystem: OperatingSystemType = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    ServerSdkVersion: str = ...,
) -> CreateBuildOutputTypeDef:  # (4)
    ...
  1. See S3LocationTypeDef
  2. See OperatingSystemType
  3. See TagTypeDef
  4. See CreateBuildOutputTypeDef
# create_build method usage example with argument unpacking

kwargs: CreateBuildInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_build(**kwargs)
  1. See CreateBuildInputRequestTypeDef

create_fleet#

Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your custom game server or Realtime Servers.

Type annotations and code completion for boto3.client("gamelift").create_fleet method. boto3 documentation

# create_fleet method definition

def create_fleet(
    self,
    *,
    Name: str,
    Description: str = ...,
    BuildId: str = ...,
    ScriptId: str = ...,
    ServerLaunchPath: str = ...,
    ServerLaunchParameters: str = ...,
    LogPaths: Sequence[str] = ...,
    EC2InstanceType: EC2InstanceTypeType = ...,  # (1)
    EC2InboundPermissions: Sequence[IpPermissionTypeDef] = ...,  # (2)
    NewGameSessionProtectionPolicy: ProtectionPolicyType = ...,  # (3)
    RuntimeConfiguration: RuntimeConfigurationTypeDef = ...,  # (4)
    ResourceCreationLimitPolicy: ResourceCreationLimitPolicyTypeDef = ...,  # (5)
    MetricGroups: Sequence[str] = ...,
    PeerVpcAwsAccountId: str = ...,
    PeerVpcId: str = ...,
    FleetType: FleetTypeType = ...,  # (6)
    InstanceRoleArn: str = ...,
    CertificateConfiguration: CertificateConfigurationTypeDef = ...,  # (7)
    Locations: Sequence[LocationConfigurationTypeDef] = ...,  # (8)
    Tags: Sequence[TagTypeDef] = ...,  # (9)
    ComputeType: ComputeTypeType = ...,  # (10)
    AnywhereConfiguration: AnywhereConfigurationTypeDef = ...,  # (11)
    InstanceRoleCredentialsProvider: InstanceRoleCredentialsProviderType = ...,  # (12)
) -> CreateFleetOutputTypeDef:  # (13)
    ...
  1. See EC2InstanceTypeType
  2. See IpPermissionTypeDef
  3. See ProtectionPolicyType
  4. See RuntimeConfigurationTypeDef
  5. See ResourceCreationLimitPolicyTypeDef
  6. See FleetTypeType
  7. See CertificateConfigurationTypeDef
  8. See LocationConfigurationTypeDef
  9. See TagTypeDef
  10. See ComputeTypeType
  11. See AnywhereConfigurationTypeDef
  12. See InstanceRoleCredentialsProviderType
  13. See CreateFleetOutputTypeDef
# create_fleet method usage example with argument unpacking

kwargs: CreateFleetInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_fleet(**kwargs)
  1. See CreateFleetInputRequestTypeDef

create_fleet_locations#

Adds remote locations to a fleet and begins populating the new locations with EC2 instances.

Type annotations and code completion for boto3.client("gamelift").create_fleet_locations method.