AcceptMatch

$result = $client->acceptMatch([/* ... */]);
$promise = $client->acceptMatchAsync([/* ... */]);

Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in each ticket. Calls to this action are only valid for tickets that are in this status; calls for tickets not in this status result in an error.

To register acceptance, specify the ticket ID, one or more players, and an acceptance response. When all players have accepted, Amazon GameLift advances the matchmaking tickets to status PLACING, and attempts to create a new game session for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. Each matchmaking ticket in the failed match is handled as follows:

• If the ticket has one or more players who rejected the match or failed to respond, the ticket status is set CANCELLED and processing is terminated.

• If all players in the ticket accepted the match, the ticket status is returned to SEARCHING to find a new match.

Learn more

Add FlexMatch to a game client

FlexMatch events (reference)

Parameter Syntax

$result = $client->acceptMatch([
    'AcceptanceType' => 'ACCEPT|REJECT', // REQUIRED
    'PlayerIds' => ['<string>', ...], // REQUIRED
    'TicketId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

ClaimGameServer

$result = $client->claimGameServer([/* ... */]);
$promise = $client->claimGameServerAsync([/* ... */]);

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

Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, Amazon GameLift FleetIQ locates an available game server, places it in CLAIMED status for 60 seconds, and returns connection information that players can use to connect to the game server.

To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. Add filter options to further restrict how a game server is chosen, such as only allowing game servers on ACTIVE instances to be claimed.

When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED after players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable.

If you try to claim a specific game server, this request will fail in the following cases:

• If the game server utilization status is UTILIZED.

• If the game server claim status is CLAIMED.

• If the game server is running on an instance in DRAINING status and the provided filter option does not allow placing on DRAINING instances.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->claimGameServer([
    'FilterOption' => [
        'InstanceStatuses' => ['<string>', ...],
    ],
    'GameServerData' => '<string>',
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GameServer' => [
        'ClaimStatus' => 'CLAIMED',
        'ConnectionInfo' => '<string>',
        'GameServerData' => '<string>',
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerId' => '<string>',
        'InstanceId' => '<string>',
        'LastClaimTime' => <DateTime>,
        'LastHealthCheckTime' => <DateTime>,
        'RegistrationTime' => <DateTime>,
        'UtilizationStatus' => 'AVAILABLE|UTILIZED',
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

OutOfCapacityException:

The specified game server group has no available game servers to fulfill a ClaimGameServer request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateAlias

$result = $client->createAlias([/* ... */]);
$promise = $client->createAliasAsync([/* ... */]);

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias.

Related actions

All APIs by task

Parameter Syntax

$result = $client->createAlias([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RoutingStrategy' => [ // REQUIRED
        'FleetId' => '<string>',
        'Message' => '<string>',
        'Type' => 'SIMPLE|TERMINAL',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Alias' => [
        'AliasArn' => '<string>',
        'AliasId' => '<string>',
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'Name' => '<string>',
        'RoutingStrategy' => [
            'FleetId' => '<string>',
            'Message' => '<string>',
            'Type' => 'SIMPLE|TERMINAL',
        ],
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

CreateBuild

$result = $client->createBuild([/* ... */]);
$promise = $client->createBuildAsync([/* ... */]);

Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift.

You can use the CreateBuild operation in the following scenarios:

• Create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, specify a build name, operating system, and the Amazon S3 storage location of your game build.

• Upload your build files to a Amazon GameLift Amazon S3 location. To use this option, specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. After you upload build files to the Amazon GameLift Amazon S3 location, you can't update them.

If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it.

Learn more

Uploading Your Game

Create a Build with Files in Amazon S3

All APIs by task

Parameter Syntax

$result = $client->createBuild([
    'Name' => '<string>',
    'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
    'ServerSdkVersion' => '<string>',
    'StorageLocation' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
        'ObjectVersion' => '<string>',
        'RoleArn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Version' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Build' => [
        'BuildArn' => '<string>',
        'BuildId' => '<string>',
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'ServerSdkVersion' => '<string>',
        'SizeOnDisk' => <integer>,
        'Status' => 'INITIALIZED|READY|FAILED',
        'Version' => '<string>',
    ],
    'StorageLocation' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
        'ObjectVersion' => '<string>',
        'RoleArn' => '<string>',
    ],
    'UploadCredentials' => [
        'AccessKeyId' => '<string>',
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateContainerGroupDefinition

$result = $client->createContainerGroupDefinition([/* ... */]);
$promise = $client->createContainerGroupDefinitionAsync([/* ... */]);

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Creates a ContainerGroupDefinition resource that describes a set of containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift container group is similar to a container "task" and "pod". Each container group can have one or more containers.

Use container group definitions when you create a container fleet. Container group definitions determine how Amazon GameLift deploys your containers to each instance in a container fleet.

You can create two types of container groups, based on scheduling strategy:

• A replica container group manages the containers that run your game server application and supporting software. Replica container groups might be replicated multiple times on each fleet instance, depending on instance resources.

• A daemon container group manages containers that run other software, such as background services, logging, or test processes. You might use a daemon container group for processes that need to run only once per fleet instance, or processes that need to persist independently of the replica container group.

To create a container group definition, specify a group name, a list of container definitions, and maximum total CPU and memory requirements for the container group. Specify an operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI tool, you can pass in your container definitions as a JSON file.

If successful, this operation creates a new ContainerGroupDefinition resource with an ARN value assigned. You can't change the properties of a container group definition. Instead, create a new one.

Learn more

• Create a container group definition

• Container fleet design guide

• Create a container definition as a JSON file

Parameter Syntax

$result = $client->createContainerGroupDefinition([
    'ContainerDefinitions' => [ // REQUIRED
        [
            'Command' => ['<string>', ...],
            'ContainerName' => '<string>', // REQUIRED
            'Cpu' => <integer>,
            'DependsOn' => [
                [
                    'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY', // REQUIRED
                    'ContainerName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'EntryPoint' => ['<string>', ...],
            'Environment' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Essential' => true || false,
            'HealthCheck' => [
                'Command' => ['<string>', ...], // REQUIRED
                'Interval' => <integer>,
                'Retries' => <integer>,
                'StartPeriod' => <integer>,
                'Timeout' => <integer>,
            ],
            'ImageUri' => '<string>', // REQUIRED
            'MemoryLimits' => [
                'HardLimit' => <integer>,
                'SoftLimit' => <integer>,
            ],
            'PortConfiguration' => [
                'ContainerPortRanges' => [ // REQUIRED
                    [
                        'FromPort' => <integer>, // REQUIRED
                        'Protocol' => 'TCP|UDP', // REQUIRED
                        'ToPort' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
            ],
            'WorkingDirectory' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'OperatingSystem' => 'AMAZON_LINUX_2023', // REQUIRED
    'SchedulingStrategy' => 'REPLICA|DAEMON',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TotalCpuLimit' => <integer>, // REQUIRED
    'TotalMemoryLimit' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContainerGroupDefinition' => [
        'ContainerDefinitions' => [
            [
                'Command' => ['<string>', ...],
                'ContainerName' => '<string>',
                'Cpu' => <integer>,
                'DependsOn' => [
                    [
                        'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                        'ContainerName' => '<string>',
                    ],
                    // ...
                ],
                'EntryPoint' => ['<string>', ...],
                'Environment' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Essential' => true || false,
                'HealthCheck' => [
                    'Command' => ['<string>', ...],
                    'Interval' => <integer>,
                    'Retries' => <integer>,
                    'StartPeriod' => <integer>,
                    'Timeout' => <integer>,
                ],
                'ImageUri' => '<string>',
                'MemoryLimits' => [
                    'HardLimit' => <integer>,
                    'SoftLimit' => <integer>,
                ],
                'PortConfiguration' => [
                    'ContainerPortRanges' => [
                        [
                            'FromPort' => <integer>,
                            'Protocol' => 'TCP|UDP',
                            'ToPort' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'ResolvedImageDigest' => '<string>',
                'WorkingDirectory' => '<string>',
            ],
            // ...
        ],
        'ContainerGroupDefinitionArn' => '<string>',
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'OperatingSystem' => 'AMAZON_LINUX_2023',
        'SchedulingStrategy' => 'REPLICA|DAEMON',
        'Status' => 'READY|COPYING|FAILED',
        'StatusReason' => '<string>',
        'TotalCpuLimit' => <integer>,
        'TotalMemoryLimit' => <integer>,
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

CreateFleet

$result = $client->createFleet([/* ... */]);
$promise = $client->createFleetAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Creates a fleet of compute resources to host your game servers. Use this operation to set up the following types of fleets based on compute type:

Managed EC2 fleet

An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the lifecycle of game server processes, which host game sessions for players. EC2 fleets can have instances in multiple locations. Each instance in the fleet is designated a Compute.

To create an EC2 fleet, provide these required parameters:

• Either BuildId or ScriptId

• ComputeType set to EC2 (the default value)

• EC2InboundPermissions

• EC2InstanceType

• FleetType

• Name

• RuntimeConfiguration with at least one ServerProcesses configuration

If successful, this operation creates a new fleet resource and places it in NEW status while Amazon GameLift initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create a development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.

Managed container fleet

A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the containers on each fleet instance and controls the lifecycle of game server processes, which host game sessions for players. Container fleets can have instances in multiple locations. Each container on an instance that runs game server processes is registered as a Compute.

To create a container fleet, provide these required parameters:

• ComputeType set to CONTAINER

• ContainerGroupsConfiguration

• EC2InboundPermissions

• EC2InstanceType

• FleetType set to ON_DEMAND

• Name

• RuntimeConfiguration with at least one ServerProcesses configuration

If successful, this operation creates a new fleet resource and places it in NEW status while Amazon GameLift initiates the fleet creation workflow.

When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.

Anywhere fleet

An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use one to host game servers with on-premises hardware or other game hosting solutions.

To create an Anywhere fleet, provide these required parameters:

• ComputeType set to ANYWHERE

• Locations specifying a custom location

• Name

If successful, this operation creates a new fleet resource and places it in ACTIVE status. You can register computes with a fleet in ACTIVE status.

Learn more

Setting up fleets

Setting up a container fleet

Debug fleet creation issues

Multi-location fleets

Parameter Syntax

$result = $client->createFleet([
    'AnywhereConfiguration' => [
        'Cost' => '<string>', // REQUIRED
    ],
    'BuildId' => '<string>',
    'CertificateConfiguration' => [
        'CertificateType' => 'DISABLED|GENERATED', // REQUIRED
    ],
    'ComputeType' => 'EC2|ANYWHERE|CONTAINER',
    'ContainerGroupsConfiguration' => [
        'ConnectionPortRange' => [ // REQUIRED
            'FromPort' => <integer>, // REQUIRED
            'ToPort' => <integer>, // REQUIRED
        ],
        'ContainerGroupDefinitionNames' => ['<string>', ...], // REQUIRED
        'DesiredReplicaContainerGroupsPerInstance' => <integer>,
    ],
    'Description' => '<string>',
    'EC2InboundPermissions' => [
        [
            'FromPort' => <integer>, // REQUIRED
            'IpRange' => '<string>', // REQUIRED
            'Protocol' => 'TCP|UDP', // REQUIRED
            'ToPort' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'EC2InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
    'FleetType' => 'ON_DEMAND|SPOT',
    'InstanceRoleArn' => '<string>',
    'InstanceRoleCredentialsProvider' => 'SHARED_CREDENTIAL_FILE',
    'Locations' => [
        [
            'Location' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'LogPaths' => ['<string>', ...],
    'MetricGroups' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
    'PeerVpcAwsAccountId' => '<string>',
    'PeerVpcId' => '<string>',
    'ResourceCreationLimitPolicy' => [
        'NewGameSessionsPerCreator' => <integer>,
        'PolicyPeriodInMinutes' => <integer>,
    ],
    'RuntimeConfiguration' => [
        'GameSessionActivationTimeoutSeconds' => <integer>,
        'MaxConcurrentGameSessionActivations' => <integer>,
        'ServerProcesses' => [
            [
                'ConcurrentExecutions' => <integer>, // REQUIRED
                'LaunchPath' => '<string>', // REQUIRED
                'Parameters' => '<string>',
            ],
            // ...
        ],
    ],
    'ScriptId' => '<string>',
    'ServerLaunchParameters' => '<string>',
    'ServerLaunchPath' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FleetAttributes' => [
        'AnywhereConfiguration' => [
            'Cost' => '<string>',
        ],
        'BuildArn' => '<string>',
        'BuildId' => '<string>',
        'CertificateConfiguration' => [
            'CertificateType' => 'DISABLED|GENERATED',
        ],
        'ComputeType' => 'EC2|ANYWHERE|CONTAINER',
        'ContainerGroupsAttributes' => [
            'ConnectionPortRange' => [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            'ContainerGroupDefinitionProperties' => [
                [
                    'ContainerGroupDefinitionName' => '<string>',
                    'SchedulingStrategy' => 'REPLICA|DAEMON',
                ],
                // ...
            ],
            'ContainerGroupsPerInstance' => [
                'DesiredReplicaContainerGroupsPerInstance' => <integer>,
                'MaxReplicaContainerGroupsPerInstance' => <integer>,
            ],
        ],
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'FleetType' => 'ON_DEMAND|SPOT',
        'InstanceRoleArn' => '<string>',
        'InstanceRoleCredentialsProvider' => 'SHARED_CREDENTIAL_FILE',
        'InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
        'LogPaths' => ['<string>', ...],
        'MetricGroups' => ['<string>', ...],
        'Name' => '<string>',
        'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'ResourceCreationLimitPolicy' => [
            'NewGameSessionsPerCreator' => <integer>,
            'PolicyPeriodInMinutes' => <integer>,
        ],
        'ScriptArn' => '<string>',
        'ScriptId' => '<string>',
        'ServerLaunchParameters' => '<string>',
        'ServerLaunchPath' => '<string>',
        'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
        'StoppedActions' => ['<string>', ...],
        'TerminationTime' => <DateTime>,
    ],
    'LocationStates' => [
        [
            'Location' => '<string>',
            'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

NotReadyException:

The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

CreateFleetLocations

$result = $client->createFleetLocations([/* ... */]);
$promise = $client->createFleetLocationsAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Adds remote locations to an EC2 or container fleet and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.

To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.

If successful, this operation returns the list of added locations with their status set to NEW. Amazon GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.

Learn more

Setting up fleets

Update fleet locations

Amazon GameLift service locations for managed hosting.

Parameter Syntax

$result = $client->createFleetLocations([
    'FleetId' => '<string>', // REQUIRED
    'Locations' => [ // REQUIRED
        [
            'Location' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'LocationStates' => [
        [
            'Location' => '<string>',
            'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

NotReadyException:

The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

CreateGameServerGroup

$result = $client->createGameServerGroup([/* ... */]);
$promise = $client->createGameServerGroupAsync([/* ... */]);

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

Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the Amazon GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.

Before creating a new game server group, you must have the following:

• An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User Guide.

• An IAM role that extends limited access to your Amazon Web Services account to allow Amazon GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the Amazon GameLift FleetIQ Developer Guide.

To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a Amazon GameLift FleetIQ metric.

Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by Amazon GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->createGameServerGroup([
    'AutoScalingPolicy' => [
        'EstimatedInstanceWarmup' => <integer>,
        'TargetTrackingConfiguration' => [ // REQUIRED
            'TargetValue' => <float>, // REQUIRED
        ],
    ],
    'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
    'InstanceDefinitions' => [ // REQUIRED
        [
            'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge', // REQUIRED
            'WeightedCapacity' => '<string>',
        ],
        // ...
    ],
    'LaunchTemplate' => [ // REQUIRED
        'LaunchTemplateId' => '<string>',
        'LaunchTemplateName' => '<string>',
        'Version' => '<string>',
    ],
    'MaxSize' => <integer>, // REQUIRED
    'MinSize' => <integer>, // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcSubnets' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'GameServerGroup' => [
        'AutoScalingGroupArn' => '<string>',
        'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
        'CreationTime' => <DateTime>,
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
        'InstanceDefinitions' => [
            [
                'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                'WeightedCapacity' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedTime' => <DateTime>,
        'RoleArn' => '<string>',
        'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
        'StatusReason' => '<string>',
        'SuspendedActions' => ['<string>', ...],
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

CreateGameSession

$result = $client->createGameSession([/* ... */]);
$promise = $client->createGameSessionAsync([/* ... */]);

Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the Amazon GameLift game session placement feature with StartGameSessionPlacement , which uses the FleetIQ algorithm and queues to optimize the placement process.

When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The target fleet must be in ACTIVE status.

You can use this operation in the following ways:

• To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration.

• To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration.

• To create a game session on an instance in an Anywhere fleet, specify the fleet's custom location.

If successful, Amazon GameLift initiates a workflow to start a new game session and returns a GameSession object containing the game session configuration and status. When the game session status is ACTIVE, it is updated with connection information and you can create player sessions for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

Amazon GameLift retains logs for active for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Local.

Learn more

Start a game session

All APIs by task

Parameter Syntax

$result = $client->createGameSession([
    'AliasId' => '<string>',
    'CreatorId' => '<string>',
    'FleetId' => '<string>',
    'GameProperties' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'GameSessionData' => '<string>',
    'GameSessionId' => '<string>',
    'IdempotencyToken' => '<string>',
    'Location' => '<string>',
    'MaximumPlayerSessionCount' => <integer>, // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GameSession' => [
        'CreationTime' => <DateTime>,
        'CreatorId' => '<string>',
        'CurrentPlayerSessionCount' => <integer>,
        'DnsName' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionData' => '<string>',
        'GameSessionId' => '<string>',
        'IpAddress' => '<string>',
        'Location' => '<string>',
        'MatchmakerData' => '<string>',
        'MaximumPlayerSessionCount' => <integer>,
        'Name' => '<string>',
        'PlayerSessionCreationPolicy' => 'ACCEPT_ALL|DENY_ALL',
        'Port' => <integer>,
        'Status' => 'ACTIVE|ACTIVATING|TERMINATED|TERMINATING|ERROR',
        'StatusReason' => 'INTERRUPTED',
        'TerminationTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

FleetCapacityExceededException:

The specified fleet has no available instances to fulfill a CreateGameSession request. Clients can retry such requests immediately or after a waiting period.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

IdempotentParameterMismatchException:

A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

CreateGameSessionQueue

$result = $client->createGameSessionQueue([/* ... */]);
$promise = $client->createGameSessionQueueAsync([/* ... */]);

Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.

A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.

The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.

To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.

If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.

Learn more

Design a game session queue

Create a game session queue

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

Parameter Syntax

$result = $client->createGameSessionQueue([
    'CustomEventData' => '<string>',
    'Destinations' => [
        [
            'DestinationArn' => '<string>',
        ],
        // ...
    ],
    'FilterConfiguration' => [
        'AllowedLocations' => ['<string>', ...],
    ],
    'Name' => '<string>', // REQUIRED
    'NotificationTarget' => '<string>',
    'PlayerLatencyPolicies' => [
        [
            'MaximumIndividualPlayerLatencyMilliseconds' => <integer>,
            'PolicyDurationSeconds' => <integer>,
        ],
        // ...
    ],
    'PriorityConfiguration' => [
        'LocationOrder' => ['<string>', ...],
        'PriorityOrder' => ['<string>', ...],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TimeoutInSeconds' => <integer>,
]);

Parameter Details

Result Syntax

[
    'GameSessionQueue' => [
        'CustomEventData' => '<string>',
        'Destinations' => [
            [
                'DestinationArn' => '<string>',
            ],
            // ...
        ],
        'FilterConfiguration' => [
            'AllowedLocations' => ['<string>', ...],
        ],
        'GameSessionQueueArn' => '<string>',
        'Name' => '<string>',
        'NotificationTarget' => '<string>',
        'PlayerLatencyPolicies' => [
            [
                'MaximumIndividualPlayerLatencyMilliseconds' => <integer>,
                'PolicyDurationSeconds' => <integer>,
            ],
            // ...
        ],
        'PriorityConfiguration' => [
            'LocationOrder' => ['<string>', ...],
            'PriorityOrder' => ['<string>', ...],
        ],
        'TimeoutInSeconds' => <integer>,
    ],
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

CreateLocation

$result = $client->createLocation([/* ... */]);
$promise = $client->createLocationAsync([/* ... */]);

Creates a custom location for use in an Anywhere fleet.

Parameter Syntax

$result = $client->createLocation([
    'LocationName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Location' => [
        'LocationArn' => '<string>',
        'LocationName' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateMatchmakingConfiguration

$result = $client->createMatchmakingConfiguration([/* ... */]);
$promise = $client->createMatchmakingConfigurationAsync([/* ... */]);

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.

To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.

In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.

Learn more

Design a FlexMatch matchmaker

Set up FlexMatch event notification

Parameter Syntax

$result = $client->createMatchmakingConfiguration([
    'AcceptanceRequired' => true || false, // REQUIRED
    'AcceptanceTimeoutSeconds' => <integer>,
    'AdditionalPlayerCount' => <integer>,
    'BackfillMode' => 'AUTOMATIC|MANUAL',
    'CustomEventData' => '<string>',
    'Description' => '<string>',
    'FlexMatchMode' => 'STANDALONE|WITH_QUEUE',
    'GameProperties' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'GameSessionData' => '<string>',
    'GameSessionQueueArns' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'NotificationTarget' => '<string>',
    'RequestTimeoutSeconds' => <integer>, // REQUIRED
    'RuleSetName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Configuration' => [
        'AcceptanceRequired' => true || false,
        'AcceptanceTimeoutSeconds' => <integer>,
        'AdditionalPlayerCount' => <integer>,
        'BackfillMode' => 'AUTOMATIC|MANUAL',
        'ConfigurationArn' => '<string>',
        'CreationTime' => <DateTime>,
        'CustomEventData' => '<string>',
        'Description' => '<string>',
        'FlexMatchMode' => 'STANDALONE|WITH_QUEUE',
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionData' => '<string>',
        'GameSessionQueueArns' => ['<string>', ...],
        'Name' => '<string>',
        'NotificationTarget' => '<string>',
        'RequestTimeoutSeconds' => <integer>,
        'RuleSetArn' => '<string>',
        'RuleSetName' => '<string>',
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

CreateMatchmakingRuleSet

$result = $client->createMatchmakingRuleSet([/* ... */]);
$promise = $client->createMatchmakingRuleSetAsync([/* ... */]);

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.

Learn more

• Build a rule set

• Design a matchmaker

• Matchmaking with FlexMatch

Parameter Syntax

$result = $client->createMatchmakingRuleSet([
    'Name' => '<string>', // REQUIRED
    'RuleSetBody' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'RuleSet' => [
        'CreationTime' => <DateTime>,
        'RuleSetArn' => '<string>',
        'RuleSetBody' => '<string>',
        'RuleSetName' => '<string>',
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

LimitExceededException:

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

CreatePlayerSession

$result = $client->createPlayerSession([/* ... */]);
$promise = $client->createPlayerSessionAsync([/* ... */]);

Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. You can add a group of players to a game session with CreatePlayerSessions .

To create a player session, specify a game session ID, player ID, and optionally a set of player data.

If successful, a slot is reserved in the game session for the player and a new PlayerSessions object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

Related actions

All APIs by task

Parameter Syntax

$result = $client->createPlayerSession([
    'GameSessionId' => '<string>', // REQUIRED
    'PlayerData' => '<string>',
    'PlayerId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PlayerSession' => [
        'CreationTime' => <DateTime>,
        'DnsName' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'GameSessionId' => '<string>',
        'IpAddress' => '<string>',
        'PlayerData' => '<string>',
        'PlayerId' => '<string>',
        'PlayerSessionId' => '<string>',
        'Port' => <integer>,
        'Status' => 'RESERVED|ACTIVE|COMPLETED|TIMEDOUT',
        'TerminationTime' => <DateTime>,
    ],
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidGameSessionStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

GameSessionFullException:

The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

CreatePlayerSessions

$result = $client->createPlayerSessions([/* ... */]);
$promise = $client->createPlayerSessionsAsync([/* ... */]);

Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession

To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.

If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.

The maximum number of players per game session is 200. It is not adjustable.

Related actions

All APIs by task

Parameter Syntax

$result = $client->createPlayerSessions([
    'GameSessionId' => '<string>', // REQUIRED
    'PlayerDataMap' => ['<string>', ...],
    'PlayerIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PlayerSessions' => [
        [
            'CreationTime' => <DateTime>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'GameSessionId' => '<string>',
            'IpAddress' => '<string>',
            'PlayerData' => '<string>',
            'PlayerId' => '<string>',
            'PlayerSessionId' => '<string>',
            'Port' => <integer>,
            'Status' => 'RESERVED|ACTIVE|COMPLETED|TIMEDOUT',
            'TerminationTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidGameSessionStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

GameSessionFullException:

The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

CreateScript

$result = $client->createScript([/* ... */]);
$promise = $client->createScriptAsync([/* ... */]);

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.

To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:

• A locally available directory. Use the ZipFile parameter for this option.

• An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.

If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.

Learn more

Amazon GameLift Realtime Servers

Set Up a Role for Amazon GameLift Access

Related actions

All APIs by task

Parameter Syntax

$result = $client->createScript([
    'Name' => '<string>',
    'StorageLocation' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
        'ObjectVersion' => '<string>',
        'RoleArn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Version' => '<string>',
    'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
]);

Parameter Details

Result Syntax

[
    'Script' => [
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'ScriptArn' => '<string>',
        'ScriptId' => '<string>',
        'SizeOnDisk' => <integer>,
        'StorageLocation' => [
            'Bucket' => '<string>',
            'Key' => '<string>',
            'ObjectVersion' => '<string>',
            'RoleArn' => '<string>',
        ],
        'Version' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateVpcPeeringAuthorization

$result = $client->createVpcPeeringAuthorization([/* ... */]);
$promise = $client->createVpcPeeringAuthorizationAsync([/* ... */]);

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. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.

You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.

To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid.

Related actions

All APIs by task

Parameter Syntax

$result = $client->createVpcPeeringAuthorization([
    'GameLiftAwsAccountId' => '<string>', // REQUIRED
    'PeerVpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'VpcPeeringAuthorization' => [
        'CreationTime' => <DateTime>,
        'ExpirationTime' => <DateTime>,
        'GameLiftAwsAccountId' => '<string>',
        'PeerVpcAwsAccountId' => '<string>',
        'PeerVpcId' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

CreateVpcPeeringConnection

$result = $client->createVpcPeeringConnection([/* ... */]);
$promise = $client->createVpcPeeringConnectionAsync([/* ... */]);

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. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets.

Before calling this operation to establish the peering connection, you first need to use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.

To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success or failure using DescribeFleetEvents .

Related actions

All APIs by task

Parameter Syntax

$result = $client->createVpcPeeringConnection([
    'FleetId' => '<string>', // REQUIRED
    'PeerVpcAwsAccountId' => '<string>', // REQUIRED
    'PeerVpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteAlias

$result = $client->deleteAlias([/* ... */]);
$promise = $client->deleteAliasAsync([/* ... */]);

Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

Related actions

All APIs by task

Parameter Syntax

$result = $client->deleteAlias([
    'AliasId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteBuild

$result = $client->deleteBuild([/* ... */]);
$promise = $client->deleteBuildAsync([/* ... */]);

Deletes a build. This operation permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

To delete a build, specify the build ID.

Learn more

Upload a Custom Server Build

All APIs by task

Parameter Syntax

$result = $client->deleteBuild([
    'BuildId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

DeleteContainerGroupDefinition

$result = $client->deleteContainerGroupDefinition([/* ... */]);
$promise = $client->deleteContainerGroupDefinitionAsync([/* ... */]);

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Deletes a container group definition resource. You can delete a container group definition if there are no fleets using the definition.

To delete a container group definition, identify the resource to delete.

Learn more

• Manage a container group definition

Parameter Syntax

$result = $client->deleteContainerGroupDefinition([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DeleteFleet

$result = $client->deleteFleet([/* ... */]);
$promise = $client->deleteFleetAsync([/* ... */]);

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

To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is emitted.

Learn more

Setting up Amazon GameLift Fleets

Parameter Syntax

$result = $client->deleteFleet([
    'FleetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidFleetStatusException:

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

DeleteFleetLocations

$result = $client->deleteFleetLocations([/* ... */]);
$promise = $client->deleteFleetLocationsAsync([/* ... */]);

Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.

To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.

If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->deleteFleetLocations([
    'FleetId' => '<string>', // REQUIRED
    'Locations' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'LocationStates' => [
        [
            'Location' => '<string>',
            'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DeleteGameServerGroup

$result = $client->deleteGameServerGroup([/* ... */]);
$promise = $client->deleteGameServerGroupAsync([/* ... */]);

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

Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:

• The game server group

• The corresponding Auto Scaling group

• All game servers that are currently running in the group

To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.

If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, Amazon GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.

Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->deleteGameServerGroup([
    'DeleteOption' => 'SAFE_DELETE|FORCE_DELETE|RETAIN',
    'GameServerGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GameServerGroup' => [
        'AutoScalingGroupArn' => '<string>',
        'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
        'CreationTime' => <DateTime>,
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
        'InstanceDefinitions' => [
            [
                'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                'WeightedCapacity' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedTime' => <DateTime>,
        'RoleArn' => '<string>',
        'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
        'StatusReason' => '<string>',
        'SuspendedActions' => ['<string>', ...],
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteGameSessionQueue

$result = $client->deleteGameSessionQueue([/* ... */]);
$promise = $client->deleteGameSessionQueueAsync([/* ... */]);

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.

Parameter Syntax

$result = $client->deleteGameSessionQueue([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

DeleteLocation

$result = $client->deleteLocation([/* ... */]);
$promise = $client->deleteLocationAsync([/* ... */]);

Deletes a custom location.

Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information, see DeregisterCompute.

Parameter Syntax

$result = $client->deleteLocation([
    'LocationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteMatchmakingConfiguration

$result = $client->deleteMatchmakingConfiguration([/* ... */]);
$promise = $client->deleteMatchmakingConfigurationAsync([/* ... */]);

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.

Parameter Syntax

$result = $client->deleteMatchmakingConfiguration([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

DeleteMatchmakingRuleSet

$result = $client->deleteMatchmakingRuleSet([/* ... */]);
$promise = $client->deleteMatchmakingRuleSetAsync([/* ... */]);

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.

Learn more

• Build a rule set

Parameter Syntax

$result = $client->deleteMatchmakingRuleSet([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

DeleteScalingPolicy

$result = $client->deleteScalingPolicy([/* ... */]);
$promise = $client->deleteScalingPolicyAsync([/* ... */]);

Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet.

Parameter Syntax

$result = $client->deleteScalingPolicy([
    'FleetId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

DeleteScript

$result = $client->deleteScript([/* ... */]);
$promise = $client->deleteScriptAsync([/* ... */]);

Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).

To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.

Learn more

Amazon GameLift Realtime Servers

Related actions

All APIs by task

Parameter Syntax

$result = $client->deleteScript([
    'ScriptId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

TaggingFailedException:

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteVpcPeeringAuthorization

$result = $client->deleteVpcPeeringAuthorization([/* ... */]);
$promise = $client->deleteVpcPeeringAuthorizationAsync([/* ... */]);

Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection.

Related actions

All APIs by task

Parameter Syntax

$result = $client->deleteVpcPeeringAuthorization([
    'GameLiftAwsAccountId' => '<string>', // REQUIRED
    'PeerVpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeleteVpcPeeringConnection

$result = $client->deleteVpcPeeringConnection([/* ... */]);
$promise = $client->deleteVpcPeeringConnectionAsync([/* ... */]);

Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete..

Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.

Related actions

All APIs by task

Parameter Syntax

$result = $client->deleteVpcPeeringConnection([
    'FleetId' => '<string>', // REQUIRED
    'VpcPeeringConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeregisterCompute

$result = $client->deregisterCompute([/* ... */]);
$promise = $client->deregisterComputeAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Removes a compute resource from an Amazon GameLift Anywhere fleet or container fleet. Deregistered computes can no longer host game sessions through Amazon GameLift.

For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to deregister fleet computes.

To deregister a compute, call this operation from the compute that's being deregistered and specify the compute name and the fleet ID.

Parameter Syntax

$result = $client->deregisterCompute([
    'ComputeName' => '<string>', // REQUIRED
    'FleetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DeregisterGameServer

$result = $client->deregisterGameServer([/* ... */]);
$promise = $client->deregisterGameServerAsync([/* ... */]);

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

Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.

To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->deregisterGameServer([
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeAlias

$result = $client->describeAlias([/* ... */]);
$promise = $client->describeAliasAsync([/* ... */]);

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

Related actions

All APIs by task

Parameter Syntax

$result = $client->describeAlias([
    'AliasId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Alias' => [
        'AliasArn' => '<string>',
        'AliasId' => '<string>',
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'Name' => '<string>',
        'RoutingStrategy' => [
            'FleetId' => '<string>',
            'Message' => '<string>',
            'Type' => 'SIMPLE|TERMINAL',
        ],
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeBuild

$result = $client->describeBuild([/* ... */]);
$promise = $client->describeBuildAsync([/* ... */]);

Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.

Learn more

Upload a Custom Server Build

All APIs by task

Parameter Syntax

$result = $client->describeBuild([
    'BuildId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Build' => [
        'BuildArn' => '<string>',
        'BuildId' => '<string>',
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'ServerSdkVersion' => '<string>',
        'SizeOnDisk' => <integer>,
        'Status' => 'INITIALIZED|READY|FAILED',
        'Version' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeCompute

$result = $client->describeCompute([/* ... */]);
$promise = $client->describeComputeAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all computes in a fleet, call ListCompute.

To request information on a specific compute, provide the fleet ID and compute name.

If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information:

• For EC2 fleets, this operation returns information about the EC2 instance.

• For ANYWHERE fleets, this operation returns information about the registered compute.

• For CONTAINER fleets, this operation returns information about the container that's registered as a compute, and the instance it's running on. The compute name is the container name.

Parameter Syntax

$result = $client->describeCompute([
    'ComputeName' => '<string>', // REQUIRED
    'FleetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Compute' => [
        'ComputeArn' => '<string>',
        'ComputeName' => '<string>',
        'ComputeStatus' => 'PENDING|ACTIVE|TERMINATING',
        'ContainerAttributes' => [
            'ContainerPortMappings' => [
                [
                    'ConnectionPort' => <integer>,
                    'ContainerPort' => <integer>,
                    'Protocol' => 'TCP|UDP',
                ],
                // ...
            ],
        ],
        'CreationTime' => <DateTime>,
        'DnsName' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'GameLiftAgentEndpoint' => '<string>',
        'GameLiftServiceSdkEndpoint' => '<string>',
        'InstanceId' => '<string>',
        'IpAddress' => '<string>',
        'Location' => '<string>',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
        'Type' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeContainerGroupDefinition

$result = $client->describeContainerGroupDefinition([/* ... */]);
$promise = $client->describeContainerGroupDefinitionAsync([/* ... */]);

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

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

To retrieve a container group definition, provide a resource identifier. If successful, this operation returns the complete properties of the container group definition.

Learn more

• Manage a container group definition

Parameter Syntax

$result = $client->describeContainerGroupDefinition([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContainerGroupDefinition' => [
        'ContainerDefinitions' => [
            [
                'Command' => ['<string>', ...],
                'ContainerName' => '<string>',
                'Cpu' => <integer>,
                'DependsOn' => [
                    [
                        'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                        'ContainerName' => '<string>',
                    ],
                    // ...
                ],
                'EntryPoint' => ['<string>', ...],
                'Environment' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Essential' => true || false,
                'HealthCheck' => [
                    'Command' => ['<string>', ...],
                    'Interval' => <integer>,
                    'Retries' => <integer>,
                    'StartPeriod' => <integer>,
                    'Timeout' => <integer>,
                ],
                'ImageUri' => '<string>',
                'MemoryLimits' => [
                    'HardLimit' => <integer>,
                    'SoftLimit' => <integer>,
                ],
                'PortConfiguration' => [
                    'ContainerPortRanges' => [
                        [
                            'FromPort' => <integer>,
                            'Protocol' => 'TCP|UDP',
                            'ToPort' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'ResolvedImageDigest' => '<string>',
                'WorkingDirectory' => '<string>',
            ],
            // ...
        ],
        'ContainerGroupDefinitionArn' => '<string>',
        'CreationTime' => <DateTime>,
        'Name' => '<string>',
        'OperatingSystem' => 'AMAZON_LINUX_2023',
        'SchedulingStrategy' => 'REPLICA|DAEMON',
        'Status' => 'READY|COPYING|FAILED',
        'StatusReason' => '<string>',
        'TotalCpuLimit' => <integer>,
        'TotalMemoryLimit' => <integer>,
    ],
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeEC2InstanceLimits

$result = $client->describeEC2InstanceLimits([/* ... */]);
$promise = $client->describeEC2InstanceLimitsAsync([/* ... */]);

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift console.

Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:

• Request specifies the Region ap-northeast-1 with no location. The result is limits and usage data on all instance types that are deployed in us-east-2, by all of the fleets that reside in ap-northeast-1.

• Request specifies the Region us-east-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1.

• Request specifies the Region eu-west-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in eu-west-1.

This operation can be used in the following ways:

• To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.

• To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.

If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->describeEC2InstanceLimits([
    'EC2InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
    'Location' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EC2InstanceLimits' => [
        [
            'CurrentInstances' => <integer>,
            'EC2InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
            'InstanceLimit' => <integer>,
            'Location' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetAttributes

$result = $client->describeFleetAttributes([/* ... */]);
$promise = $client->describeFleetAttributesAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.

You can use this operation in the following ways:

• To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.

• To get attributes for all fleets, do not provide a fleet identifier.

When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->describeFleetAttributes([
    'FleetIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FleetAttributes' => [
        [
            'AnywhereConfiguration' => [
                'Cost' => '<string>',
            ],
            'BuildArn' => '<string>',
            'BuildId' => '<string>',
            'CertificateConfiguration' => [
                'CertificateType' => 'DISABLED|GENERATED',
            ],
            'ComputeType' => 'EC2|ANYWHERE|CONTAINER',
            'ContainerGroupsAttributes' => [
                'ConnectionPortRange' => [
                    'FromPort' => <integer>,
                    'ToPort' => <integer>,
                ],
                'ContainerGroupDefinitionProperties' => [
                    [
                        'ContainerGroupDefinitionName' => '<string>',
                        'SchedulingStrategy' => 'REPLICA|DAEMON',
                    ],
                    // ...
                ],
                'ContainerGroupsPerInstance' => [
                    'DesiredReplicaContainerGroupsPerInstance' => <integer>,
                    'MaxReplicaContainerGroupsPerInstance' => <integer>,
                ],
            ],
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'FleetType' => 'ON_DEMAND|SPOT',
            'InstanceRoleArn' => '<string>',
            'InstanceRoleCredentialsProvider' => 'SHARED_CREDENTIAL_FILE',
            'InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
            'LogPaths' => ['<string>', ...],
            'MetricGroups' => ['<string>', ...],
            'Name' => '<string>',
            'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
            'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
            'ResourceCreationLimitPolicy' => [
                'NewGameSessionsPerCreator' => <integer>,
                'PolicyPeriodInMinutes' => <integer>,
            ],
            'ScriptArn' => '<string>',
            'ScriptId' => '<string>',
            'ServerLaunchParameters' => '<string>',
            'ServerLaunchPath' => '<string>',
            'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
            'StoppedActions' => ['<string>', ...],
            'TerminationTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeFleetCapacity

$result = $client->describeFleetCapacity([/* ... */]);
$promise = $client->describeFleetCapacityAsync([/* ... */]);

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for replica container groups.

With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.

This operation can be used in the following ways:

• To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.

• To get capacity data for all fleets, do not provide a fleet identifier.

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist.

Learn more

Setting up Amazon GameLift fleets

GameLift metrics for fleets

Parameter Syntax

$result = $client->describeFleetCapacity([
    'FleetIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FleetCapacity' => [
        [
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'InstanceCounts' => [
                'ACTIVE' => <integer>,
                'DESIRED' => <integer>,
                'IDLE' => <integer>,
                'MAXIMUM' => <integer>,
                'MINIMUM' => <integer>,
                'PENDING' => <integer>,
                'TERMINATING' => <integer>,
            ],
            'InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
            'Location' => '<string>',
            'ReplicaContainerGroupCounts' => [
                'ACTIVE' => <integer>,
                'IDLE' => <integer>,
                'PENDING' => <integer>,
                'TERMINATING' => <integer>,
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeFleetEvents

$result = $client->describeFleetEvents([/* ... */]);
$promise = $client->describeFleetEventsAsync([/* ... */]);

Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.

You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a collection of event log entries matching the request are returned.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->describeFleetEvents([
    'EndTime' => <integer || string || DateTime>,
    'FleetId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'Events' => [
        [
            'Count' => <integer>,
            'EventCode' => 'GENERIC_EVENT|FLEET_CREATED|FLEET_DELETED|FLEET_SCALING_EVENT|FLEET_STATE_DOWNLOADING|FLEET_STATE_VALIDATING|FLEET_STATE_BUILDING|FLEET_STATE_ACTIVATING|FLEET_STATE_ACTIVE|FLEET_STATE_ERROR|FLEET_INITIALIZATION_FAILED|FLEET_BINARY_DOWNLOAD_FAILED|FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND|FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE|FLEET_VALIDATION_TIMED_OUT|FLEET_ACTIVATION_FAILED|FLEET_ACTIVATION_FAILED_NO_INSTANCES|FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED|SERVER_PROCESS_INVALID_PATH|SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT|SERVER_PROCESS_PROCESS_READY_TIMEOUT|SERVER_PROCESS_CRASHED|SERVER_PROCESS_TERMINATED_UNHEALTHY|SERVER_PROCESS_FORCE_TERMINATED|SERVER_PROCESS_PROCESS_EXIT_TIMEOUT|GAME_SESSION_ACTIVATION_TIMEOUT|FLEET_CREATION_EXTRACTING_BUILD|FLEET_CREATION_RUNNING_INSTALLER|FLEET_CREATION_VALIDATING_RUNTIME_CONFIG|FLEET_VPC_PEERING_SUCCEEDED|FLEET_VPC_PEERING_FAILED|FLEET_VPC_PEERING_DELETED|INSTANCE_INTERRUPTED|INSTANCE_RECYCLED|FLEET_CREATION_COMPLETED_INSTALLER|FLEET_CREATION_FAILED_INSTALLER',
            'EventId' => '<string>',
            'EventTime' => <DateTime>,
            'Message' => '<string>',
            'PreSignedLogUrl' => '<string>',
            'ResourceId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

DescribeFleetLocationAttributes

$result = $client->describeFleetLocationAttributes([/* ... */]);
$promise = $client->describeFleetLocationAttributesAsync([/* ... */]);

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

This operation can be used in the following ways:

• To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.

• To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.

When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.

Learn more

Setting up Amazon GameLift fleets

Amazon GameLift service locations for managed hosting

Parameter Syntax

$result = $client->describeFleetLocationAttributes([
    'FleetId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Locations' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'LocationAttributes' => [
        [
            'LocationState' => [
                'Location' => '<string>',
                'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND',
            ],
            'StoppedActions' => ['<string>', ...],
            'UpdateStatus' => 'PENDING_UPDATE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetLocationCapacity

$result = $client->describeFleetLocationCapacity([/* ... */]);
$promise = $client->describeFleetLocationCapacityAsync([/* ... */]);

Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a container fleet, this operation also returns counts for replica container groups.

Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).

To retrieve capacity data, identify a fleet and location.

If successful, a FleetCapacity object is returned for the requested fleet location.

Learn more

Setting up Amazon GameLift fleets

Amazon GameLift service locations for managed hosting

GameLift metrics for fleets

Parameter Syntax

$result = $client->describeFleetLocationCapacity([
    'FleetId' => '<string>', // REQUIRED
    'Location' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FleetCapacity' => [
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'InstanceCounts' => [
            'ACTIVE' => <integer>,
            'DESIRED' => <integer>,
            'IDLE' => <integer>,
            'MAXIMUM' => <integer>,
            'MINIMUM' => <integer>,
            'PENDING' => <integer>,
            'TERMINATING' => <integer>,
        ],
        'InstanceType' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
        'Location' => '<string>',
        'ReplicaContainerGroupCounts' => [
            'ACTIVE' => <integer>,
            'IDLE' => <integer>,
            'PENDING' => <integer>,
            'TERMINATING' => <integer>,
        ],
    ],
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetLocationUtilization

$result = $client->describeFleetLocationUtilization([/* ... */]);
$promise = $client->describeFleetLocationUtilizationAsync([/* ... */]);

Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).

To retrieve utilization data, identify a fleet and location.

If successful, a FleetUtilization object is returned for the requested fleet location.

Learn more

Setting up Amazon GameLift fleets

Amazon GameLift service locations for managed hosting

GameLift metrics for fleets

Parameter Syntax

$result = $client->describeFleetLocationUtilization([
    'FleetId' => '<string>', // REQUIRED
    'Location' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FleetUtilization' => [
        'ActiveGameSessionCount' => <integer>,
        'ActiveServerProcessCount' => <integer>,
        'CurrentPlayerSessionCount' => <integer>,
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'Location' => '<string>',
        'MaximumPlayerSessionCount' => <integer>,
    ],
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetPortSettings

$result = $client->describeFleetPortSettings([/* ... */]);
$promise = $client->describeFleetPortSettingsAsync([/* ... */]);

Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. To connect to game server processes on a container fleet, the port settings should include one or more of the fleet's connection ports.

Use this operation in the following ways:

• To retrieve the port settings for a fleet, identify the fleet's unique identifier.

• To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.

If successful, a set of IpPermission objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up Amazon GameLift fleets

Parameter Syntax

$result = $client->describeFleetPortSettings([
    'FleetId' => '<string>', // REQUIRED
    'Location' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FleetArn' => '<string>',
    'FleetId' => '<string>',
    'InboundPermissions' => [
        [
            'FromPort' => <integer>,
            'IpRange' => '<string>',
            'Protocol' => 'TCP|UDP',
            'ToPort' => <integer>,
        ],
        // ...
    ],
    'Location' => '<string>',
    'UpdateStatus' => 'PENDING_UPDATE',
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeFleetUtilization

$result = $client->describeFleetUtilization([/* ... */]);
$promise = $client->describeFleetUtilizationAsync([/* ... */]);

Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.

This operation can be used in the following ways:

• To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.

• To get utilization data for all fleets, do not provide a fleet identifier.

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region.

Learn more

Setting up Amazon GameLift Fleets

GameLift Metrics for Fleets

Parameter Syntax

$result = $client->describeFleetUtilization([
    'FleetIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FleetUtilization' => [
        [
            'ActiveGameSessionCount' => <integer>,
            'ActiveServerProcessCount' => <integer>,
            'CurrentPlayerSessionCount' => <integer>,
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'Location' => '<string>',
            'MaximumPlayerSessionCount' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeGameServer

$result = $client->describeGameServer([/* ... */]);
$promise = $client->describeGameServerAsync([/* ... */]);

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

Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->describeGameServer([
    'GameServerGroupName' => '<string>', // REQUIRED
    'GameServerId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GameServer' => [
        'ClaimStatus' => 'CLAIMED',
        'ConnectionInfo' => '<string>',
        'GameServerData' => '<string>',
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerId' => '<string>',
        'InstanceId' => '<string>',
        'LastClaimTime' => <DateTime>,
        'LastHealthCheckTime' => <DateTime>,
        'RegistrationTime' => <DateTime>,
        'UtilizationStatus' => 'AVAILABLE|UTILIZED',
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeGameServerGroup

$result = $client->describeGameServerGroup([/* ... */]);
$promise = $client->describeGameServerGroupAsync([/* ... */]);

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

Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.

To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->describeGameServerGroup([
    'GameServerGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GameServerGroup' => [
        'AutoScalingGroupArn' => '<string>',
        'BalancingStrategy' => 'SPOT_ONLY|SPOT_PREFERRED|ON_DEMAND_ONLY',
        'CreationTime' => <DateTime>,
        'GameServerGroupArn' => '<string>',
        'GameServerGroupName' => '<string>',
        'GameServerProtectionPolicy' => 'NO_PROTECTION|FULL_PROTECTION',
        'InstanceDefinitions' => [
            [
                'InstanceType' => 'c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge',
                'WeightedCapacity' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedTime' => <DateTime>,
        'RoleArn' => '<string>',
        'Status' => 'NEW|ACTIVATING|ACTIVE|DELETE_SCHEDULED|DELETING|DELETED|ERROR',
        'StatusReason' => '<string>',
        'SuspendedActions' => ['<string>', ...],
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeGameServerInstances

$result = $client->describeGameServerInstances([/* ... */]);
$promise = $client->describeGameServerInstancesAsync([/* ... */]);

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

Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.

To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned.

This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.

Learn more

Amazon GameLift FleetIQ Guide

Parameter Syntax

$result = $client->describeGameServerInstances([
    'GameServerGroupName' => '<string>', // REQUIRED
    'InstanceIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GameServerInstances' => [
        [
            'GameServerGroupArn' => '<string>',
            'GameServerGroupName' => '<string>',
            'InstanceId' => '<string>',
            'InstanceStatus' => 'ACTIVE|DRAINING|SPOT_TERMINATING',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

DescribeGameSessionDetails

$result = $client->describeGameSessionDetails([/* ... */]);
$promise = $client->describeGameSessionDetailsAsync([/* ... */]);

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. You can optionally filter the results by current game session status.

This operation can be used in the following ways:

• To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.

• To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.

• To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSessionDetail object is returned for each game session that matches the request.

Learn more

Find a game session

All APIs by task

Parameter Syntax

$result = $client->describeGameSessionDetails([
    'AliasId' => '<string>',
    'FleetId' => '<string>',
    'GameSessionId' => '<string>',
    'Limit' => <integer>,
    'Location' => '<string>',
    'NextToken' => '<string>',
    'StatusFilter' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GameSessionDetails' => [
        [
            'GameSession' => [
                'CreationTime' => <DateTime>,
                'CreatorId' => '<string>',
                'CurrentPlayerSessionCount' => <integer>,
                'DnsName' => '<string>',
                'FleetArn' => '<string>',
                'FleetId' => '<string>',
                'GameProperties' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'GameSessionData' => '<string>',
                'GameSessionId' => '<string>',
                'IpAddress' => '<string>',
                'Location' => '<string>',
                'MatchmakerData' => '<string>',
                'MaximumPlayerSessionCount' => <integer>,
                'Name' => '<string>',
                'PlayerSessionCreationPolicy' => 'ACCEPT_ALL|DENY_ALL',
                'Port' => <integer>,
                'Status' => 'ACTIVE|ACTIVATING|TERMINATED|TERMINATING|ERROR',
                'StatusReason' => 'INTERRUPTED',
                'TerminationTime' => <DateTime>,
            ],
            'ProtectionPolicy' => 'NoProtection|FullProtection',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeGameSessionPlacement

$result = $client->describeGameSessionPlacement([/* ... */]);
$promise = $client->describeGameSessionPlacementAsync([/* ... */]);

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

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.

Parameter Syntax

$result = $client->describeGameSessionPlacement([
    'PlacementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GameSessionPlacement' => [
        'DnsName' => '<string>',
        'EndTime' => <DateTime>,
        'GameProperties' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'GameSessionArn' => '<string>',
        'GameSessionData' => '<string>',
        'GameSessionId' => '<string>',
        'GameSessionName' => '<string>',
        'GameSessionQueueName' => '<string>',
        'GameSessionRegion' => '<string>',
        'IpAddress' => '<string>',
        'MatchmakerData' => '<string>',
        'MaximumPlayerSessionCount' => <integer>,
        'PlacedPlayerSessions' => [
            [
                'PlayerId' => '<string>',
                'PlayerSessionId' => '<string>',
            ],
            // ...
        ],
        'PlacementId' => '<string>',
        'PlayerLatencies' => [
            [
                'LatencyInMilliseconds' => <float>,
                'PlayerId' => '<string>',
                'RegionIdentifier' => '<string>',
            ],
            // ...
        ],
        'Port' => <integer>,
        'StartTime' => <DateTime>,
        'Status' => 'PENDING|FULFILLED|CANCELLED|TIMED_OUT|FAILED',
    ],
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeGameSessionQueues

$result = $client->describeGameSessionQueues([/* ... */]);
$promise = $client->describeGameSessionQueuesAsync([/* ... */]);

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.

Learn more

View Your Queues

Parameter Syntax

$result = $client->describeGameSessionQueues([
    'Limit' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GameSessionQueues' => [
        [
            'CustomEventData' => '<string>',
            'Destinations' => [
                [
                    'DestinationArn' => '<string>',
                ],
                // ...
            ],
            'FilterConfiguration' => [
                'AllowedLocations' => ['<string>', ...],
            ],
            'GameSessionQueueArn' => '<string>',
            'Name' => '<string>',
            'NotificationTarget' => '<string>',
            'PlayerLatencyPolicies' => [
                [
                    'MaximumIndividualPlayerLatencyMilliseconds' => <integer>,
                    'PolicyDurationSeconds' => <integer>,
                ],
                // ...
            ],
            'PriorityConfiguration' => [
                'LocationOrder' => ['<string>', ...],
                'PriorityOrder' => ['<string>', ...],
            ],
            'TimeoutInSeconds' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

DescribeGameSessions

$result = $client->describeGameSessions([/* ... */]);
$promise = $client->describeGameSessionsAsync([/* ... */]);

Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.

This operation can be used in the following ways:

• To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.

• To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.

• To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSession object is returned for each game session that matches the request.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessions should only be used for games in development with low game session usage.

Available in Amazon GameLift Local.

Learn more

Find a game session

All APIs by task

Parameter Syntax

$result = $client->describeGameSessions([
    'AliasId' => '<string>',
    'FleetId' => '<string>',
    'GameSessionId' => '<string>',
    'Limit' => <integer>,
    'Location' => '<string>',
    'NextToken' => '<string>',
    'StatusFilter' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GameSessions' => [
        [
            'CreationTime' => <DateTime>,
            'CreatorId' => '<string>',
            'CurrentPlayerSessionCount' => <integer>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'GameProperties' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'GameSessionData' => '<string>',
            'GameSessionId' => '<string>',
            'IpAddress' => '<string>',
            'Location' => '<string>',
            'MatchmakerData' => '<string>',
            'MaximumPlayerSessionCount' => <integer>,
            'Name' => '<string>',
            'PlayerSessionCreationPolicy' => 'ACCEPT_ALL|DENY_ALL',
            'Port' => <integer>,
            'Status' => 'ACTIVE|ACTIVATING|TERMINATED|TERMINATING|ERROR',
            'StatusReason' => 'INTERRUPTED',
            'TerminationTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

TerminalRoutingStrategyException:

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeInstances

$result = $client->describeInstances([/* ... */]);
$promise = $client->describeInstancesAsync([/* ... */]);

Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations ListCompute and DescribeCompute to retrieve information for compute resources, including EC2 and Anywhere fleets.

You can call this operation in the following ways:

• To get information on all instances in a fleet's home Region, specify the fleet ID.

• To get information on all instances in a fleet's remote location, specify the fleet ID and location name.

• To get information on a specific instance in a fleet, specify the fleet ID and instance ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, this operation returns Instance objects for each requested instance, listed in no particular order. If you call this operation for an Anywhere fleet, you receive an InvalidRequestException.

Learn more

Remotely connect to fleet instances

Debug fleet issues

Related actions

All APIs by task

Parameter Syntax

$result = $client->describeInstances([
    'FleetId' => '<string>', // REQUIRED
    'InstanceId' => '<string>',
    'Limit' => <integer>,
    'Location' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Instances' => [
        [
            'CreationTime' => <DateTime>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'InstanceId' => '<string>',
            'IpAddress' => '<string>',
            'Location' => '<string>',
            'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023',
            'Status' => 'PENDING|ACTIVE|TERMINATING',
            'Type' => 't2.micro|t2.small|t2.medium|t2.large|c3.large|c3.xlarge|c3.2xlarge|c3.4xlarge|c3.8xlarge|c4.large|c4.xlarge|c4.2xlarge|c4.4xlarge|c4.8xlarge|c5.large|c5.xlarge|c5.2xlarge|c5.4xlarge|c5.9xlarge|c5.12xlarge|c5.18xlarge|c5.24xlarge|c5a.large|c5a.xlarge|c5a.2xlarge|c5a.4xlarge|c5a.8xlarge|c5a.12xlarge|c5a.16xlarge|c5a.24xlarge|r3.large|r3.xlarge|r3.2xlarge|r3.4xlarge|r3.8xlarge|r4.large|r4.xlarge|r4.2xlarge|r4.4xlarge|r4.8xlarge|r4.16xlarge|r5.large|r5.xlarge|r5.2xlarge|r5.4xlarge|r5.8xlarge|r5.12xlarge|r5.16xlarge|r5.24xlarge|r5a.large|r5a.xlarge|r5a.2xlarge|r5a.4xlarge|r5a.8xlarge|r5a.12xlarge|r5a.16xlarge|r5a.24xlarge|m3.medium|m3.large|m3.xlarge|m3.2xlarge|m4.large|m4.xlarge|m4.2xlarge|m4.4xlarge|m4.10xlarge|m5.large|m5.xlarge|m5.2xlarge|m5.4xlarge|m5.8xlarge|m5.12xlarge|m5.16xlarge|m5.24xlarge|m5a.large|m5a.xlarge|m5a.2xlarge|m5a.4xlarge|m5a.8xlarge|m5a.12xlarge|m5a.16xlarge|m5a.24xlarge|c5d.large|c5d.xlarge|c5d.2xlarge|c5d.4xlarge|c5d.9xlarge|c5d.12xlarge|c5d.18xlarge|c5d.24xlarge|c6a.large|c6a.xlarge|c6a.2xlarge|c6a.4xlarge|c6a.8xlarge|c6a.12xlarge|c6a.16xlarge|c6a.24xlarge|c6i.large|c6i.xlarge|c6i.2xlarge|c6i.4xlarge|c6i.8xlarge|c6i.12xlarge|c6i.16xlarge|c6i.24xlarge|r5d.large|r5d.xlarge|r5d.2xlarge|r5d.4xlarge|r5d.8xlarge|r5d.12xlarge|r5d.16xlarge|r5d.24xlarge|m6g.medium|m6g.large|m6g.xlarge|m6g.2xlarge|m6g.4xlarge|m6g.8xlarge|m6g.12xlarge|m6g.16xlarge|c6g.medium|c6g.large|c6g.xlarge|c6g.2xlarge|c6g.4xlarge|c6g.8xlarge|c6g.12xlarge|c6g.16xlarge|r6g.medium|r6g.large|r6g.xlarge|r6g.2xlarge|r6g.4xlarge|r6g.8xlarge|r6g.12xlarge|r6g.16xlarge|c6gn.medium|c6gn.large|c6gn.xlarge|c6gn.2xlarge|c6gn.4xlarge|c6gn.8xlarge|c6gn.12xlarge|c6gn.16xlarge|c7g.medium|c7g.large|c7g.xlarge|c7g.2xlarge|c7g.4xlarge|c7g.8xlarge|c7g.12xlarge|c7g.16xlarge|r7g.medium|r7g.large|r7g.xlarge|r7g.2xlarge|r7g.4xlarge|r7g.8xlarge|r7g.12xlarge|r7g.16xlarge|m7g.medium|m7g.large|m7g.xlarge|m7g.2xlarge|m7g.4xlarge|m7g.8xlarge|m7g.12xlarge|m7g.16xlarge|g5g.xlarge|g5g.2xlarge|g5g.4xlarge|g5g.8xlarge|g5g.16xlarge',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

UnauthorizedException:

The client failed authentication. Clients should not retry such requests.

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeMatchmaking

$result = $client->describeMatchmaking([/* ... */]);
$promise = $client->describeMatchmakingAsync([/* ... */]);

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.

This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration.

Learn more

Add FlexMatch to a game client

Set Up FlexMatch event notification

Parameter Syntax

$result = $client->describeMatchmaking([
    'TicketIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TicketList' => [
        [
            'ConfigurationArn' => '<string>',
            'ConfigurationName' => '<string>',
            'EndTime' => <DateTime>,
            'EstimatedWaitTime' => <integer>,
            'GameSessionConnectionInfo' => [
                'DnsName' => '<string>',
                'GameSessionArn' => '<string>',
                'IpAddress' => '<string>',
                'MatchedPlayerSessions' => [
                    [
                        'PlayerId' => '<string>',
                        'PlayerSessionId' => '<string>',
                    ],
                    // ...
                ],
                'Port' => <integer>,
            ],
            'Players' => [
                [
                    'LatencyInMs' => [<integer>, ...],
                    'PlayerAttributes' => [
                        '<NonZeroAndMaxString>' => [
                            'N' => <float>,
                            'S' => '<string>',
                            'SDM' => [<float>, ...],
                            'SL' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'PlayerId' => '<string>',
                    'Team' => '<string>',
                ],
                // ...
            ],
            'StartTime' => <DateTime>,
            'Status' => 'CANCELLED|COMPLETED|FAILED|PLACING|QUEUED|REQUIRES_ACCEPTANCE|SEARCHING|TIMED_OUT',
            'StatusMessage' => '<string>',
            'StatusReason' => '<string>',
            'TicketId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeMatchmakingConfigurations

$result = $client->describeMatchmakingConfigurations([/* ... */]);
$promise = $client->describeMatchmakingConfigurationsAsync([/* ... */]);

Retrieves the details of FlexMatch matchmaking configurations.

This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

Learn more

Setting up FlexMatch matchmakers

Parameter Syntax

$result = $client->describeMatchmakingConfigurations([
    'Limit' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
    'RuleSetName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Configurations' => [
        [
            'AcceptanceRequired' => true || false,
            'AcceptanceTimeoutSeconds' => <integer>,
            'AdditionalPlayerCount' => <integer>,
            'BackfillMode' => 'AUTOMATIC|MANUAL',
            'ConfigurationArn' => '<string>',
            'CreationTime' => <DateTime>,
            'CustomEventData' => '<string>',
            'Description' => '<string>',
            'FlexMatchMode' => 'STANDALONE|WITH_QUEUE',
            'GameProperties' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'GameSessionData' => '<string>',
            'GameSessionQueueArns' => ['<string>', ...],
            'Name' => '<string>',
            'NotificationTarget' => '<string>',
            'RequestTimeoutSeconds' => <integer>,
            'RuleSetArn' => '<string>',
            'RuleSetName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribeMatchmakingRuleSets

$result = $client->describeMatchmakingRuleSets([/* ... */]);
$promise = $client->describeMatchmakingRuleSetsAsync([/* ... */]);

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Learn more

• Build a rule set

Parameter Syntax

$result = $client->describeMatchmakingRuleSets([
    'Limit' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RuleSets' => [
        [
            'CreationTime' => <DateTime>,
            'RuleSetArn' => '<string>',
            'RuleSetBody' => '<string>',
            'RuleSetName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

InternalServiceException:

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

NotFoundException:

The requested resources was not found. The resource was either not created yet or deleted.

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

DescribePlayerSessions

$result = $client->describePlayerSessions([/* ... */]);
$promise = $client->describePlayerSessionsAsync([/* ... */]);

Retrieves properties for one or more player sessions.

This action can be used in the following ways:

• To retrieve a specific player session, provide the player session ID only.

• To retrieve all player sessions in a game session, provide the game session ID only.

• To retrieve all player sessions for a specific player, provide a player ID only.

To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. If you provide a specific PlayerSessionId or PlayerId, Amazon GameLift ignores the filter criteria. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a PlayerSession object is returned for each session that matches the request.

Related actions

All APIs by task

Parameter Syntax

$result = $client->describePlayerSessions([
    'GameSessionId' => '<string>',
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'PlayerId' => '<string>',
    'PlayerSessionId' => '<string>',
    'PlayerSessionStatusFilter' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PlayerSessions' => [
        [
            'CreationTime' => <DateTime>,
            'DnsName' => '<string>',
            'FleetArn' => '<string>',
            'FleetId' => '<string>',
            'GameSessionId' => '<string>',
            'IpAddress' => '<string>',
            'PlayerData' => '<string>',
            'PlayerId' => '<string>',
            'PlayerSessionId' => '<string>',
            'Port' => <integer>,
            'Status' => 'RESERVED|ACTIVE|COMPLETED|TIMEDOUT',
            'TerminationTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details