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

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.

Usage example
client = boto3.client("gamelift")

try:
    do_something(client)
except (
    client.ClientError,
    client.ConflictException,
    client.FleetCapacityExceededException,
    client.GameSessionFullException,
    client.IdempotentParameterMismatchException,
    client.InternalServiceException,
    client.InvalidFleetStatusException,
    client.InvalidGameSessionStatusException,
    client.InvalidRequestException,
    client.LimitExceededException,
    client.NotFoundException,
    client.OutOfCapacityException,
    client.TaggingFailedException,
    client.TerminalRoutingStrategyException,
    client.UnauthorizedException,
    client.UnsupportedRegionException,
) as e:
    print(e)
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

Method definition
def accept_match(
    self,
    *,
    TicketId: str,
    PlayerIds: Sequence[str],
    AcceptanceType: AcceptanceTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See AcceptanceTypeType
Usage example with kwargs
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

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

claim_game_server

This operation is used with the 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

Method definition
def claim_game_server(
    self,
    *,
    GameServerGroupName: str,
    GameServerId: str = ...,
    GameServerData: str = ...,
) -> ClaimGameServerOutputTypeDef:  # (1)
    ...
  1. See ClaimGameServerOutputTypeDef
Usage example with kwargs
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

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

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
Usage example with kwargs
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

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
Usage example with kwargs
kwargs: CreateBuildInputRequestTypeDef = {  # (1)
    "Name": ...,
}

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

create_fleet

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

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

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)
    ...
  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 CreateFleetOutputTypeDef
Usage example with kwargs
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. boto3 documentation

Method definition
def create_fleet_locations(
    self,
    *,
    FleetId: str,
    Locations: Sequence[LocationConfigurationTypeDef],  # (1)
) -> CreateFleetLocationsOutputTypeDef:  # (2)
    ...
  1. See LocationConfigurationTypeDef
  2. See CreateFleetLocationsOutputTypeDef
Usage example with kwargs
kwargs: CreateFleetLocationsInputRequestTypeDef = {  # (1)
    "FleetId": ...,
    "Locations": ...,
}

parent.create_fleet_locations(**kwargs)
  1. See CreateFleetLocationsInputRequestTypeDef

create_game_server_group

This operation is used with the GameLift FleetIQ solution and game server groups. Creates a 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

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)
    ...
  1. See LaunchTemplateSpecificationTypeDef
  2. See InstanceDefinitionTypeDef
  3. See GameServerGroupAutoScalingPolicyTypeDef
  4. See BalancingStrategyType
  5. See GameServerProtectionPolicyType
  6. See TagTypeDef
  7. See CreateGameServerGroupOutputTypeDef
Usage example with kwargs
kwargs: CreateGameServerGroupInputRequestTypeDef = {  # (1)
    "GameServerGroupName": ...,
    "RoleArn": ...,
    "MinSize": ...,
    "MaxSize": ...,
    "LaunchTemplate": ...,
    "InstanceDefinitions": ...,
}

parent.create_game_server_group(**kwargs)
  1. See CreateGameServerGroupInputRequestTypeDef

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

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)
    ...
  1. See GamePropertyTypeDef
  2. See CreateGameSessionOutputTypeDef
Usage example with kwargs
kwargs: CreateGameSessionInputRequestTypeDef = {  # (1)
    "MaximumPlayerSessionCount": ...,
}

parent.create_game_session(**kwargs)
  1. See CreateGameSessionInputRequestTypeDef

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

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)
    ...
  1. See PlayerLatencyPolicyTypeDef
  2. See GameSessionQueueDestinationTypeDef
  3. See FilterConfigurationTypeDef
  4. See PriorityConfigurationTypeDef
  5. See TagTypeDef
  6. See CreateGameSessionQueueOutputTypeDef
Usage example with kwargs
kwargs: CreateGameSessionQueueInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_game_session_queue(**kwargs)
  1. See CreateGameSessionQueueInputRequestTypeDef

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

Method definition
def create_location(
    self,
    *,
    LocationName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateLocationOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateLocationOutputTypeDef
Usage example with kwargs
kwargs: CreateLocationInputRequestTypeDef = {  # (1)
    "LocationName": ...,
}

parent.create_location(**kwargs)
  1. See CreateLocationInputRequestTypeDef

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

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)
    ...
  1. See GamePropertyTypeDef
  2. See BackfillModeType
  3. See FlexMatchModeType
  4. See TagTypeDef
  5. See CreateMatchmakingConfigurationOutputTypeDef
Usage example with kwargs
kwargs: CreateMatchmakingConfigurationInputRequestTypeDef = {  # (1)
    "Name": ...,
    "RequestTimeoutSeconds": ...,
    "AcceptanceRequired": ...,
    "RuleSetName": ...,
}

parent.create_matchmaking_configuration(**kwargs)
  1. See CreateMatchmakingConfigurationInputRequestTypeDef

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

Method definition
def create_matchmaking_rule_set(
    self,
    *,
    Name: str,
    RuleSetBody: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateMatchmakingRuleSetOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateMatchmakingRuleSetOutputTypeDef
Usage example with kwargs
kwargs: CreateMatchmakingRuleSetInputRequestTypeDef = {  # (1)
    "Name": ...,
    "RuleSetBody": ...,
}

parent.create_matchmaking_rule_set(**kwargs)
  1. See CreateMatchmakingRuleSetInputRequestTypeDef

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

Method definition
def create_player_session(
    self,
    *,
    GameSessionId: str,
    PlayerId: str,
    PlayerData: str = ...,
) -> CreatePlayerSessionOutputTypeDef:  # (1)
    ...
  1. See CreatePlayerSessionOutputTypeDef
Usage example with kwargs
kwargs: CreatePlayerSessionInputRequestTypeDef = {  # (1)
    "GameSessionId": ...,
    "PlayerId": ...,
}

parent.create_player_session(**kwargs)
  1. See CreatePlayerSessionInputRequestTypeDef

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

Method definition
def create_player_sessions(
    self,
    *,
    GameSessionId: str,
    PlayerIds: Sequence[str],
    PlayerDataMap: Mapping[str, str] = ...,
) -> CreatePlayerSessionsOutputTypeDef:  # (1)
    ...
  1. See CreatePlayerSessionsOutputTypeDef
Usage example with kwargs
kwargs: CreatePlayerSessionsInputRequestTypeDef = {  # (1)
    "GameSessionId": ...,
    "PlayerIds": ...,
}

parent.create_player_sessions(**kwargs)
  1. See CreatePlayerSessionsInputRequestTypeDef

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

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)
    ...
  1. See S3LocationTypeDef
  2. See TagTypeDef
  3. See CreateScriptOutputTypeDef
Usage example with kwargs
kwargs: CreateScriptInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_script(**kwargs)
  1. See CreateScriptInputRequestTypeDef

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

Method definition
def create_vpc_peering_authorization(
    self,
    *,
    GameLiftAwsAccountId: str,
    PeerVpcId: str,
) -> CreateVpcPeeringAuthorizationOutputTypeDef:  # (1)
    ...
  1. See CreateVpcPeeringAuthorizationOutputTypeDef
Usage example with kwargs
kwargs: CreateVpcPeeringAuthorizationInputRequestTypeDef = {  # (1)
    "GameLiftAwsAccountId": ...,
    "PeerVpcId": ...,
}

parent.create_vpc_peering_authorization(**kwargs)
  1. See CreateVpcPeeringAuthorizationInputRequestTypeDef

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

Method definition
def create_vpc_peering_connection(
    self,
    *,
    FleetId: str,
    PeerVpcAwsAccountId: str,
    PeerVpcId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CreateVpcPeeringConnectionInputRequestTypeDef = {  # (1)
    "FleetId": ...,
    "PeerVpcAwsAccountId": ...,
    "PeerVpcId": ...,
}

parent.create_vpc_peering_connection(**kwargs)
  1. See CreateVpcPeeringConnectionInputRequestTypeDef

delete_alias

Deletes an alias.

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

Method definition
def delete_alias(
    self,
    *,
    AliasId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteAliasInputRequestTypeDef = {  # (1)
    "AliasId": ...,
}

parent.delete_alias(**kwargs)
  1. See DeleteAliasInputRequestTypeDef

delete_build

Deletes a build.

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

Method definition
def delete_build(
    self,
    *,
    BuildId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteBuildInputRequestTypeDef = {  # (1)
    "BuildId": ...,
}

parent.delete_build(**kwargs)
  1. See DeleteBuildInputRequestTypeDef

delete_fleet

Deletes all resources and information related a fleet.

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

Method definition
def delete_fleet(
    self,
    *,
    FleetId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteFleetInputRequestTypeDef = {  # (1)
    "FleetId": ...,
}

parent.delete_fleet(**kwargs)
  1. See DeleteFleetInputRequestTypeDef

delete_fleet_locations

Removes locations from a multi-location fleet.

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

Method definition
def delete_fleet_locations(
    self,
    *,
    FleetId: str,
    Locations: Sequence[str],
) -> DeleteFleetLocationsOutputTypeDef:  # (1)
    ...
  1. See DeleteFleetLocationsOutputTypeDef
Usage example with kwargs
kwargs: DeleteFleetLocationsInputRequestTypeDef = {  # (1)
    "FleetId": ...,
    "Locations": ...,
}

parent.delete_fleet_locations(**kwargs)
  1. See DeleteFleetLocationsInputRequestTypeDef

delete_game_server_group

This operation is used with the GameLift FleetIQ solution and game server groups. Terminates a game server group and permanently deletes the game server group record.

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

Method definition
def delete_game_server_group(
    self,
    *,
    GameServerGroupName: str,
    DeleteOption: GameServerGroupDeleteOptionType = ...,  # (1)
) -> DeleteGameServerGroupOutputTypeDef:  # (2)
    ...
  1. See GameServerGroupDeleteOptionType
  2. See DeleteGameServerGroupOutputTypeDef
Usage example with kwargs
kwargs: DeleteGameServerGroupInputRequestTypeDef = {  # (1)
    "GameServerGroupName": ...,
}

parent.delete_game_server_group(**kwargs)
  1. See DeleteGameServerGroupInputRequestTypeDef

delete_game_session_queue

Deletes a game session queue.

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

Method definition
def delete_game_session_queue(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteGameSessionQueueInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_game_session_queue(**kwargs)
  1. See DeleteGameSessionQueueInputRequestTypeDef

delete_location

Deletes a custom location.

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

Method definition
def delete_location(
    self,
    *,
    LocationName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteLocationInputRequestTypeDef = {  # (1)
    "LocationName": ...,
}

parent.delete_location(**kwargs)
  1. See DeleteLocationInputRequestTypeDef

delete_matchmaking_configuration

Permanently removes a FlexMatch matchmaking configuration.

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

Method definition
def delete_matchmaking_configuration(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteMatchmakingConfigurationInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_matchmaking_configuration(**kwargs)
  1. See DeleteMatchmakingConfigurationInputRequestTypeDef

delete_matchmaking_rule_set

Deletes an existing matchmaking rule set.

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

Method definition
def delete_matchmaking_rule_set(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteMatchmakingRuleSetInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_matchmaking_rule_set(**kwargs)
  1. See DeleteMatchmakingRuleSetInputRequestTypeDef

delete_scaling_policy

Deletes a fleet scaling policy.

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

Method definition
def delete_scaling_policy(
    self,
    *,
    Name: str,
    FleetId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteScalingPolicyInputRequestTypeDef = {  # (1)
    "Name": ...,
    "FleetId": ...,
}

parent.delete_scaling_policy(**kwargs)
  1. See DeleteScalingPolicyInputRequestTypeDef

delete_script

Deletes a Realtime script.

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

Method definition
def delete_script(
    self,
    *,
    ScriptId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteScriptInputRequestTypeDef = {  # (1)
    "ScriptId": ...,
}

parent.delete_script(**kwargs)
  1. See DeleteScriptInputRequestTypeDef

delete_vpc_peering_authorization

Cancels a pending VPC peering authorization for the specified VPC.

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

Method definition
def delete_vpc_peering_authorization(
    self,
    *,
    GameLiftAwsAccountId: str,
    PeerVpcId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteVpcPeeringAuthorizationInputRequestTypeDef = {  # (1)
    "GameLiftAwsAccountId": ...,
    "PeerVpcId": ...,
}

parent.delete_vpc_peering_authorization(**kwargs)
  1. See DeleteVpcPeeringAuthorizationInputRequestTypeDef

delete_vpc_peering_connection

Removes a VPC peering connection.

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

Method definition
def delete_vpc_peering_connection(
    self,
    *,
    FleetId: str,
    VpcPeeringConnectionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteVpcPeeringConnectionInputRequestTypeDef = {  # (1)
    "FleetId": ...,
    "VpcPeeringConnectionId": ...,
}

parent.delete_vpc_peering_connection(**kwargs)
  1. See DeleteVpcPeeringConnectionInputRequestTypeDef

deregister_compute

Removes a compute resource from the specified fleet.

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

Method definition
def deregister_compute(
    self,
    *,
    FleetId: str,
    ComputeName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeregisterComputeInputRequestTypeDef = {  # (1)
    "FleetId": ...,
    "ComputeName": ...,
}

parent.deregister_compute(**kwargs)
  1. See DeregisterComputeInputRequestTypeDef

deregister_game_server

This operation is used with the GameLift FleetIQ solution and game server groups. Removes the game server from a game server group.

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

Method definition
def deregister_game_server(
    self,
    *,
    GameServerGroupName: str,
    GameServerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeregisterGameServerInputRequestTypeDef = {  # (1)
    "GameServerGroupName": ...,
    "GameServerId": ...,
}

parent.deregister_game_server(**kwargs)
  1. See DeregisterGameServerInputRequestTypeDef

describe_alias

Retrieves properties for an alias.

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

Method definition
def describe_alias(
    self,
    *,
    AliasId: str,
) -> DescribeAliasOutputTypeDef:  # (1)
    ...
  1. See DescribeAliasOutputTypeDef
Usage example with kwargs
kwargs: DescribeAliasInputRequestTypeDef = {  # (1)
    "AliasId": ...,
}

parent.describe_alias(**kwargs)
  1. See DescribeAliasInputRequestTypeDef

describe_build

Retrieves properties for a custom game build.

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

Method definition
def describe_build(
    self,
    *,
    BuildId: str,
) -> DescribeBuildOutputTypeDef:  # (1)
    ...
  1. See DescribeBuildOutputTypeDef
Usage example with kwargs
kwargs: DescribeBuildInputRequestTypeDef = {  # (1)
    "BuildId": ...,
}

parent.describe_build(**kwargs)
  1. See DescribeBuildInputRequestTypeDef

describe_compute

Retrieves properties for a compute resource.

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

Method definition
def describe_compute(
    self,
    *,
    FleetId: str,
    ComputeName: str,
) -> DescribeComputeOutputTypeDef:  # (1)
    ...
  1. See DescribeComputeOutputTypeDef
Usage example with kwargs
kwargs: DescribeComputeInputRequestTypeDef = {  # (1)
    "FleetId": ...,
    "ComputeName": ...,
}

parent.describe_compute(**kwargs)
  1. See DescribeComputeInputRequestTypeDef

describe_ec2_instance_limits

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.

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

Method definition
def describe_ec2_instance_limits(
    self,
    *,
    EC2InstanceType: EC2InstanceTypeType = ...,  # (1)
    Location: str = ...,
) -> DescribeEC2InstanceLimitsOutputTypeDef:  # (2)
    ...
  1. See EC2InstanceTypeType
  2. See DescribeEC2InstanceLimitsOutputTypeDef
Usage example with kwargs
kwargs: DescribeEC2InstanceLimitsInputRequestTypeDef = {  # (1)
    "EC2InstanceType": ...,
}

parent.describe_ec2_instance_limits(**kwargs)
  1. See DescribeEC2InstanceLimitsInputRequestTypeDef

describe_fleet_attributes

Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.

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

Method definition
def describe_fleet_attributes(
    self,
    *,
    FleetIds: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeFleetAttributesOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetAttributesOutputTypeDef
Usage example with kwargs
kwargs: DescribeFleetAttributesInputRequestTypeDef = {  # (1)
    "FleetIds": ...,
}

parent.describe_fleet_attributes(**kwargs)
  1. See DescribeFleetAttributesInputRequestTypeDef

describe_fleet_capacity

Retrieves the resource capacity settings for one or more fleets.

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

Method definition
def describe_fleet_capacity(
    self,
    *,
    FleetIds: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeFleetCapacityOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetCapacityOutputTypeDef
Usage example with kwargs
kwargs: DescribeFleetCapacityInputRequestTypeDef = {  # (1)
    "FleetIds": ...,
}

parent.describe_fleet_capacity(**kwargs)
  1. See DescribeFleetCapacityInputRequestTypeDef

describe_fleet_events

Retrieves entries from a fleet's event log.

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

Method definition
def describe_fleet_events(
    self,
    *,
    FleetId: str,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeFleetEventsOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetEventsOutputTypeDef
Usage example with kwargs
kwargs: DescribeFleetEventsInputRequestTypeDef = {  # (1)
    "FleetId": ...