AcceptMatch

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

This API works with the following fleet types: EC2, Anywhere, Container

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 Servers 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 resource 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 API works with the following fleet types: EC2 (FleetIQ)

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 Servers 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 Servers 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 Servers 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 resource 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([/* ... */]);

This API works with the following fleet types: EC2, Anywhere, Container

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 Servers 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([/* ... */]);

This API works with the following fleet types: EC2, Anywhere

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

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 Servers 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 Servers 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 Servers 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|WINDOWS_2022',
    '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|WINDOWS_2022',
        '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.

CreateContainerFleet

$result = $client->createContainerFleet([/* ... */]);
$promise = $client->createContainerFleetAsync([/* ... */]);

This API works with the following fleet types: Container

Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game servers. Use this operation to define how to deploy a container architecture onto each fleet instance and configure fleet settings. You can create a container fleet in any Amazon Web Services Regions that Amazon GameLift Servers supports for multi-location fleets. A container fleet can be deployed to a single location or multiple locations. Container fleets are deployed with Amazon Linux 2023 as the instance operating system.

Define the fleet's container architecture using container group definitions. Each fleet can have one of the following container group types:

• The game server container group runs your game server build and dependent software. Amazon GameLift Servers deploys one or more replicas of this container group to each fleet instance. The number of replicas depends on the computing capabilities of the fleet instance in use.

• An optional per-instance container group might be used to run other software that only needs to run once per instance, such as background services, logging, or test processes. One per-instance container group is deployed to each fleet instance.

Each container group can include the definition for one or more containers. A container definition specifies a container image that is stored in an Amazon Elastic Container Registry (Amazon ECR) public or private repository.

Request options

Use this operation to make the following types of requests. Most fleet settings have default values, so you can create a working fleet with a minimal configuration and default values, which you can customize later.

• Create a fleet with no container groups. You can configure a container fleet and then add container group definitions later. In this scenario, no fleet instances are deployed, and the fleet can't host game sessions until you add a game server container group definition. Provide the following required parameter values:

  • FleetRoleArn

• Create a fleet with a game server container group. Provide the following required parameter values:

  • FleetRoleArn

  • GameServerContainerGroupDefinitionName

• Create a fleet with a game server container group and a per-instance container group. Provide the following required parameter values:

  • FleetRoleArn

  • GameServerContainerGroupDefinitionName

  • PerInstanceContainerGroupDefinitionName

Results

If successful, this operation creates a new container fleet resource, places it in PENDING status, and initiates the fleet creation workflow. For fleets with container groups, this workflow starts a fleet deployment and transitions the status to ACTIVE. Fleets without a container group are placed in CREATED status.

You can update most of the properties of a fleet, including container group definitions, and deploy the update across all fleet instances. Use UpdateContainerFleet to deploy a new game server version update across the container fleet.

Parameter Syntax

$result = $client->createContainerFleet([
    'BillingType' => 'ON_DEMAND|SPOT',
    'Description' => '<string>',
    'FleetRoleArn' => '<string>', // REQUIRED
    'GameServerContainerGroupDefinitionName' => '<string>',
    'GameServerContainerGroupsPerInstance' => <integer>,
    'GameSessionCreationLimitPolicy' => [
        'NewGameSessionsPerCreator' => <integer>,
        'PolicyPeriodInMinutes' => <integer>,
    ],
    'InstanceConnectionPortRange' => [
        'FromPort' => <integer>, // REQUIRED
        'ToPort' => <integer>, // REQUIRED
    ],
    'InstanceInboundPermissions' => [
        [
            'FromPort' => <integer>, // REQUIRED
            'IpRange' => '<string>', // REQUIRED
            'Protocol' => 'TCP|UDP', // REQUIRED
            'ToPort' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'InstanceType' => '<string>',
    'Locations' => [
        [
            'Location' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'LogConfiguration' => [
        'LogDestination' => 'NONE|CLOUDWATCH|S3',
        'LogGroupArn' => '<string>',
        'S3BucketName' => '<string>',
    ],
    'MetricGroups' => ['<string>', ...],
    'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
    'PerInstanceContainerGroupDefinitionName' => '<string>',
    'PlayerGatewayMode' => 'DISABLED|ENABLED|REQUIRED',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ContainerFleet' => [
        'BillingType' => 'ON_DEMAND|SPOT',
        'CreationTime' => <DateTime>,
        'DeploymentDetails' => [
            'LatestDeploymentId' => '<string>',
        ],
        'Description' => '<string>',
        'FleetArn' => '<string>',
        'FleetId' => '<string>',
        'FleetRoleArn' => '<string>',
        'GameServerContainerGroupDefinitionArn' => '<string>',
        'GameServerContainerGroupDefinitionName' => '<string>',
        'GameServerContainerGroupsPerInstance' => <integer>,
        'GameSessionCreationLimitPolicy' => [
            'NewGameSessionsPerCreator' => <integer>,
            'PolicyPeriodInMinutes' => <integer>,
        ],
        'InstanceConnectionPortRange' => [
            'FromPort' => <integer>,
            'ToPort' => <integer>,
        ],
        'InstanceInboundPermissions' => [
            [
                'FromPort' => <integer>,
                'IpRange' => '<string>',
                'Protocol' => 'TCP|UDP',
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'InstanceType' => '<string>',
        'LocationAttributes' => [
            [
                'Location' => '<string>',
                'PlayerGatewayStatus' => 'DISABLED|ENABLED',
                'Status' => 'PENDING|CREATING|CREATED|ACTIVATING|ACTIVE|UPDATING|DELETING|EXPIRED',
            ],
            // ...
        ],
        'LogConfiguration' => [
            'LogDestination' => 'NONE|CLOUDWATCH|S3',
            'LogGroupArn' => '<string>',
            'S3BucketName' => '<string>',
        ],
        'MaximumGameServerContainerGroupsPerInstance' => <integer>,
        'MetricGroups' => ['<string>', ...],
        'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
        'PerInstanceContainerGroupDefinitionArn' => '<string>',
        'PerInstanceContainerGroupDefinitionName' => '<string>',
        'PlayerGatewayMode' => 'DISABLED|ENABLED|REQUIRED',
        'Status' => 'PENDING|CREATING|CREATED|ACTIVATING|ACTIVE|UPDATING|DELETING|EXPIRED',
    ],
]

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.

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.

CreateContainerGroupDefinition

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

This API works with the following fleet types: Container

Creates a ContainerGroupDefinition that describes a set of containers for hosting your game server with Amazon GameLift Servers managed containers hosting. An Amazon GameLift Servers container group is similar to a container task or pod. Use container group definitions when you create a container fleet with CreateContainerFleet.

A container group definition determines how Amazon GameLift Servers deploys your containers to each instance in a container fleet. You can maintain multiple versions of a container group definition.

There are two types of container groups:

• A game server container group has the containers that run your game server application and supporting software. A game server container group can have these container types:

  • Game server container. This container runs your game server. You can define one game server container in a game server container group.

  • Support container. This container runs software in parallel with your game server. You can define up to 8 support containers in a game server group.

  When building a game server container group definition, you can choose to bundle your game server executable and all dependent software into a single game server container. Alternatively, you can separate the software into one game server container and one or more support containers.

  On a container fleet instance, a game server container group can be deployed multiple times (depending on the compute resources of the instance). This means that all containers in the container group are replicated together.

• A per-instance container group has containers for processes that aren't replicated on a container fleet instance. This might include background services, logging, test processes, or processes that need to persist independently of the game server container group. When building a per-instance container group, you can define up to 10 support containers.

Request options

Use this operation to make the following types of requests. You can specify values for the minimum required parameters and customize optional values later.

• Create a game server container group definition. Provide the following required parameter values:

  • Name

  • ContainerGroupType (GAME_SERVER)

  • OperatingSystem

  • TotalMemoryLimitMebibytes

  • TotalVcpuLimit

  • At least one GameServerContainerDefinition

    • ContainerName

    • ImageUrl

    • PortConfiguration

    • ServerSdkVersion

• Create a per-instance container group definition. Provide the following required parameter values:

  • Name

  • ContainerGroupType (PER_INSTANCE)

  • OperatingSystem

  • TotalMemoryLimitMebibytes

  • TotalVcpuLimit

  • At least one SupportContainerDefinition

    • ContainerName

    • ImageUrl

Results

If successful, this request creates a ContainerGroupDefinition resource and assigns a unique ARN value. You can update most properties of a container group definition by calling UpdateContainerGroupDefinition, and optionally save the update as a new version.

Parameter Syntax

$result = $client->createContainerGroupDefinition([
    'ContainerGroupType' => 'GAME_SERVER|PER_INSTANCE',
    'GameServerContainerDefinition' => [
        'ContainerName' => '<string>', // REQUIRED
        'DependsOn' => [
            [
                'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY', // REQUIRED
                'ContainerName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'EnvironmentOverride' => [
            [
                'Name' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ImageUri' => '<string>', // REQUIRED
        'LinuxCapabilities' => [
            'Include' => ['<string>', ...],
        ],
        'MountPoints' => [
            [
                'AccessLevel' => 'READ_ONLY|READ_AND_WRITE',
                'ContainerPath' => '<string>',
                'InstancePath' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'PortConfiguration' => [ // REQUIRED
            'ContainerPortRanges' => [ // REQUIRED
                [
                    'FromPort' => <integer>, // REQUIRED
                    'Protocol' => 'TCP|UDP', // REQUIRED
                    'ToPort' => <integer>, // REQUIRED
                ],
                // ...
            ],
        ],
        'ServerSdkVersion' => '<string>', // REQUIRED
    ],
    'Name' => '<string>', // REQUIRED
    'OperatingSystem' => 'AMAZON_LINUX_2023', // REQUIRED
    'SupportContainerDefinitions' => [
        [
            'ContainerName' => '<string>', // REQUIRED
            'DependsOn' => [
                [
                    'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY', // REQUIRED
                    'ContainerName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'EnvironmentOverride' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Essential' => true || false,
            'HealthCheck' => [
                'Command' => ['<string>', ...], // REQUIRED
                'Interval' => <integer>,
                'Retries' => <integer>,
                'StartPeriod' => <integer>,
                'Timeout' => <integer>,
            ],
            'ImageUri' => '<string>', // REQUIRED
            'LinuxCapabilities' => [
                'Include' => ['<string>', ...],
            ],
            'MemoryHardLimitMebibytes' => <integer>,
            'MountPoints' => [
                [
                    'AccessLevel' => 'READ_ONLY|READ_AND_WRITE',
                    'ContainerPath' => '<string>',
                    'InstancePath' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'PortConfiguration' => [
                'ContainerPortRanges' => [ // REQUIRED
                    [
                        'FromPort' => <integer>, // REQUIRED
                        'Protocol' => 'TCP|UDP', // REQUIRED
                        'ToPort' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Vcpu' => <float>,
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TotalMemoryLimitMebibytes' => <integer>, // REQUIRED
    'TotalVcpuLimit' => <float>, // REQUIRED
    'VersionDescription' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ContainerGroupDefinition' => [
        'ContainerGroupDefinitionArn' => '<string>',
        'ContainerGroupType' => 'GAME_SERVER|PER_INSTANCE',
        'CreationTime' => <DateTime>,
        'GameServerContainerDefinition' => [
            'ContainerName' => '<string>',
            'DependsOn' => [
                [
                    'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                    'ContainerName' => '<string>',
                ],
                // ...
            ],
            'EnvironmentOverride' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'ImageUri' => '<string>',
            'LinuxCapabilities' => [
                'Include' => ['<string>', ...],
            ],
            'MountPoints' => [
                [
                    'AccessLevel' => 'READ_ONLY|READ_AND_WRITE',
                    'ContainerPath' => '<string>',
                    'InstancePath' => '<string>',
                ],
                // ...
            ],
            'PortConfiguration' => [
                'ContainerPortRanges' => [
                    [
                        'FromPort' => <integer>,
                        'Protocol' => 'TCP|UDP',
                        'ToPort' => <integer>,
                    ],
                    // ...
                ],
            ],
            'ResolvedImageDigest' => '<string>',
            'ServerSdkVersion' => '<string>',
        ],
        'Name' => '<string>',
        'OperatingSystem' => 'AMAZON_LINUX_2023',
        'Status' => 'READY|COPYING|FAILED',
        'StatusReason' => '<string>',
        'SupportContainerDefinitions' => [
            [
                'ContainerName' => '<string>',
                'DependsOn' => [
                    [
                        'Condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                        'ContainerName' => '<string>',
                    ],
                    // ...
                ],
                'EnvironmentOverride' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Essential' => true || false,
                'HealthCheck' => [
                    'Command' => ['<string>', ...],
                    'Interval' => <integer>,
                    'Retries' => <integer>,
                    'StartPeriod' => <integer>,
                    'Timeout' => <integer>,
                ],
                'ImageUri' => '<string>',
                'LinuxCapabilities' => [
                    'Include' => ['<string>', ...],
                ],
                'MemoryHardLimitMebibytes' => <integer>,
                'MountPoints' => [
                    [
                        'AccessLevel' => 'READ_ONLY|READ_AND_WRITE',
                        'ContainerPath' => '<string>',
                        'InstancePath' => '<string>',
                    ],
                    // ...
                ],
                'PortConfiguration' => [
                    'ContainerPortRanges' => [
                        [
                            'FromPort' => <integer>,
                            'Protocol' => 'TCP|UDP',
                            'ToPort' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'ResolvedImageDigest' => '<string>',
                'Vcpu' => <float>,
            ],
            // ...
        ],
        'TotalMemoryLimitMebibytes' => <integer>,
        'TotalVcpuLimit' => <float>,
        'VersionDescription' => '<string>',
        'VersionNumber' => <integer>,
    ],
]

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.

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.

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.

UnauthorizedException:

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

UnsupportedRegionException:

The requested operation is not supported in the Region specified.

CreateFleet

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

This API works with the following fleet types: EC2, Anywhere, Container

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

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

Anywhere fleet

An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift Servers. 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

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',
    '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|r6i.large|r6i.xlarge|r6i.2xlarge|r6i.4xlarge|r6i.8xlarge|r6i.12xlarge|r6i.16xlarge|c6gd.medium|c6gd.large|c6gd.xlarge|c6gd.2xlarge|c6gd.4xlarge|c6gd.8xlarge|c6gd.12xlarge|c6gd.16xlarge|c6in.large|c6in.xlarge|c6in.2xlarge|c6in.4xlarge|c6in.8xlarge|c6in.12xlarge|c6in.16xlarge|c7a.medium|c7a.large|c7a.xlarge|c7a.2xlarge|c7a.4xlarge|c7a.8xlarge|c7a.12xlarge|c7a.16xlarge|c7gd.medium|c7gd.large|c7gd.xlarge|c7gd.2xlarge|c7gd.4xlarge|c7gd.8xlarge|c7gd.12xlarge|c7gd.16xlarge|c7gn.medium|c7gn.large|c7gn.xlarge|c7gn.2xlarge|c7gn.4xlarge|c7gn.8xlarge|c7gn.12xlarge|c7gn.16xlarge|c7i.large|c7i.xlarge|c7i.2xlarge|c7i.4xlarge|c7i.8xlarge|c7i.12xlarge|c7i.16xlarge|m6a.large|m6a.xlarge|m6a.2xlarge|m6a.4xlarge|m6a.8xlarge|m6a.12xlarge|m6a.16xlarge|m6gd.medium|m6gd.large|m6gd.xlarge|m6gd.2xlarge|m6gd.4xlarge|m6gd.8xlarge|m6gd.12xlarge|m6gd.16xlarge|m6i.large|m6i.xlarge|m6i.2xlarge|m6i.4xlarge|m6i.8xlarge|m6i.12xlarge|m6i.16xlarge|m7a.medium|m7a.large|m7a.xlarge|m7a.2xlarge|m7a.4xlarge|m7a.8xlarge|m7a.12xlarge|m7a.16xlarge|m7gd.medium|m7gd.large|m7gd.xlarge|m7gd.2xlarge|m7gd.4xlarge|m7gd.8xlarge|m7gd.12xlarge|m7gd.16xlarge|m7i.large|m7i.xlarge|m7i.2xlarge|m7i.4xlarge|m7i.8xlarge|m7i.12xlarge|m7i.16xlarge|r6gd.medium|r6gd.large|r6gd.xlarge|r6gd.2xlarge|r6gd.4xlarge|r6gd.8xlarge|r6gd.12xlarge|r6gd.16xlarge|r7a.medium|r7a.large|r7a.xlarge|r7a.2xlarge|r7a.4xlarge|r7a.8xlarge|r7a.12xlarge|r7a.16xlarge|r7gd.medium|r7gd.large|r7gd.xlarge|r7gd.2xlarge|r7gd.4xlarge|r7gd.8xlarge|r7gd.12xlarge|r7gd.16xlarge|r7i.large|r7i.xlarge|r7i.2xlarge|r7i.4xlarge|r7i.8xlarge|r7i.12xlarge|r7i.16xlarge|r7i.24xlarge|r7i.48xlarge|c5ad.large|c5ad.xlarge|c5ad.2xlarge|c5ad.4xlarge|c5ad.8xlarge|c5ad.12xlarge|c5ad.16xlarge|c5ad.24xlarge|c5n.large|c5n.xlarge|c5n.2xlarge|c5n.4xlarge|c5n.9xlarge|c5n.18xlarge|r5ad.large|r5ad.xlarge|r5ad.2xlarge|r5ad.4xlarge|r5ad.8xlarge|r5ad.12xlarge|r5ad.16xlarge|r5ad.24xlarge|c6id.large|c6id.xlarge|c6id.2xlarge|c6id.4xlarge|c6id.8xlarge|c6id.12xlarge|c6id.16xlarge|c6id.24xlarge|c6id.32xlarge|c8g.medium|c8g.large|c8g.xlarge|c8g.2xlarge|c8g.4xlarge|c8g.8xlarge|c8g.12xlarge|c8g.16xlarge|c8g.24xlarge|c8g.48xlarge|m5ad.large|m5ad.xlarge|m5ad.2xlarge|m5ad.4xlarge|m5ad.8xlarge|m5ad.12xlarge|m5ad.16xlarge|m5ad.24xlarge|m5d.large|m5d.xlarge|m5d.2xlarge|m5d.4xlarge|m5d.8xlarge|m5d.12xlarge|m5d.16xlarge|m5d.24xlarge|m5dn.large|m5dn.xlarge|m5dn.2xlarge|m5dn.4xlarge|m5dn.8xlarge|m5dn.12xlarge|m5dn.16xlarge|m5dn.24xlarge|m5n.large|m5n.xlarge|m5n.2xlarge|m5n.4xlarge|m5n.8xlarge|m5n.12xlarge|m5n.16xlarge|m5n.24xlarge|m6id.large|m6id.xlarge|m6id.2xlarge|m6id.4xlarge|m6id.8xlarge|m6id.12xlarge|m6id.16xlarge|m6id.24xlarge|m6id.32xlarge|m6idn.large|m6idn.xlarge|m6idn.2xlarge|m6idn.4xlarge|m6idn.8xlarge|m6idn.12xlarge|m6idn.16xlarge|m6idn.24xlarge|m6idn.32xlarge|m6in.large|m6in.xlarge|m6in.2xlarge|m6in.4xlarge|m6in.8xlarge|m6in.12xlarge|m6in.16xlarge|m6in.24xlarge|m6in.32xlarge|m8g.medium|m8g.large|m8g.xlarge|m8g.2xlarge|m8g.4xlarge|m8g.8xlarge|m8g.12xlarge|m8g.16xlarge|m8g.24xlarge|m8g.48xlarge|r5dn.large|r5dn.xlarge|r5dn.2xlarge|r5dn.4xlarge|r5dn.8xlarge|r5dn.12xlarge|r5dn.16xlarge|r5dn.24xlarge|r5n.large|r5n.xlarge|r5n.2xlarge|r5n.4xlarge|r5n.8xlarge|r5n.12xlarge|r5n.16xlarge|r5n.24xlarge|r6a.large|r6a.xlarge|r6a.2xlarge|r6a.4xlarge|r6a.8xlarge|r6a.12xlarge|r6a.16xlarge|r6a.24xlarge|r6a.32xlarge|r6a.48xlarge|r6id.large|r6id.xlarge|r6id.2xlarge|r6id.4xlarge|r6id.8xlarge|r6id.12xlarge|r6id.16xlarge|r6id.24xlarge|r6id.32xlarge|r6idn.large|r6idn.xlarge|r6idn.2xlarge|r6idn.4xlarge|r6idn.8xlarge|r6idn.12xlarge|r6idn.16xlarge|r6idn.24xlarge|r6idn.32xlarge|r6in.large|r6in.xlarge|r6in.2xlarge|r6in.4xlarge|r6in.8xlarge|r6in.12xlarge|r6in.16xlarge|r6in.24xlarge|r6in.32xlarge|r8g.medium|r8g.large|r8g.xlarge|r8g.2xlarge|r8g.4xlarge|r8g.8xlarge|r8g.12xlarge|r8g.16xlarge|r8g.24xlarge|r8g.48xlarge|m4.16xlarge|c6a.32xlarge|c6a.48xlarge|c6i.32xlarge|r6i.24xlarge|r6i.32xlarge|c6in.24xlarge|c6in.32xlarge|c7a.24xlarge|c7a.32xlarge|c7a.48xlarge|c7i.24xlarge|c7i.48xlarge|m6a.24xlarge|m6a.32xlarge|m6a.48xlarge|m6i.24xlarge|m6i.32xlarge|m7a.24xlarge|m7a.32xlarge|m7a.48xlarge|m7i.24xlarge|m7i.48xlarge|r7a.24xlarge|r7a.32xlarge|r7a.48xlarge|c8a.medium|c8a.large|c8a.xlarge|c8a.2xlarge|c8i.large|c8i.xlarge|c8i.2xlarge|c9g.medium|c9g.large|c9g.xlarge|c9g.2xlarge|m8a.medium|m8a.large|m8a.xlarge|m8a.2xlarge|m8i.large|m8i.xlarge|m8i.2xlarge|m9g.large|m9g.xlarge|m9g.2xlarge',
    '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>',
    'PlayerGatewayConfiguration' => [
        'GameServerIpProtocolSupported' => 'IPv4|DUAL_STACK',
    ],
    'PlayerGatewayMode' => 'DISABLED|ENABLED|REQUIRED',
    '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',
        '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|r6i.large|r6i.xlarge|r6i.2xlarge|r6i.4xlarge|r6i.8xlarge|r6i.12xlarge|r6i.16xlarge|c6gd.medium|c6gd.large|c6gd.xlarge|c6gd.2xlarge|c6gd.4xlarge|c6gd.8xlarge|c6gd.12xlarge|c6gd.16xlarge|c6in.large|c6in.xlarge|c6in.2xlarge|c6in.4xlarge|c6in.8xlarge|c6in.12xlarge|c6in.16xlarge|c7a.medium|c7a.large|c7a.xlarge|c7a.2xlarge|c7a.4xlarge|c7a.8xlarge|c7a.12xlarge|c7a.16xlarge|c7gd.medium|c7gd.large|c7gd.xlarge|c7gd.2xlarge|c7gd.4xlarge|c7gd.8xlarge|c7gd.12xlarge|c7gd.16xlarge|c7gn.medium|c7gn.large|c7gn.xlarge|c7gn.2xlarge|c7gn.4xlarge|c7gn.8xlarge|c7gn.12xlarge|c7gn.16xlarge|c7i.large|c7i.xlarge|c7i.2xlarge|c7i.4xlarge|c7i.8xlarge|c7i.12xlarge|c7i.16xlarge|m6a.large|m6a.xlarge|m6a.2xlarge|m6a.4xlarge|m6a.8xlarge|m6a.12xlarge|m6a.16xlarge|m6gd.medium|m6gd.large|m6gd.xlarge|m6gd.2xlarge|m6gd.4xlarge|m6gd.8xlarge|m6gd.12xlarge|m6gd.16xlarge|m6i.large|m6i.xlarge|m6i.2xlarge|m6i.4xlarge|m6i.8xlarge|m6i.12xlarge|m6i.16xlarge|m7a.medium|m7a.large|m7a.xlarge|m7a.2xlarge|m7a.4xlarge|m7a.8xlarge|m7a.12xlarge|m7a.16xlarge|m7gd.medium|m7gd.large|m7gd.xlarge|m7gd.2xlarge|m7gd.4xlarge|m7gd.8xlarge|m7gd.12xlarge|m7gd.16xlarge|m7i.large|m7i.xlarge|m7i.2xlarge|m7i.4xlarge|m7i.8xlarge|m7i.12xlarge|m7i.16xlarge|r6gd.medium|r6gd.large|r6gd.xlarge|r6gd.2xlarge|r6gd.4xlarge|r6gd.8xlarge|r6gd.12xlarge|r6gd.16xlarge|r7a.medium|r7a.large|r7a.xlarge|r7a.2xlarge|r7a.4xlarge|r7a.8xlarge|r7a.12xlarge|r7a.16xlarge|r7gd.medium|r7gd.large|r7gd.xlarge|r7gd.2xlarge|r7gd.4xlarge|r7gd.8xlarge|r7gd.12xlarge|r7gd.16xlarge|r7i.large|r7i.xlarge|r7i.2xlarge|r7i.4xlarge|r7i.8xlarge|r7i.12xlarge|r7i.16xlarge|r7i.24xlarge|r7i.48xlarge|c5ad.large|c5ad.xlarge|c5ad.2xlarge|c5ad.4xlarge|c5ad.8xlarge|c5ad.12xlarge|c5ad.16xlarge|c5ad.24xlarge|c5n.large|c5n.xlarge|c5n.2xlarge|c5n.4xlarge|c5n.9xlarge|c5n.18xlarge|r5ad.large|r5ad.xlarge|r5ad.2xlarge|r5ad.4xlarge|r5ad.8xlarge|r5ad.12xlarge|r5ad.16xlarge|r5ad.24xlarge|c6id.large|c6id.xlarge|c6id.2xlarge|c6id.4xlarge|c6id.8xlarge|c6id.12xlarge|c6id.16xlarge|c6id.24xlarge|c6id.32xlarge|c8g.medium|c8g.large|c8g.xlarge|c8g.2xlarge|c8g.4xlarge|c8g.8xlarge|c8g.12xlarge|c8g.16xlarge|c8g.24xlarge|c8g.48xlarge|m5ad.large|m5ad.xlarge|m5ad.2xlarge|m5ad.4xlarge|m5ad.8xlarge|m5ad.12xlarge|m5ad.16xlarge|m5ad.24xlarge|m5d.large|m5d.xlarge|m5d.2xlarge|m5d.4xlarge|m5d.8xlarge|m5d.12xlarge|m5d.16xlarge|m5d.24xlarge|m5dn.large|m5dn.xlarge|m5dn.2xlarge|m5dn.4xlarge|m5dn.8xlarge|m5dn.12xlarge|m5dn.16xlarge|m5dn.24xlarge|m5n.large|m5n.xlarge|m5n.2xlarge|m5n.4xlarge|m5n.8xlarge|m5n.12xlarge|m5n.16xlarge|m5n.24xlarge|m6id.large|m6id.xlarge|m6id.2xlarge|m6id.4xlarge|m6id.8xlarge|m6id.12xlarge|m6id.16xlarge|m6id.24xlarge|m6id.32xlarge|m6idn.large|m6idn.xlarge|m6idn.2xlarge|m6idn.4xlarge|m6idn.8xlarge|m6idn.12xlarge|m6idn.16xlarge|m6idn.24xlarge|m6idn.32xlarge|m6in.large|m6in.xlarge|m6in.2xlarge|m6in.4xlarge|m6in.8xlarge|m6in.12xlarge|m6in.16xlarge|m6in.24xlarge|m6in.32xlarge|m8g.medium|m8g.large|m8g.xlarge|m8g.2xlarge|m8g.4xlarge|m8g.8xlarge|m8g.12xlarge|m8g.16xlarge|m8g.24xlarge|m8g.48xlarge|r5dn.large|r5dn.xlarge|r5dn.2xlarge|r5dn.4xlarge|r5dn.8xlarge|r5dn.12xlarge|r5dn.16xlarge|r5dn.24xlarge|r5n.large|r5n.xlarge|r5n.2xlarge|r5n.4xlarge|r5n.8xlarge|r5n.12xlarge|r5n.16xlarge|r5n.24xlarge|r6a.large|r6a.xlarge|r6a.2xlarge|r6a.4xlarge|r6a.8xlarge|r6a.12xlarge|r6a.16xlarge|r6a.24xlarge|r6a.32xlarge|r6a.48xlarge|r6id.large|r6id.xlarge|r6id.2xlarge|r6id.4xlarge|r6id.8xlarge|r6id.12xlarge|r6id.16xlarge|r6id.24xlarge|r6id.32xlarge|r6idn.large|r6idn.xlarge|r6idn.2xlarge|r6idn.4xlarge|r6idn.8xlarge|r6idn.12xlarge|r6idn.16xlarge|r6idn.24xlarge|r6idn.32xlarge|r6in.large|r6in.xlarge|r6in.2xlarge|r6in.4xlarge|r6in.8xlarge|r6in.12xlarge|r6in.16xlarge|r6in.24xlarge|r6in.32xlarge|r8g.medium|r8g.large|r8g.xlarge|r8g.2xlarge|r8g.4xlarge|r8g.8xlarge|r8g.12xlarge|r8g.16xlarge|r8g.24xlarge|r8g.48xlarge|m4.16xlarge|c6a.32xlarge|c6a.48xlarge|c6i.32xlarge|r6i.24xlarge|r6i.32xlarge|c6in.24xlarge|c6in.32xlarge|c7a.24xlarge|c7a.32xlarge|c7a.48xlarge|c7i.24xlarge|c7i.48xlarge|m6a.24xlarge|m6a.32xlarge|m6a.48xlarge|m6i.24xlarge|m6i.32xlarge|m7a.24xlarge|m7a.32xlarge|m7a.48xlarge|m7i.24xlarge|m7i.48xlarge|r7a.24xlarge|r7a.32xlarge|r7a.48xlarge|c8a.medium|c8a.large|c8a.xlarge|c8a.2xlarge|c8i.large|c8i.xlarge|c8i.2xlarge|c9g.medium|c9g.large|c9g.xlarge|c9g.2xlarge|m8a.medium|m8a.large|m8a.xlarge|m8a.2xlarge|m8i.large|m8i.xlarge|m8i.2xlarge|m9g.large|m9g.xlarge|m9g.2xlarge',
        'LogPaths' => ['<string>', ...],
        'MetricGroups' => ['<string>', ...],
        'Name' => '<string>',
        'NewGameSessionProtectionPolicy' => 'NoProtection|FullProtection',
        'OperatingSystem' => 'WINDOWS_2012|AMAZON_LINUX|AMAZON_LINUX_2|WINDOWS_2016|AMAZON_LINUX_2023|WINDOWS_2022',
        'PlayerGatewayConfiguration' => [
            'GameServerIpProtocolSupported' => 'IPv4|DUAL_STACK',
        ],
        'PlayerGatewayMode' => 'DISABLED|ENABLED|REQUIRED',
        '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|EXPIRED',
        'StoppedActions' => ['<string>', ...],
        'TerminationTime' => <DateTime>,
    ],
    'LocationStates' => [
        [
            'Location' => '<string>',
            'PlayerGatewayStatus' => 'DISABLED|ENABLED',
            'Status' => 'NEW|DOWNLOADING|VALIDATING|BUILDING|ACTIVATING|ACTIVE|DELETING|ERROR|TERMINATED|NOT_FOUND|EXPIRED',
        ],
        // ...
    ],
]

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 resource was not found. The resource was either not created yet or deleted.

NotReadyException:

The operation failed because Amazon GameLift Servers 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 API works with the following fleet types: EC2, Anywhere, Container

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