Skip to content

GameLiftClient#

Index > GameLift > GameLiftClient

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

GameLiftClient#

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

# GameLiftClient usage example

from boto3.session import Session
from types_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.NotReadyException,
    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 types_boto3_gamelift.client import Exceptions

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

Methods#

can_paginate#

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:
    ...

generate_presigned_url#

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

claim_game_server#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

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 an Amazon GameLift build resource for your game server software and stores the software for deployment to hosting resources.

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_container_fleet#

Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game servers.

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

# create_container_fleet method definition

def create_container_fleet(
    self,
    *,
    FleetRoleArn: str,
    Description: str = ...,
    GameServerContainerGroupDefinitionName: str = ...,
    PerInstanceContainerGroupDefinitionName: str = ...,
    InstanceConnectionPortRange: ConnectionPortRangeTypeDef = ...,  # (1)
    InstanceInboundPermissions: Sequence[IpPermissionTypeDef] = ...,  # (2)
    GameServerContainerGroupsPerInstance: int = ...,
    InstanceType: str = ...,
    BillingType: ContainerFleetBillingTypeType = ...,  # (3)
    Locations: Sequence[LocationConfigurationTypeDef] = ...,  # (4)
    MetricGroups: Sequence[str] = ...,
    NewGameSessionProtectionPolicy: ProtectionPolicyType = ...,  # (5)
    GameSessionCreationLimitPolicy: GameSessionCreationLimitPolicyTypeDef = ...,  # (6)
    LogConfiguration: LogConfigurationTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> CreateContainerFleetOutputTypeDef:  # (9)
    ...
  1. See ConnectionPortRangeTypeDef
  2. See IpPermissionTypeDef
  3. See ContainerFleetBillingTypeType
  4. See LocationConfigurationTypeDef
  5. See ProtectionPolicyType
  6. See GameSessionCreationLimitPolicyTypeDef
  7. See LogConfigurationTypeDef
  8. See TagTypeDef
  9. See CreateContainerFleetOutputTypeDef
# create_container_fleet method usage example with argument unpacking

kwargs: CreateContainerFleetInputRequestTypeDef = {  # (1)
    "FleetRoleArn": ...,
}

parent.create_container_fleet(**kwargs)
  1. See CreateContainerFleetInputRequestTypeDef

create_container_group_definition#

Creates a ContainerGroupDefinition that describes a set of containers for hosting your game server with Amazon GameLift managed containers hosting.

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

# create_container_group_definition method definition

def create_container_group_definition(
    self,
    *,
    Name: str,
    TotalMemoryLimitMebibytes: int,
    TotalVcpuLimit: float,
    OperatingSystem: ContainerOperatingSystemType,  # (1)
    ContainerGroupType: ContainerGroupTypeType = ...,  # (2)
    GameServerContainerDefinition: GameServerContainerDefinitionInputTypeDef = ...,  # (3)
    SupportContainerDefinitions: Sequence[SupportContainerDefinitionInputTypeDef] = ...,  # (4)
    VersionDescription: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateContainerGroupDefinitionOutputTypeDef:  # (6)
    ...
  1. See ContainerOperatingSystemType
  2. See ContainerGroupTypeType
  3. See GameServerContainerDefinitionInputTypeDef
  4. See SupportContainerDefinitionInputTypeDef
  5. See TagTypeDef
  6. See CreateContainerGroupDefinitionOutputTypeDef
# create_container_group_definition method usage example with argument unpacking

kwargs: CreateContainerGroupDefinitionInputRequestTypeDef = {  # (1)
    "Name": ...,
    "TotalMemoryLimitMebibytes": ...,
    "TotalVcpuLimit": ...,
    "OperatingSystem": ...,
}

parent.create_container_group_definition(**kwargs)
  1. See CreateContainerGroupDefinitionInputRequestTypeDef

create_fleet#

Creates a fleet of compute resources to host your game 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 managed EC2 fleet or managed container fleet and begins populating the new locations with 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)
    ...
  1. See LocationConfigurationTypeDef
  2. See CreateFleetLocationsOutputTypeDef
# create_fleet_locations method usage example with argument unpacking

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

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

create_game_server_group#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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)
    ...
  1. See LaunchTemplateSpecificationTypeDef
  2. See InstanceDefinitionTypeDef
  3. See GameServerGroupAutoScalingPolicyTypeDef
  4. See BalancingStrategyType
  5. See GameServerProtectionPolicyType
  6. See TagTypeDef
  7. 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)
  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

# 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)
    ...
  1. See GamePropertyTypeDef
  2. See CreateGameSessionOutputTypeDef
# create_game_session method usage example with argument unpacking

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

# 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)
    ...
  1. See PlayerLatencyPolicyTypeDef
  2. See GameSessionQueueDestinationTypeDef
  3. See FilterConfigurationTypeDef
  4. See PriorityConfigurationTypeDef
  5. See TagTypeDef
  6. See CreateGameSessionQueueOutputTypeDef
# create_game_session_queue method usage example with argument unpacking

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

# create_location method definition

def create_location(
    self,
    *,
    LocationName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateLocationOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateLocationOutputTypeDef
# create_location method usage example with argument unpacking

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

# 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)
    ...
  1. See GamePropertyTypeDef
  2. See BackfillModeType
  3. See FlexMatchModeType
  4. See TagTypeDef
  5. See CreateMatchmakingConfigurationOutputTypeDef
# create_matchmaking_configuration method usage example with argument unpacking

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

# create_matchmaking_rule_set method definition

def create_matchmaking_rule_set(
    self,
    *,
    Name: str,
    RuleSetBody: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateMatchmakingRuleSetOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateMatchmakingRuleSetOutputTypeDef
# create_matchmaking_rule_set method usage example with argument unpacking

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

# create_player_session method definition

def create_player_session(
    self,
    *,
    GameSessionId: str,
    PlayerId: str,
    PlayerData: str = ...,
) -> CreatePlayerSessionOutputTypeDef:  # (1)
    ...
  1. See CreatePlayerSessionOutputTypeDef
# create_player_session method usage example with argument unpacking

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

# create_player_sessions method definition

def create_player_sessions(
    self,
    *,
    GameSessionId: str,
    PlayerIds: Sequence[str],
    PlayerDataMap: Mapping[str, str] = ...,
) -> CreatePlayerSessionsOutputTypeDef:  # (1)
    ...
  1. See CreatePlayerSessionsOutputTypeDef
# create_player_sessions method usage example with argument unpacking

kwargs: CreatePlayerSessionsInputRequestTypeDef = {  # (1)
    "GameSessionId": ...,
    "PlayerIds": ...,
}

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

create_script#

Creates a script resource 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: BlobTypeDef = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateScriptOutputTypeDef:  # (3)
    ...
  1. See S3LocationTypeDef
  2. See TagTypeDef
  3. See CreateScriptOutputTypeDef
# create_script method usage example with argument unpacking

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

# create_vpc_peering_authorization method definition

def create_vpc_peering_authorization(
    self,
    *,
    GameLiftAwsAccountId: str,
    PeerVpcId: str,
) -> CreateVpcPeeringAuthorizationOutputTypeDef:  # (1)
    ...
  1. See CreateVpcPeeringAuthorizationOutputTypeDef
# create_vpc_peering_authorization method usage example with argument unpacking

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

# 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)
  1. See CreateVpcPeeringConnectionInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_alias method usage example with argument unpacking

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

# delete_build method definition

def delete_build(
    self,
    *,
    BuildId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_build method usage example with argument unpacking

kwargs: DeleteBuildInputRequestTypeDef = {  # (1)
    "BuildId": ...,
}

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

delete_container_fleet#

Deletes all resources and information related to a container fleet and shuts down currently running fleet instances, including those in remote locations.

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

# delete_container_fleet method definition

def delete_container_fleet(
    self,
    *,
    FleetId: str,
) -> dict[str, Any]:
    ...
# delete_container_fleet method usage example with argument unpacking

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

parent.delete_container_fleet(**kwargs)
  1. See DeleteContainerFleetInputRequestTypeDef

delete_container_group_definition#

Deletes a container group definition.

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

# delete_container_group_definition method definition

def delete_container_group_definition(
    self,
    *,
    Name: str,
    VersionNumber: int = ...,
    VersionCountToRetain: int = ...,
) -> dict[str, Any]:
    ...
# delete_container_group_definition method usage example with argument unpacking

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

parent.delete_container_group_definition(**kwargs)
  1. See DeleteContainerGroupDefinitionInputRequestTypeDef

delete_fleet#

Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.

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

# delete_fleet method definition

def delete_fleet(
    self,
    *,
    FleetId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_fleet method usage example with argument unpacking

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

# delete_fleet_locations method definition

def delete_fleet_locations(
    self,
    *,
    FleetId: str,
    Locations: Sequence[str],
) -> DeleteFleetLocationsOutputTypeDef:  # (1)
    ...
  1. See DeleteFleetLocationsOutputTypeDef
# delete_fleet_locations method usage example with argument unpacking

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

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

delete_game_server_group#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# delete_game_server_group method definition

def delete_game_server_group(
    self,
    *,
    GameServerGroupName: str,
    DeleteOption: GameServerGroupDeleteOptionType = ...,  # (1)
) -> DeleteGameServerGroupOutputTypeDef:  # (2)
    ...
  1. See GameServerGroupDeleteOptionType
  2. See DeleteGameServerGroupOutputTypeDef
# delete_game_server_group method usage example with argument unpacking

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

# delete_game_session_queue method definition

def delete_game_session_queue(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# delete_game_session_queue method usage example with argument unpacking

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

# delete_location method definition

def delete_location(
    self,
    *,
    LocationName: str,
) -> dict[str, Any]:
    ...
# delete_location method usage example with argument unpacking

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

# delete_matchmaking_configuration method definition

def delete_matchmaking_configuration(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# delete_matchmaking_configuration method usage example with argument unpacking

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

# delete_matchmaking_rule_set method definition

def delete_matchmaking_rule_set(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...
# delete_matchmaking_rule_set method usage example with argument unpacking

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

# delete_scaling_policy method definition

def delete_scaling_policy(
    self,
    *,
    Name: str,
    FleetId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_scaling_policy method usage example with argument unpacking

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

# delete_script method definition

def delete_script(
    self,
    *,
    ScriptId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_script method usage example with argument unpacking

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

# delete_vpc_peering_authorization method definition

def delete_vpc_peering_authorization(
    self,
    *,
    GameLiftAwsAccountId: str,
    PeerVpcId: str,
) -> dict[str, Any]:
    ...
# delete_vpc_peering_authorization method usage example with argument unpacking

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

# delete_vpc_peering_connection method definition

def delete_vpc_peering_connection(
    self,
    *,
    FleetId: str,
    VpcPeeringConnectionId: str,
) -> dict[str, Any]:
    ...
# delete_vpc_peering_connection method usage example with argument unpacking

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

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

deregister_compute#

Removes a compute resource from an Amazon GameLift Anywhere fleet.

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

# deregister_compute method definition

def deregister_compute(
    self,
    *,
    FleetId: str,
    ComputeName: str,
) -> dict[str, Any]:
    ...
# deregister_compute method usage example with argument unpacking

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

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

deregister_game_server#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# deregister_game_server method definition

def deregister_game_server(
    self,
    *,
    GameServerGroupName: str,
    GameServerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# deregister_game_server method usage example with argument unpacking

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

# describe_alias method definition

def describe_alias(
    self,
    *,
    AliasId: str,
) -> DescribeAliasOutputTypeDef:  # (1)
    ...
  1. See DescribeAliasOutputTypeDef
# describe_alias method usage example with argument unpacking

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

# describe_build method definition

def describe_build(
    self,
    *,
    BuildId: str,
) -> DescribeBuildOutputTypeDef:  # (1)
    ...
  1. See DescribeBuildOutputTypeDef
# describe_build method usage example with argument unpacking

kwargs: DescribeBuildInputRequestTypeDef = {  # (1)
    "BuildId": ...,
}

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

describe_compute#

Retrieves properties for a compute resource in an Amazon GameLift fleet.

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

# describe_compute method definition

def describe_compute(
    self,
    *,
    FleetId: str,
    ComputeName: str,
) -> DescribeComputeOutputTypeDef:  # (1)
    ...
  1. See DescribeComputeOutputTypeDef
# describe_compute method usage example with argument unpacking

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

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

describe_container_fleet#

Retrieves the properties for a container fleet.

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

# describe_container_fleet method definition

def describe_container_fleet(
    self,
    *,
    FleetId: str,
) -> DescribeContainerFleetOutputTypeDef:  # (1)
    ...
  1. See DescribeContainerFleetOutputTypeDef
# describe_container_fleet method usage example with argument unpacking

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

parent.describe_container_fleet(**kwargs)
  1. See DescribeContainerFleetInputRequestTypeDef

describe_container_group_definition#

Retrieves the properties of a container group definition, including all container definitions in the group.

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

# describe_container_group_definition method definition

def describe_container_group_definition(
    self,
    *,
    Name: str,
    VersionNumber: int = ...,
) -> DescribeContainerGroupDefinitionOutputTypeDef:  # (1)
    ...
  1. See DescribeContainerGroupDefinitionOutputTypeDef
# describe_container_group_definition method usage example with argument unpacking

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

parent.describe_container_group_definition(**kwargs)
  1. See DescribeContainerGroupDefinitionInputRequestTypeDef

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

# describe_ec2_instance_limits method definition

def describe_ec2_instance_limits(
    self,
    *,
    EC2InstanceType: EC2InstanceTypeType = ...,  # (1)
    Location: str = ...,
) -> DescribeEC2InstanceLimitsOutputTypeDef:  # (2)
    ...
  1. See EC2InstanceTypeType
  2. See DescribeEC2InstanceLimitsOutputTypeDef
# describe_ec2_instance_limits method usage example with argument unpacking

kwargs: DescribeEC2InstanceLimitsInputRequestTypeDef = {  # (1)
    "EC2InstanceType": ...,
}

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

describe_fleet_attributes#

Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region.

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

# describe_fleet_attributes method definition

def describe_fleet_attributes(
    self,
    *,
    FleetIds: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeFleetAttributesOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetAttributesOutputTypeDef
# describe_fleet_attributes method usage example with argument unpacking

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

# describe_fleet_capacity method definition

def describe_fleet_capacity(
    self,
    *,
    FleetIds: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeFleetCapacityOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetCapacityOutputTypeDef
# describe_fleet_capacity method usage example with argument unpacking

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

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

describe_fleet_deployment#

Retrieves information about a managed container fleet deployment.

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

# describe_fleet_deployment method definition

def describe_fleet_deployment(
    self,
    *,
    FleetId: str,
    DeploymentId: str = ...,
) -> DescribeFleetDeploymentOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetDeploymentOutputTypeDef
# describe_fleet_deployment method usage example with argument unpacking

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

parent.describe_fleet_deployment(**kwargs)
  1. See DescribeFleetDeploymentInputRequestTypeDef

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

# describe_fleet_events method definition

def describe_fleet_events(
    self,
    *,
    FleetId: str,
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeFleetEventsOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetEventsOutputTypeDef
# describe_fleet_events method usage example with argument unpacking

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

parent.describe_fleet_events(**kwargs)
  1. See DescribeFleetEventsInputRequestTypeDef

describe_fleet_location_attributes#

Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.

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

# describe_fleet_location_attributes method definition

def describe_fleet_location_attributes(
    self,
    *,
    FleetId: str,
    Locations: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeFleetLocationAttributesOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetLocationAttributesOutputTypeDef
# describe_fleet_location_attributes method usage example with argument unpacking

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

parent.describe_fleet_location_attributes(**kwargs)
  1. See DescribeFleetLocationAttributesInputRequestTypeDef

describe_fleet_location_capacity#

Retrieves the resource capacity settings for a fleet location.

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

# describe_fleet_location_capacity method definition

def describe_fleet_location_capacity(
    self,
    *,
    FleetId: str,
    Location: str,
) -> DescribeFleetLocationCapacityOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetLocationCapacityOutputTypeDef
# describe_fleet_location_capacity method usage example with argument unpacking

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

parent.describe_fleet_location_capacity(**kwargs)
  1. See DescribeFleetLocationCapacityInputRequestTypeDef

describe_fleet_location_utilization#

Retrieves current usage data for a fleet location.

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

# describe_fleet_location_utilization method definition

def describe_fleet_location_utilization(
    self,
    *,
    FleetId: str,
    Location: str,
) -> DescribeFleetLocationUtilizationOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetLocationUtilizationOutputTypeDef
# describe_fleet_location_utilization method usage example with argument unpacking

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

parent.describe_fleet_location_utilization(**kwargs)
  1. See DescribeFleetLocationUtilizationInputRequestTypeDef

describe_fleet_port_settings#

Retrieves a fleet's inbound connection permissions.

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

# describe_fleet_port_settings method definition

def describe_fleet_port_settings(
    self,
    *,
    FleetId: str,
    Location: str = ...,
) -> DescribeFleetPortSettingsOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetPortSettingsOutputTypeDef
# describe_fleet_port_settings method usage example with argument unpacking

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

parent.describe_fleet_port_settings(**kwargs)
  1. See DescribeFleetPortSettingsInputRequestTypeDef

describe_fleet_utilization#

Retrieves utilization statistics for one or more fleets.

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

# describe_fleet_utilization method definition

def describe_fleet_utilization(
    self,
    *,
    FleetIds: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeFleetUtilizationOutputTypeDef:  # (1)
    ...
  1. See DescribeFleetUtilizationOutputTypeDef
# describe_fleet_utilization method usage example with argument unpacking

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

parent.describe_fleet_utilization(**kwargs)
  1. See DescribeFleetUtilizationInputRequestTypeDef

describe_game_server#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# describe_game_server method definition

def describe_game_server(
    self,
    *,
    GameServerGroupName: str,
    GameServerId: str,
) -> DescribeGameServerOutputTypeDef:  # (1)
    ...
  1. See DescribeGameServerOutputTypeDef
# describe_game_server method usage example with argument unpacking

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

parent.describe_game_server(**kwargs)
  1. See DescribeGameServerInputRequestTypeDef

describe_game_server_group#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# describe_game_server_group method definition

def describe_game_server_group(
    self,
    *,
    GameServerGroupName: str,
) -> DescribeGameServerGroupOutputTypeDef:  # (1)
    ...
  1. See DescribeGameServerGroupOutputTypeDef
# describe_game_server_group method usage example with argument unpacking

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

parent.describe_game_server_group(**kwargs)
  1. See DescribeGameServerGroupInputRequestTypeDef

describe_game_server_instances#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# describe_game_server_instances method definition

def describe_game_server_instances(
    self,
    *,
    GameServerGroupName: str,
    InstanceIds: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeGameServerInstancesOutputTypeDef:  # (1)
    ...
  1. See DescribeGameServerInstancesOutputTypeDef
# describe_game_server_instances method usage example with argument unpacking

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

parent.describe_game_server_instances(**kwargs)
  1. See DescribeGameServerInstancesInputRequestTypeDef

describe_game_session_details#

Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location.

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

# describe_game_session_details method definition

def describe_game_session_details(
    self,
    *,
    FleetId: str = ...,
    GameSessionId: str = ...,
    AliasId: str = ...,
    Location: str = ...,
    StatusFilter: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeGameSessionDetailsOutputTypeDef:  # (1)
    ...
  1. See DescribeGameSessionDetailsOutputTypeDef
# describe_game_session_details method usage example with argument unpacking

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

parent.describe_game_session_details(**kwargs)
  1. See DescribeGameSessionDetailsInputRequestTypeDef

describe_game_session_placement#

Retrieves information, including current status, about a game session placement request.

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

# describe_game_session_placement method definition

def describe_game_session_placement(
    self,
    *,
    PlacementId: str,
) -> DescribeGameSessionPlacementOutputTypeDef:  # (1)
    ...
  1. See DescribeGameSessionPlacementOutputTypeDef
# describe_game_session_placement method usage example with argument unpacking

kwargs: DescribeGameSessionPlacementInputRequestTypeDef = {  # (1)
    "PlacementId": ...,
}

parent.describe_game_session_placement(**kwargs)
  1. See DescribeGameSessionPlacementInputRequestTypeDef

describe_game_session_queues#

Retrieves the properties for one or more game session queues.

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

# describe_game_session_queues method definition

def describe_game_session_queues(
    self,
    *,
    Names: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeGameSessionQueuesOutputTypeDef:  # (1)
    ...
  1. See DescribeGameSessionQueuesOutputTypeDef
# describe_game_session_queues method usage example with argument unpacking

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

parent.describe_game_session_queues(**kwargs)
  1. See DescribeGameSessionQueuesInputRequestTypeDef

describe_game_sessions#

Retrieves a set of one or more game sessions in a specific fleet location.

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

# describe_game_sessions method definition

def describe_game_sessions(
    self,
    *,
    FleetId: str = ...,
    GameSessionId: str = ...,
    AliasId: str = ...,
    Location: str = ...,
    StatusFilter: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeGameSessionsOutputTypeDef:  # (1)
    ...
  1. See DescribeGameSessionsOutputTypeDef
# describe_game_sessions method usage example with argument unpacking

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

parent.describe_game_sessions(**kwargs)
  1. See DescribeGameSessionsInputRequestTypeDef

describe_instances#

Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status.

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

# describe_instances method definition

def describe_instances(
    self,
    *,
    FleetId: str,
    InstanceId: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
    Location: str = ...,
) -> DescribeInstancesOutputTypeDef:  # (1)
    ...
  1. See DescribeInstancesOutputTypeDef
# describe_instances method usage example with argument unpacking

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

parent.describe_instances(**kwargs)
  1. See DescribeInstancesInputRequestTypeDef

describe_matchmaking#

Retrieves one or more matchmaking tickets.

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

# describe_matchmaking method definition

def describe_matchmaking(
    self,
    *,
    TicketIds: Sequence[str],
) -> DescribeMatchmakingOutputTypeDef:  # (1)
    ...
  1. See DescribeMatchmakingOutputTypeDef
# describe_matchmaking method usage example with argument unpacking

kwargs: DescribeMatchmakingInputRequestTypeDef = {  # (1)
    "TicketIds": ...,
}

parent.describe_matchmaking(**kwargs)
  1. See DescribeMatchmakingInputRequestTypeDef

describe_matchmaking_configurations#

Retrieves the details of FlexMatch matchmaking configurations.

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

# describe_matchmaking_configurations method definition

def describe_matchmaking_configurations(
    self,
    *,
    Names: Sequence[str] = ...,
    RuleSetName: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeMatchmakingConfigurationsOutputTypeDef:  # (1)
    ...
  1. See DescribeMatchmakingConfigurationsOutputTypeDef
# describe_matchmaking_configurations method usage example with argument unpacking

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

parent.describe_matchmaking_configurations(**kwargs)
  1. See DescribeMatchmakingConfigurationsInputRequestTypeDef

describe_matchmaking_rule_sets#

Retrieves the details for FlexMatch matchmaking rule sets.

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

# describe_matchmaking_rule_sets method definition

def describe_matchmaking_rule_sets(
    self,
    *,
    Names: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeMatchmakingRuleSetsOutputTypeDef:  # (1)
    ...
  1. See DescribeMatchmakingRuleSetsOutputTypeDef
# describe_matchmaking_rule_sets method usage example with argument unpacking

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

parent.describe_matchmaking_rule_sets(**kwargs)
  1. See DescribeMatchmakingRuleSetsInputRequestTypeDef

describe_player_sessions#

Retrieves properties for one or more player sessions.

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

# describe_player_sessions method definition

def describe_player_sessions(
    self,
    *,
    GameSessionId: str = ...,
    PlayerId: str = ...,
    PlayerSessionId: str = ...,
    PlayerSessionStatusFilter: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribePlayerSessionsOutputTypeDef:  # (1)
    ...
  1. See DescribePlayerSessionsOutputTypeDef
# describe_player_sessions method usage example with argument unpacking

kwargs: DescribePlayerSessionsInputRequestTypeDef = {  # (1)
    "GameSessionId": ...,
}

parent.describe_player_sessions(**kwargs)
  1. See DescribePlayerSessionsInputRequestTypeDef

describe_runtime_configuration#

Retrieves a fleet's runtime configuration settings.

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

# describe_runtime_configuration method definition

def describe_runtime_configuration(
    self,
    *,
    FleetId: str,
) -> DescribeRuntimeConfigurationOutputTypeDef:  # (1)
    ...
  1. See DescribeRuntimeConfigurationOutputTypeDef
# describe_runtime_configuration method usage example with argument unpacking

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

parent.describe_runtime_configuration(**kwargs)
  1. See DescribeRuntimeConfigurationInputRequestTypeDef

describe_scaling_policies#

Retrieves all scaling policies applied to a fleet.

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

# describe_scaling_policies method definition

def describe_scaling_policies(
    self,
    *,
    FleetId: str,
    StatusFilter: ScalingStatusTypeType = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
    Location: str = ...,
) -> DescribeScalingPoliciesOutputTypeDef:  # (2)
    ...
  1. See ScalingStatusTypeType
  2. See DescribeScalingPoliciesOutputTypeDef
# describe_scaling_policies method usage example with argument unpacking

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

parent.describe_scaling_policies(**kwargs)
  1. See DescribeScalingPoliciesInputRequestTypeDef

describe_script#

Retrieves properties for a Realtime script.

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

# describe_script method definition

def describe_script(
    self,
    *,
    ScriptId: str,
) -> DescribeScriptOutputTypeDef:  # (1)
    ...
  1. See DescribeScriptOutputTypeDef
# describe_script method usage example with argument unpacking

kwargs: DescribeScriptInputRequestTypeDef = {  # (1)
    "ScriptId": ...,
}

parent.describe_script(**kwargs)
  1. See DescribeScriptInputRequestTypeDef

describe_vpc_peering_authorizations#

Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.

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

# describe_vpc_peering_authorizations method definition

def describe_vpc_peering_authorizations(
    self,
) -> DescribeVpcPeeringAuthorizationsOutputTypeDef:  # (1)
    ...
  1. See DescribeVpcPeeringAuthorizationsOutputTypeDef

describe_vpc_peering_connections#

Retrieves information on VPC peering connections.

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

# describe_vpc_peering_connections method definition

def describe_vpc_peering_connections(
    self,
    *,
    FleetId: str = ...,
) -> DescribeVpcPeeringConnectionsOutputTypeDef:  # (1)
    ...
  1. See DescribeVpcPeeringConnectionsOutputTypeDef
# describe_vpc_peering_connections method usage example with argument unpacking

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

parent.describe_vpc_peering_connections(**kwargs)
  1. See DescribeVpcPeeringConnectionsInputRequestTypeDef

get_compute_access#

Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet.

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

# get_compute_access method definition

def get_compute_access(
    self,
    *,
    FleetId: str,
    ComputeName: str,
) -> GetComputeAccessOutputTypeDef:  # (1)
    ...
  1. See GetComputeAccessOutputTypeDef
# get_compute_access method usage example with argument unpacking

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

parent.get_compute_access(**kwargs)
  1. See GetComputeAccessInputRequestTypeDef

get_compute_auth_token#

Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift fleet.

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

# get_compute_auth_token method definition

def get_compute_auth_token(
    self,
    *,
    FleetId: str,
    ComputeName: str,
) -> GetComputeAuthTokenOutputTypeDef:  # (1)
    ...
  1. See GetComputeAuthTokenOutputTypeDef
# get_compute_auth_token method usage example with argument unpacking

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

parent.get_compute_auth_token(**kwargs)
  1. See GetComputeAuthTokenInputRequestTypeDef

get_game_session_log_url#

Retrieves the location of stored game session logs for a specified game session on Amazon GameLift managed fleets.

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

# get_game_session_log_url method definition

def get_game_session_log_url(
    self,
    *,
    GameSessionId: str,
) -> GetGameSessionLogUrlOutputTypeDef:  # (1)
    ...
  1. See GetGameSessionLogUrlOutputTypeDef
# get_game_session_log_url method usage example with argument unpacking

kwargs: GetGameSessionLogUrlInputRequestTypeDef = {  # (1)
    "GameSessionId": ...,
}

parent.get_game_session_log_url(**kwargs)
  1. See GetGameSessionLogUrlInputRequestTypeDef

get_instance_access#

Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet.

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

# get_instance_access method definition

def get_instance_access(
    self,
    *,
    FleetId: str,
    InstanceId: str,
) -> GetInstanceAccessOutputTypeDef:  # (1)
    ...
  1. See GetInstanceAccessOutputTypeDef
# get_instance_access method usage example with argument unpacking

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

parent.get_instance_access(**kwargs)
  1. See GetInstanceAccessInputRequestTypeDef

list_aliases#

Retrieves all aliases for this Amazon Web Services account.

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

# list_aliases method definition

def list_aliases(
    self,
    *,
    RoutingStrategyType: RoutingStrategyTypeType = ...,  # (1)
    Name: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListAliasesOutputTypeDef:  # (2)
    ...
  1. See RoutingStrategyTypeType
  2. See ListAliasesOutputTypeDef
# list_aliases method usage example with argument unpacking

kwargs: ListAliasesInputRequestTypeDef = {  # (1)
    "RoutingStrategyType": ...,
}

parent.list_aliases(**kwargs)
  1. See ListAliasesInputRequestTypeDef

list_builds#

Retrieves build resources for all builds associated with the Amazon Web Services account in use.

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

# list_builds method definition

def list_builds(
    self,
    *,
    Status: BuildStatusType = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> ListBuildsOutputTypeDef:  # (2)
    ...
  1. See BuildStatusType
  2. See ListBuildsOutputTypeDef
# list_builds method usage example with argument unpacking

kwargs: ListBuildsInputRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_builds(**kwargs)
  1. See ListBuildsInputRequestTypeDef

list_compute#

Retrieves information on the compute resources in an Amazon GameLift fleet.

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

# list_compute method definition

def list_compute(
    self,
    *,
    FleetId: str,
    Location: str = ...,
    ContainerGroupDefinitionName: str = ...,
    ComputeStatus: ListComputeInputStatusType = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> ListComputeOutputTypeDef:  # (2)
    ...
  1. See ListComputeInputStatusType
  2. See ListComputeOutputTypeDef
# list_compute method usage example with argument unpacking

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

parent.list_compute(**kwargs)
  1. See ListComputeInputRequestTypeDef

list_container_fleets#

Retrieves a collection of container fleet resources in an Amazon Web Services Region.

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

# list_container_fleets method definition

def list_container_fleets(
    self,
    *,
    ContainerGroupDefinitionName: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListContainerFleetsOutputTypeDef:  # (1)
    ...
  1. See ListContainerFleetsOutputTypeDef
# list_container_fleets method usage example with argument unpacking

kwargs: ListContainerFleetsInputRequestTypeDef = {  # (1)
    "ContainerGroupDefinitionName": ...,
}

parent.list_container_fleets(**kwargs)
  1. See ListContainerFleetsInputRequestTypeDef

list_container_group_definition_versions#

Retrieves all versions of a container group definition.

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

# list_container_group_definition_versions method definition

def list_container_group_definition_versions(
    self,
    *,
    Name: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListContainerGroupDefinitionVersionsOutputTypeDef:  # (1)
    ...
  1. See ListContainerGroupDefinitionVersionsOutputTypeDef
# list_container_group_definition_versions method usage example with argument unpacking

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

parent.list_container_group_definition_versions(**kwargs)
  1. See ListContainerGroupDefinitionVersionsInputRequestTypeDef

list_container_group_definitions#

Retrieves container group definitions for the Amazon Web Services account and Amazon Web Services Region.

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

# list_container_group_definitions method definition

def list_container_group_definitions(
    self,
    *,
    ContainerGroupType: ContainerGroupTypeType = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> ListContainerGroupDefinitionsOutputTypeDef:  # (2)
    ...
  1. See ContainerGroupTypeType
  2. See ListContainerGroupDefinitionsOutputTypeDef
# list_container_group_definitions method usage example with argument unpacking

kwargs: ListContainerGroupDefinitionsInputRequestTypeDef = {  # (1)
    "ContainerGroupType": ...,
}

parent.list_container_group_definitions(**kwargs)
  1. See ListContainerGroupDefinitionsInputRequestTypeDef

list_fleet_deployments#

Retrieves a collection of container fleet deployments in an Amazon Web Services Region.

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

# list_fleet_deployments method definition

def list_fleet_deployments(
    self,
    *,
    FleetId: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListFleetDeploymentsOutputTypeDef:  # (1)
    ...
  1. See ListFleetDeploymentsOutputTypeDef
# list_fleet_deployments method usage example with argument unpacking

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

parent.list_fleet_deployments(**kwargs)
  1. See ListFleetDeploymentsInputRequestTypeDef

list_fleets#

Retrieves a collection of fleet resources in an Amazon Web Services Region.

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

# list_fleets method definition

def list_fleets(
    self,
    *,
    BuildId: str = ...,
    ScriptId: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListFleetsOutputTypeDef:  # (1)
    ...
  1. See ListFleetsOutputTypeDef
# list_fleets method usage example with argument unpacking

kwargs: ListFleetsInputRequestTypeDef = {  # (1)
    "BuildId": ...,
}

parent.list_fleets(**kwargs)
  1. See ListFleetsInputRequestTypeDef

list_game_server_groups#

Lists a game server groups.

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

# list_game_server_groups method definition

def list_game_server_groups(
    self,
    *,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListGameServerGroupsOutputTypeDef:  # (1)
    ...
  1. See ListGameServerGroupsOutputTypeDef
# list_game_server_groups method usage example with argument unpacking

kwargs: ListGameServerGroupsInputRequestTypeDef = {  # (1)
    "Limit": ...,
}

parent.list_game_server_groups(**kwargs)
  1. See ListGameServerGroupsInputRequestTypeDef

list_game_servers#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# list_game_servers method definition

def list_game_servers(
    self,
    *,
    GameServerGroupName: str,
    SortOrder: SortOrderType = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> ListGameServersOutputTypeDef:  # (2)
    ...
  1. See SortOrderType
  2. See ListGameServersOutputTypeDef
# list_game_servers method usage example with argument unpacking

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

parent.list_game_servers(**kwargs)
  1. See ListGameServersInputRequestTypeDef

list_locations#

Lists all custom and Amazon Web Services locations.

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

# list_locations method definition

def list_locations(
    self,
    *,
    Filters: Sequence[LocationFilterType] = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> ListLocationsOutputTypeDef:  # (2)
    ...
  1. See LocationFilterType
  2. See ListLocationsOutputTypeDef
# list_locations method usage example with argument unpacking

kwargs: ListLocationsInputRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_locations(**kwargs)
  1. See ListLocationsInputRequestTypeDef

list_scripts#

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.

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

# list_scripts method definition

def list_scripts(
    self,
    *,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListScriptsOutputTypeDef:  # (1)
    ...
  1. See ListScriptsOutputTypeDef
# list_scripts method usage example with argument unpacking

kwargs: ListScriptsInputRequestTypeDef = {  # (1)
    "Limit": ...,
}

parent.list_scripts(**kwargs)
  1. See ListScriptsInputRequestTypeDef

list_tags_for_resource#

Retrieves all tags assigned to a Amazon GameLift resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

put_scaling_policy#

Creates or updates a scaling policy for a fleet.

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

# put_scaling_policy method definition

def put_scaling_policy(
    self,
    *,
    Name: str,
    FleetId: str,
    MetricName: MetricNameType,  # (1)
    ScalingAdjustment: int = ...,
    ScalingAdjustmentType: ScalingAdjustmentTypeType = ...,  # (2)
    Threshold: float = ...,
    ComparisonOperator: ComparisonOperatorTypeType = ...,  # (3)
    EvaluationPeriods: int = ...,
    PolicyType: PolicyTypeType = ...,  # (4)
    TargetConfiguration: TargetConfigurationTypeDef = ...,  # (5)
) -> PutScalingPolicyOutputTypeDef:  # (6)
    ...
  1. See MetricNameType
  2. See ScalingAdjustmentTypeType
  3. See ComparisonOperatorTypeType
  4. See PolicyTypeType
  5. See TargetConfigurationTypeDef
  6. See PutScalingPolicyOutputTypeDef
# put_scaling_policy method usage example with argument unpacking

kwargs: PutScalingPolicyInputRequestTypeDef = {  # (1)
    "Name": ...,
    "FleetId": ...,
    "MetricName": ...,
}

parent.put_scaling_policy(**kwargs)
  1. See PutScalingPolicyInputRequestTypeDef

register_compute#

Registers a compute resource in an Amazon GameLift Anywhere fleet.

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

# register_compute method definition

def register_compute(
    self,
    *,
    FleetId: str,
    ComputeName: str,
    CertificatePath: str = ...,
    DnsName: str = ...,
    IpAddress: str = ...,
    Location: str = ...,
) -> RegisterComputeOutputTypeDef:  # (1)
    ...
  1. See RegisterComputeOutputTypeDef
# register_compute method usage example with argument unpacking

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

parent.register_compute(**kwargs)
  1. See RegisterComputeInputRequestTypeDef

register_game_server#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# register_game_server method definition

def register_game_server(
    self,
    *,
    GameServerGroupName: str,
    GameServerId: str,
    InstanceId: str,
    ConnectionInfo: str = ...,
    GameServerData: str = ...,
) -> RegisterGameServerOutputTypeDef:  # (1)
    ...
  1. See RegisterGameServerOutputTypeDef
# register_game_server method usage example with argument unpacking

kwargs: RegisterGameServerInputRequestTypeDef = {  # (1)
    "GameServerGroupName": ...,
    "GameServerId": ...,
    "InstanceId": ...,
}

parent.register_game_server(**kwargs)
  1. See RegisterGameServerInputRequestTypeDef

request_upload_credentials#

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3.

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

# request_upload_credentials method definition

def request_upload_credentials(
    self,
    *,
    BuildId: str,
) -> RequestUploadCredentialsOutputTypeDef:  # (1)
    ...
  1. See RequestUploadCredentialsOutputTypeDef
# request_upload_credentials method usage example with argument unpacking

kwargs: RequestUploadCredentialsInputRequestTypeDef = {  # (1)
    "BuildId": ...,
}

parent.request_upload_credentials(**kwargs)
  1. See RequestUploadCredentialsInputRequestTypeDef

resolve_alias#

Attempts to retrieve a fleet ID that is associated with an alias.

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

# resolve_alias method definition

def resolve_alias(
    self,
    *,
    AliasId: str,
) -> ResolveAliasOutputTypeDef:  # (1)
    ...
  1. See ResolveAliasOutputTypeDef
# resolve_alias method usage example with argument unpacking

kwargs: ResolveAliasInputRequestTypeDef = {  # (1)
    "AliasId": ...,
}

parent.resolve_alias(**kwargs)
  1. See ResolveAliasInputRequestTypeDef

resume_game_server_group#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# resume_game_server_group method definition

def resume_game_server_group(
    self,
    *,
    GameServerGroupName: str,
    ResumeActions: Sequence[GameServerGroupActionType],  # (1)
) -> ResumeGameServerGroupOutputTypeDef:  # (2)
    ...
  1. See GameServerGroupActionType
  2. See ResumeGameServerGroupOutputTypeDef
# resume_game_server_group method usage example with argument unpacking

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

parent.resume_game_server_group(**kwargs)
  1. See ResumeGameServerGroupInputRequestTypeDef

search_game_sessions#

Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.

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

# search_game_sessions method definition

def search_game_sessions(
    self,
    *,
    FleetId: str = ...,
    AliasId: str = ...,
    Location: str = ...,
    FilterExpression: str = ...,
    SortExpression: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> SearchGameSessionsOutputTypeDef:  # (1)
    ...
  1. See SearchGameSessionsOutputTypeDef
# search_game_sessions method usage example with argument unpacking

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

parent.search_game_sessions(**kwargs)
  1. See SearchGameSessionsInputRequestTypeDef

start_fleet_actions#

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions.

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

# start_fleet_actions method definition

def start_fleet_actions(
    self,
    *,
    FleetId: str,
    Actions: Sequence[FleetActionType],  # (1)
    Location: str = ...,
) -> StartFleetActionsOutputTypeDef:  # (2)
    ...
  1. See FleetActionType
  2. See StartFleetActionsOutputTypeDef
# start_fleet_actions method usage example with argument unpacking

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

parent.start_fleet_actions(**kwargs)
  1. See StartFleetActionsInputRequestTypeDef

start_game_session_placement#

Places a request for a new game session in a queue.

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

# start_game_session_placement method definition

def start_game_session_placement(
    self,
    *,
    PlacementId: str,
    GameSessionQueueName: str,
    MaximumPlayerSessionCount: int,
    GameProperties: Sequence[GamePropertyTypeDef] = ...,  # (1)
    GameSessionName: str = ...,
    PlayerLatencies: Sequence[PlayerLatencyTypeDef] = ...,  # (2)
    DesiredPlayerSessions: Sequence[DesiredPlayerSessionTypeDef] = ...,  # (3)
    GameSessionData: str = ...,
) -> StartGameSessionPlacementOutputTypeDef:  # (4)
    ...
  1. See GamePropertyTypeDef
  2. See PlayerLatencyTypeDef
  3. See DesiredPlayerSessionTypeDef
  4. See StartGameSessionPlacementOutputTypeDef
# start_game_session_placement method usage example with argument unpacking

kwargs: StartGameSessionPlacementInputRequestTypeDef = {  # (1)
    "PlacementId": ...,
    "GameSessionQueueName": ...,
    "MaximumPlayerSessionCount": ...,
}

parent.start_game_session_placement(**kwargs)
  1. See StartGameSessionPlacementInputRequestTypeDef

start_match_backfill#

Finds new players to fill open slots in currently running game sessions.

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

# start_match_backfill method definition

def start_match_backfill(
    self,
    *,
    ConfigurationName: str,
    Players: Sequence[PlayerUnionTypeDef],  # (1)
    TicketId: str = ...,
    GameSessionArn: str = ...,
) -> StartMatchBackfillOutputTypeDef:  # (2)
    ...
  1. See PlayerTypeDef PlayerOutputTypeDef
  2. See StartMatchBackfillOutputTypeDef
# start_match_backfill method usage example with argument unpacking

kwargs: StartMatchBackfillInputRequestTypeDef = {  # (1)
    "ConfigurationName": ...,
    "Players": ...,
}

parent.start_match_backfill(**kwargs)
  1. See StartMatchBackfillInputRequestTypeDef

start_matchmaking#

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules.

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

# start_matchmaking method definition

def start_matchmaking(
    self,
    *,
    ConfigurationName: str,
    Players: Sequence[PlayerTypeDef],  # (1)
    TicketId: str = ...,
) -> StartMatchmakingOutputTypeDef:  # (2)
    ...
  1. See PlayerTypeDef
  2. See StartMatchmakingOutputTypeDef
# start_matchmaking method usage example with argument unpacking

kwargs: StartMatchmakingInputRequestTypeDef = {  # (1)
    "ConfigurationName": ...,
    "Players": ...,
}

parent.start_matchmaking(**kwargs)
  1. See StartMatchmakingInputRequestTypeDef

stop_fleet_actions#

Suspends certain types of activity in a fleet location.

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

# stop_fleet_actions method definition

def stop_fleet_actions(
    self,
    *,
    FleetId: str,
    Actions: Sequence[FleetActionType],  # (1)
    Location: str = ...,
) -> StopFleetActionsOutputTypeDef:  # (2)
    ...
  1. See FleetActionType
  2. See StopFleetActionsOutputTypeDef
# stop_fleet_actions method usage example with argument unpacking

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

parent.stop_fleet_actions(**kwargs)
  1. See StopFleetActionsInputRequestTypeDef

stop_game_session_placement#

Cancels a game session placement that is in PENDING status.

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

# stop_game_session_placement method definition

def stop_game_session_placement(
    self,
    *,
    PlacementId: str,
) -> StopGameSessionPlacementOutputTypeDef:  # (1)
    ...
  1. See StopGameSessionPlacementOutputTypeDef
# stop_game_session_placement method usage example with argument unpacking

kwargs: StopGameSessionPlacementInputRequestTypeDef = {  # (1)
    "PlacementId": ...,
}

parent.stop_game_session_placement(**kwargs)
  1. See StopGameSessionPlacementInputRequestTypeDef

stop_matchmaking#

Cancels a matchmaking ticket or match backfill ticket that is currently being processed.

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

# stop_matchmaking method definition

def stop_matchmaking(
    self,
    *,
    TicketId: str,
) -> dict[str, Any]:
    ...
# stop_matchmaking method usage example with argument unpacking

kwargs: StopMatchmakingInputRequestTypeDef = {  # (1)
    "TicketId": ...,
}

parent.stop_matchmaking(**kwargs)
  1. See StopMatchmakingInputRequestTypeDef

suspend_game_server_group#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# suspend_game_server_group method definition

def suspend_game_server_group(
    self,
    *,
    GameServerGroupName: str,
    SuspendActions: Sequence[GameServerGroupActionType],  # (1)
) -> SuspendGameServerGroupOutputTypeDef:  # (2)
    ...
  1. See GameServerGroupActionType
  2. See SuspendGameServerGroupOutputTypeDef
# suspend_game_server_group method usage example with argument unpacking

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

parent.suspend_game_server_group(**kwargs)
  1. See SuspendGameServerGroupInputRequestTypeDef

tag_resource#

Assigns a tag to an Amazon GameLift resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> dict[str, Any]:
    ...
  1. See TagTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes a tag assigned to a Amazon GameLift resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_alias#

Updates properties for an alias.

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

# update_alias method definition

def update_alias(
    self,
    *,
    AliasId: str,
    Name: str = ...,
    Description: str = ...,
    RoutingStrategy: RoutingStrategyTypeDef = ...,  # (1)
) -> UpdateAliasOutputTypeDef:  # (2)
    ...
  1. See RoutingStrategyTypeDef
  2. See UpdateAliasOutputTypeDef
# update_alias method usage example with argument unpacking

kwargs: UpdateAliasInputRequestTypeDef = {  # (1)
    "AliasId": ...,
}

parent.update_alias(**kwargs)
  1. See UpdateAliasInputRequestTypeDef

update_build#

Updates metadata in a build resource, including the build name and version.

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

# update_build method definition

def update_build(
    self,
    *,
    BuildId: str,
    Name: str = ...,
    Version: str = ...,
) -> UpdateBuildOutputTypeDef:  # (1)
    ...
  1. See UpdateBuildOutputTypeDef
# update_build method usage example with argument unpacking

kwargs: UpdateBuildInputRequestTypeDef = {  # (1)
    "BuildId": ...,
}

parent.update_build(**kwargs)
  1. See UpdateBuildInputRequestTypeDef

update_container_fleet#

Updates the properties of a managed container fleet.

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

# update_container_fleet method definition

def update_container_fleet(
    self,
    *,
    FleetId: str,
    GameServerContainerGroupDefinitionName: str = ...,
    PerInstanceContainerGroupDefinitionName: str = ...,
    GameServerContainerGroupsPerInstance: int = ...,
    InstanceConnectionPortRange: ConnectionPortRangeTypeDef = ...,  # (1)
    InstanceInboundPermissionAuthorizations: Sequence[IpPermissionTypeDef] = ...,  # (2)
    InstanceInboundPermissionRevocations: Sequence[IpPermissionTypeDef] = ...,  # (2)
    DeploymentConfiguration: DeploymentConfigurationTypeDef = ...,  # (4)
    Description: str = ...,
    MetricGroups: Sequence[str] = ...,
    NewGameSessionProtectionPolicy: ProtectionPolicyType = ...,  # (5)
    GameSessionCreationLimitPolicy: GameSessionCreationLimitPolicyTypeDef = ...,  # (6)
    LogConfiguration: LogConfigurationTypeDef = ...,  # (7)
    RemoveAttributes: Sequence[ContainerFleetRemoveAttributeType] = ...,  # (8)
) -> UpdateContainerFleetOutputTypeDef:  # (9)
    ...
  1. See ConnectionPortRangeTypeDef
  2. See IpPermissionTypeDef
  3. See IpPermissionTypeDef
  4. See DeploymentConfigurationTypeDef
  5. See ProtectionPolicyType
  6. See GameSessionCreationLimitPolicyTypeDef
  7. See LogConfigurationTypeDef
  8. See ContainerFleetRemoveAttributeType
  9. See UpdateContainerFleetOutputTypeDef
# update_container_fleet method usage example with argument unpacking

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

parent.update_container_fleet(**kwargs)
  1. See UpdateContainerFleetInputRequestTypeDef

update_container_group_definition#

Updates properties in an existing container group definition.

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

# update_container_group_definition method definition

def update_container_group_definition(
    self,
    *,
    Name: str,
    GameServerContainerDefinition: GameServerContainerDefinitionInputTypeDef = ...,  # (1)
    SupportContainerDefinitions: Sequence[SupportContainerDefinitionInputTypeDef] = ...,  # (2)
    TotalMemoryLimitMebibytes: int = ...,
    TotalVcpuLimit: float = ...,
    VersionDescription: str = ...,
    SourceVersionNumber: int = ...,
    OperatingSystem: ContainerOperatingSystemType = ...,  # (3)
) -> UpdateContainerGroupDefinitionOutputTypeDef:  # (4)
    ...
  1. See GameServerContainerDefinitionInputTypeDef
  2. See SupportContainerDefinitionInputTypeDef
  3. See ContainerOperatingSystemType
  4. See UpdateContainerGroupDefinitionOutputTypeDef
# update_container_group_definition method usage example with argument unpacking

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

parent.update_container_group_definition(**kwargs)
  1. See UpdateContainerGroupDefinitionInputRequestTypeDef

update_fleet_attributes#

Updates a fleet's mutable attributes, such as game session protection and resource creation limits.

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

# update_fleet_attributes method definition

def update_fleet_attributes(
    self,
    *,
    FleetId: str,
    Name: str = ...,
    Description: str = ...,
    NewGameSessionProtectionPolicy: ProtectionPolicyType = ...,  # (1)
    ResourceCreationLimitPolicy: ResourceCreationLimitPolicyTypeDef = ...,  # (2)
    MetricGroups: Sequence[str] = ...,
    AnywhereConfiguration: AnywhereConfigurationTypeDef = ...,  # (3)
) -> UpdateFleetAttributesOutputTypeDef:  # (4)
    ...
  1. See ProtectionPolicyType
  2. See ResourceCreationLimitPolicyTypeDef
  3. See AnywhereConfigurationTypeDef
  4. See UpdateFleetAttributesOutputTypeDef
# update_fleet_attributes method usage example with argument unpacking

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

parent.update_fleet_attributes(**kwargs)
  1. See UpdateFleetAttributesInputRequestTypeDef

update_fleet_capacity#

Updates capacity settings for a managed EC2 fleet or managed container fleet.

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

# update_fleet_capacity method definition

def update_fleet_capacity(
    self,
    *,
    FleetId: str,
    DesiredInstances: int = ...,
    MinSize: int = ...,
    MaxSize: int = ...,
    Location: str = ...,
) -> UpdateFleetCapacityOutputTypeDef:  # (1)
    ...
  1. See UpdateFleetCapacityOutputTypeDef
# update_fleet_capacity method usage example with argument unpacking

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

parent.update_fleet_capacity(**kwargs)
  1. See UpdateFleetCapacityInputRequestTypeDef

update_fleet_port_settings#

Updates permissions that allow inbound traffic to connect to game sessions in the fleet.

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

# update_fleet_port_settings method definition

def update_fleet_port_settings(
    self,
    *,
    FleetId: str,
    InboundPermissionAuthorizations: Sequence[IpPermissionTypeDef] = ...,  # (1)
    InboundPermissionRevocations: Sequence[IpPermissionTypeDef] = ...,  # (1)
) -> UpdateFleetPortSettingsOutputTypeDef:  # (3)
    ...
  1. See IpPermissionTypeDef
  2. See IpPermissionTypeDef
  3. See UpdateFleetPortSettingsOutputTypeDef
# update_fleet_port_settings method usage example with argument unpacking

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

parent.update_fleet_port_settings(**kwargs)
  1. See UpdateFleetPortSettingsInputRequestTypeDef

update_game_server#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# update_game_server method definition

def update_game_server(
    self,
    *,
    GameServerGroupName: str,
    GameServerId: str,
    GameServerData: str = ...,
    UtilizationStatus: GameServerUtilizationStatusType = ...,  # (1)
    HealthCheck: GameServerHealthCheckType = ...,  # (2)
) -> UpdateGameServerOutputTypeDef:  # (3)
    ...
  1. See GameServerUtilizationStatusType
  2. See GameServerHealthCheckType
  3. See UpdateGameServerOutputTypeDef
# update_game_server method usage example with argument unpacking

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

parent.update_game_server(**kwargs)
  1. See UpdateGameServerInputRequestTypeDef

update_game_server_group#

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

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

# update_game_server_group method definition

def update_game_server_group(
    self,
    *,
    GameServerGroupName: str,
    RoleArn: str = ...,
    InstanceDefinitions: Sequence[InstanceDefinitionTypeDef] = ...,  # (1)
    GameServerProtectionPolicy: GameServerProtectionPolicyType = ...,  # (2)
    BalancingStrategy: BalancingStrategyType = ...,  # (3)
) -> UpdateGameServerGroupOutputTypeDef:  # (4)
    ...
  1. See InstanceDefinitionTypeDef
  2. See GameServerProtectionPolicyType
  3. See BalancingStrategyType
  4. See UpdateGameServerGroupOutputTypeDef
# update_game_server_group method usage example with argument unpacking

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

parent.update_game_server_group(**kwargs)
  1. See UpdateGameServerGroupInputRequestTypeDef

update_game_session#

Updates the mutable properties of a game session.

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

# update_game_session method definition

def update_game_session(
    self,
    *,
    GameSessionId: str,
    MaximumPlayerSessionCount: int = ...,
    Name: str = ...,
    PlayerSessionCreationPolicy: PlayerSessionCreationPolicyType = ...,  # (1)
    ProtectionPolicy: ProtectionPolicyType = ...,  # (2)
    GameProperties: Sequence[GamePropertyTypeDef] = ...,  # (3)
) -> UpdateGameSessionOutputTypeDef:  # (4)
    ...
  1. See PlayerSessionCreationPolicyType
  2. See ProtectionPolicyType
  3. See GamePropertyTypeDef
  4. See UpdateGameSessionOutputTypeDef
# update_game_session method usage example with argument unpacking

kwargs: UpdateGameSessionInputRequestTypeDef = {  # (1)
    "GameSessionId": ...,
}

parent.update_game_session(**kwargs)
  1. See UpdateGameSessionInputRequestTypeDef

update_game_session_queue#

Updates the configuration of a game session queue, which determines how the queue processes new game session requests.

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

# update_game_session_queue method definition

def update_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 = ...,
) -> UpdateGameSessionQueueOutputTypeDef:  # (5)
    ...
  1. See PlayerLatencyPolicyTypeDef
  2. See GameSessionQueueDestinationTypeDef
  3. See FilterConfigurationTypeDef
  4. See PriorityConfigurationTypeDef
  5. See UpdateGameSessionQueueOutputTypeDef
# update_game_session_queue method usage example with argument unpacking

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

parent.update_game_session_queue(**kwargs)
  1. See UpdateGameSessionQueueInputRequestTypeDef

update_matchmaking_configuration#

Updates settings for a FlexMatch matchmaking configuration.

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

# update_matchmaking_configuration method definition

def update_matchmaking_configuration(
    self,
    *,
    Name: str,
    Description: str = ...,
    GameSessionQueueArns: Sequence[str] = ...,
    RequestTimeoutSeconds: int = ...,
    AcceptanceTimeoutSeconds: int = ...,
    AcceptanceRequired: bool = ...,
    RuleSetName: str = ...,
    NotificationTarget: str = ...,
    AdditionalPlayerCount: int = ...,
    CustomEventData: str = ...,
    GameProperties: Sequence[GamePropertyTypeDef] = ...,  # (1)
    GameSessionData: str = ...,
    BackfillMode: BackfillModeType = ...,  # (2)
    FlexMatchMode: FlexMatchModeType = ...,  # (3)
) -> UpdateMatchmakingConfigurationOutputTypeDef:  # (4)
    ...
  1. See GamePropertyTypeDef
  2. See BackfillModeType
  3. See FlexMatchModeType
  4. See UpdateMatchmakingConfigurationOutputTypeDef
# update_matchmaking_configuration method usage example with argument unpacking

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

parent.update_matchmaking_configuration(**kwargs)
  1. See UpdateMatchmakingConfigurationInputRequestTypeDef

update_runtime_configuration#

Updates the runtime configuration for the specified fleet.

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

# update_runtime_configuration method definition

def update_runtime_configuration(
    self,
    *,
    FleetId: str,
    RuntimeConfiguration: RuntimeConfigurationTypeDef,  # (1)
) -> UpdateRuntimeConfigurationOutputTypeDef:  # (2)
    ...
  1. See RuntimeConfigurationTypeDef
  2. See UpdateRuntimeConfigurationOutputTypeDef
# update_runtime_configuration method usage example with argument unpacking

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

parent.update_runtime_configuration(**kwargs)
  1. See UpdateRuntimeConfigurationInputRequestTypeDef

update_script#

Updates Realtime script metadata and content.

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

# update_script method definition

def update_script(
    self,
    *,
    ScriptId: str,
    Name: str = ...,
    Version: str = ...,
    StorageLocation: S3LocationTypeDef = ...,  # (1)
    ZipFile: BlobTypeDef = ...,
) -> UpdateScriptOutputTypeDef:  # (2)
    ...
  1. See S3LocationTypeDef
  2. See UpdateScriptOutputTypeDef
# update_script method usage example with argument unpacking

kwargs: UpdateScriptInputRequestTypeDef = {  # (1)
    "ScriptId": ...,
}

parent.update_script(**kwargs)
  1. See UpdateScriptInputRequestTypeDef

validate_matchmaking_rule_set#

Validates the syntax of a matchmaking rule or rule set.

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

# validate_matchmaking_rule_set method definition

def validate_matchmaking_rule_set(
    self,
    *,
    RuleSetBody: str,
) -> ValidateMatchmakingRuleSetOutputTypeDef:  # (1)
    ...
  1. See ValidateMatchmakingRuleSetOutputTypeDef
# validate_matchmaking_rule_set method usage example with argument unpacking

kwargs: ValidateMatchmakingRuleSetInputRequestTypeDef = {  # (1)
    "RuleSetBody": ...,
}

parent.validate_matchmaking_rule_set(**kwargs)
  1. See ValidateMatchmakingRuleSetInputRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("gamelift").get_paginator method with overloads.