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]:
...
# accept_match method usage example with argument unpacking
kwargs: AcceptMatchInputRequestTypeDef = { # (1)
"TicketId": ...,
"PlayerIds": ...,
"AcceptanceType": ...,
}
parent.accept_match(**kwargs)
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)
...
# claim_game_server method usage example with argument unpacking
kwargs: ClaimGameServerInputRequestTypeDef = { # (1)
"GameServerGroupName": ...,
}
parent.claim_game_server(**kwargs)
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)
...
- See RoutingStrategyTypeDef
- See TagTypeDef
- See CreateAliasOutputTypeDef
# create_alias method usage example with argument unpacking
kwargs: CreateAliasInputRequestTypeDef = { # (1)
"Name": ...,
"RoutingStrategy": ...,
}
parent.create_alias(**kwargs)
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)
...
- See S3LocationTypeDef
- See OperatingSystemType
- See TagTypeDef
- See CreateBuildOutputTypeDef
# create_build method usage example with argument unpacking
kwargs: CreateBuildInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_build(**kwargs)
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)
) -> CreateFleetOutputTypeDef: # (12)
...
- See EC2InstanceTypeType
- See IpPermissionTypeDef
- See ProtectionPolicyType
- See RuntimeConfigurationTypeDef
- See ResourceCreationLimitPolicyTypeDef
- See FleetTypeType
- See CertificateConfigurationTypeDef
- See LocationConfigurationTypeDef
- See TagTypeDef
- See ComputeTypeType
- See AnywhereConfigurationTypeDef
- See CreateFleetOutputTypeDef
# create_fleet method usage example with argument unpacking
kwargs: CreateFleetInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_fleet(**kwargs)
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.
boto3 documentation
# create_fleet_locations method definition
def create_fleet_locations(
self,
*,
FleetId: str,
Locations: Sequence[LocationConfigurationTypeDef], # (1)
) -> CreateFleetLocationsOutputTypeDef: # (2)
...
# create_fleet_locations method usage example with argument unpacking
kwargs: CreateFleetLocationsInputRequestTypeDef = { # (1)
"FleetId": ...,
"Locations": ...,
}
parent.create_fleet_locations(**kwargs)
create_game_server_group#
This operation is used with the Amazon GameLift FleetIQ solution and game server groups. Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting.
Type annotations and code completion for boto3.client("gamelift").create_game_server_group
method.
boto3 documentation
# create_game_server_group method definition
def create_game_server_group(
self,
*,
GameServerGroupName: str,
RoleArn: str,
MinSize: int,
MaxSize: int,
LaunchTemplate: LaunchTemplateSpecificationTypeDef, # (1)
InstanceDefinitions: Sequence[InstanceDefinitionTypeDef], # (2)
AutoScalingPolicy: GameServerGroupAutoScalingPolicyTypeDef = ..., # (3)
BalancingStrategy: BalancingStrategyType = ..., # (4)
GameServerProtectionPolicy: GameServerProtectionPolicyType = ..., # (5)
VpcSubnets: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (6)
) -> CreateGameServerGroupOutputTypeDef: # (7)
...
- See LaunchTemplateSpecificationTypeDef
- See InstanceDefinitionTypeDef
- See GameServerGroupAutoScalingPolicyTypeDef
- See BalancingStrategyType
- See GameServerProtectionPolicyType
- See TagTypeDef
- See CreateGameServerGroupOutputTypeDef
# create_game_server_group method usage example with argument unpacking
kwargs: CreateGameServerGroupInputRequestTypeDef = { # (1)
"GameServerGroupName": ...,
"RoleArn": ...,
"MinSize": ...,
"MaxSize": ...,
"LaunchTemplate": ...,
"InstanceDefinitions": ...,
}
parent.create_game_server_group(**kwargs)
create_game_session#
Creates a multiplayer game session for players in a specific fleet location.
Type annotations and code completion for boto3.client("gamelift").create_game_session
method.
boto3 documentation
# create_game_session method definition
def create_game_session(
self,
*,
MaximumPlayerSessionCount: int,
FleetId: str = ...,
AliasId: str = ...,
Name: str = ...,
GameProperties: Sequence[GamePropertyTypeDef] = ..., # (1)
CreatorId: str = ...,
GameSessionId: str = ...,
IdempotencyToken: str = ...,
GameSessionData: str = ...,
Location: str = ...,
) -> CreateGameSessionOutputTypeDef: # (2)
...
# create_game_session method usage example with argument unpacking
kwargs: CreateGameSessionInputRequestTypeDef = { # (1)
"MaximumPlayerSessionCount": ...,
}
parent.create_game_session(**kwargs)
create_game_session_queue#
Creates a placement queue that processes requests for new game sessions.
Type annotations and code completion for boto3.client("gamelift").create_game_session_queue
method.
boto3 documentation
# create_game_session_queue method definition
def create_game_session_queue(
self,
*,
Name: str,
TimeoutInSeconds: int = ...,
PlayerLatencyPolicies: Sequence[PlayerLatencyPolicyTypeDef] = ..., # (1)
Destinations: Sequence[GameSessionQueueDestinationTypeDef] = ..., # (2)
FilterConfiguration: FilterConfigurationTypeDef = ..., # (3)
PriorityConfiguration: PriorityConfigurationTypeDef = ..., # (4)
CustomEventData: str = ...,
NotificationTarget: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (5)
) -> CreateGameSessionQueueOutputTypeDef: # (6)
...
- See PlayerLatencyPolicyTypeDef
- See GameSessionQueueDestinationTypeDef
- See FilterConfigurationTypeDef
- See PriorityConfigurationTypeDef
- See TagTypeDef
- See CreateGameSessionQueueOutputTypeDef
# create_game_session_queue method usage example with argument unpacking
kwargs: CreateGameSessionQueueInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_game_session_queue(**kwargs)
create_location#
Creates a custom location for use in an Anywhere fleet.
Type annotations and code completion for boto3.client("gamelift").create_location
method.
boto3 documentation
# create_location method definition
def create_location(
self,
*,
LocationName: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateLocationOutputTypeDef: # (2)
...
# create_location method usage example with argument unpacking
kwargs: CreateLocationInputRequestTypeDef = { # (1)
"LocationName": ...,
}
parent.create_location(**kwargs)
create_matchmaking_configuration#
Defines a new matchmaking configuration for use with FlexMatch.
Type annotations and code completion for boto3.client("gamelift").create_matchmaking_configuration
method.
boto3 documentation
# create_matchmaking_configuration method definition
def create_matchmaking_configuration(
self,
*,
Name: str,
RequestTimeoutSeconds: int,
AcceptanceRequired: bool,
RuleSetName: str,
Description: str = ...,
GameSessionQueueArns: Sequence[str] = ...,
AcceptanceTimeoutSeconds: int = ...,
NotificationTarget: str = ...,
AdditionalPlayerCount: int = ...,
CustomEventData: str = ...,
GameProperties: Sequence[GamePropertyTypeDef] = ..., # (1)
GameSessionData: str = ...,
BackfillMode: BackfillModeType = ..., # (2)
FlexMatchMode: FlexMatchModeType = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateMatchmakingConfigurationOutputTypeDef: # (5)
...
- See GamePropertyTypeDef
- See BackfillModeType
- See FlexMatchModeType
- See TagTypeDef
- See CreateMatchmakingConfigurationOutputTypeDef
# create_matchmaking_configuration method usage example with argument unpacking
kwargs: CreateMatchmakingConfigurationInputRequestTypeDef = { # (1)
"Name": ...,
"RequestTimeoutSeconds": ...,
"AcceptanceRequired": ...,
"RuleSetName": ...,
}
parent.create_matchmaking_configuration(**kwargs)
create_matchmaking_rule_set#
Creates a new rule set for FlexMatch matchmaking.
Type annotations and code completion for boto3.client("gamelift").create_matchmaking_rule_set
method.
boto3 documentation
# create_matchmaking_rule_set method definition
def create_matchmaking_rule_set(
self,
*,
Name: str,
RuleSetBody: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateMatchmakingRuleSetOutputTypeDef: # (2)
...
# create_matchmaking_rule_set method usage example with argument unpacking
kwargs: CreateMatchmakingRuleSetInputRequestTypeDef = { # (1)
"Name": ...,
"RuleSetBody": ...,
}
parent.create_matchmaking_rule_set(**kwargs)
create_player_session#
Reserves an open player slot in a game session for a player.
Type annotations and code completion for boto3.client("gamelift").create_player_session
method.
boto3 documentation
# create_player_session method definition
def create_player_session(
self,
*,
GameSessionId: str,
PlayerId: str,
PlayerData: str = ...,
) -> CreatePlayerSessionOutputTypeDef: # (1)
...
# create_player_session method usage example with argument unpacking
kwargs: CreatePlayerSessionInputRequestTypeDef = { # (1)
"GameSessionId": ...,
"PlayerId": ...,
}
parent.create_player_session(**kwargs)
create_player_sessions#
Reserves open slots in a game session for a group of players.
Type annotations and code completion for boto3.client("gamelift").create_player_sessions
method.
boto3 documentation
# create_player_sessions method definition
def create_player_sessions(
self,
*,
GameSessionId: str,
PlayerIds: Sequence[str],
PlayerDataMap: Mapping[str, str] = ...,
) -> CreatePlayerSessionsOutputTypeDef: # (1)
...
# create_player_sessions method usage example with argument unpacking
kwargs: CreatePlayerSessionsInputRequestTypeDef = { # (1)
"GameSessionId": ...,
"PlayerIds": ...,
}
parent.create_player_sessions(**kwargs)
create_script#
Creates a new script record for your Realtime Servers script.
Type annotations and code completion for boto3.client("gamelift").create_script
method.
boto3 documentation
# create_script method definition
def create_script(
self,
*,
Name: str = ...,
Version: str = ...,
StorageLocation: S3LocationTypeDef = ..., # (1)
ZipFile: Union[str, bytes, IO[Any], StreamingBody] = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateScriptOutputTypeDef: # (3)
...
- See S3LocationTypeDef
- See TagTypeDef
- See CreateScriptOutputTypeDef
# create_script method usage example with argument unpacking
kwargs: CreateScriptInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_script(**kwargs)
create_vpc_peering_authorization#
Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account.
Type annotations and code completion for boto3.client("gamelift").create_vpc_peering_authorization
method.
boto3 documentation
# create_vpc_peering_authorization method definition
def create_vpc_peering_authorization(
self,
*,
GameLiftAwsAccountId: str,
PeerVpcId: str,
) -> CreateVpcPeeringAuthorizationOutputTypeDef: # (1)
...
# create_vpc_peering_authorization method usage example with argument unpacking
kwargs: CreateVpcPeeringAuthorizationInputRequestTypeDef = { # (1)
"GameLiftAwsAccountId": ...,
"PeerVpcId": ...,
}
parent.create_vpc_peering_authorization(**kwargs)
create_vpc_peering_connection#
Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet.
Type annotations and code completion for boto3.client("gamelift").create_vpc_peering_connection
method.
boto3 documentation
# create_vpc_peering_connection method definition
def create_vpc_peering_connection(
self,
*,
FleetId: str,
PeerVpcAwsAccountId: str,
PeerVpcId: str,
) -> Dict[str, Any]:
...
# create_vpc_peering_connection method usage example with argument unpacking
kwargs: CreateVpcPeeringConnectionInputRequestTypeDef = { # (1)
"FleetId": ...,
"PeerVpcAwsAccountId": ...,
"PeerVpcId": ...,
}
parent.create_vpc_peering_connection(**kwargs)
delete_alias#
Deletes an alias.
Type annotations and code completion for boto3.client("gamelift").delete_alias
method.
boto3 documentation
# delete_alias method definition
def delete_alias(
self,
*,
AliasId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_alias method usage example with argument unpacking
kwargs: DeleteAliasInputRequestTypeDef = { # (1)
"AliasId": ...,
}
parent.delete_alias(**kwargs)
delete_build#
Deletes a build.
Type annotations and code completion for boto3.client("gamelift").delete_build
method.
boto3 documentation
# delete_build method definition
def delete_build(
self,
*,
BuildId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_build method usage example with argument unpacking
kwargs: DeleteBuildInputRequestTypeDef = { # (1)
"BuildId": ...,
}
parent.delete_build(**kwargs)
delete_fleet#
Deletes all resources and information related a fleet.
Type annotations and code completion for boto3.client("gamelift").delete_fleet
method.