"GameServerGroupName": "MegaFrogServers_NA"
}
CLI command:
aws gamelift claim-game-server \
--game-server-group-name MegaFrogServers_NA
Sample Response
{
"GameServer": {
"ClaimStatus": "CLAIMED",
"ConnectionInfo": "192.0.2.0.80", "GameServerData": "",
"GameServerGroupArn": "arn:aws:gamelift:us-west-2::GameServerGroup/
MegaFrogServers_NA",
"GameServerGroupName": "MegaFrogServers_NA", "GameServerId": "mega-frog-game-12345678", "InstanceId": "i-1234567890abcdef0", "LastClaimTime": 1580218197.293, "LastHealthCheckTime": 1580218197.293, "RegistrationTime": 1580218197.293, "UtilizationStatus": "AVAILABLE"
}}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateAlias
CreateAlias
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 Web Services 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
CreateAlias (p. 12) | ListAliases (p. 250) | DescribeAlias (p. 129) | UpdateAlias (p. 344) | DeleteAlias (p. 95) | ResolveAlias (p. 290) | All APIs by task
Request Syntax
{
"Description": "string", "Name": "string",
"RoutingStrategy": { "FleetId": "string", "Message": "string", "Type": "string"
},
"Tags": [ {
"Key": "string", "Value": "string"
} ]}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 509).
The request accepts the following data in JSON format.
NoteIn the following list, the required parameters are described first.
Name (p. 12)
A descriptive label that is associated with an alias. Alias names do not need to be unique.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: .*\S.*
Response Syntax
Required: Yes RoutingStrategy (p. 12)
The routing configuration, including routing type and fleet target, for the alias.
Type: RoutingStrategy (p. 488) object Required: Yes
Description (p. 12)
A human-readable description of the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No Tags (p. 12)
A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs.
Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference.
Once the resource is created, you can use TagResource (p. 338), UntagResource (p. 341), and ListTagsForResource (p. 272) to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
Type: Array of Tag (p. 501) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
{
"Alias": {
"AliasArn": "string", "AliasId": "string", "CreationTime": number, "Description": "string", "LastUpdatedTime": number, "Name": "string",
"RoutingStrategy": { "FleetId": "string", "Message": "string", "Type": "string"
} } }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Alias (p. 13)
The newly created alias resource.
Errors
Type: Alias (p. 399) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 511).
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.
HTTP Status Code: 400 InternalServiceException
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500 InvalidRequestException
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400 LimitExceededException
The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
HTTP Status Code: 400 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.
HTTP Status Code: 400 UnauthorizedException
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
See Also
• AWS SDK for Ruby V3
CreateBuild
CreateBuild
Creates a new Amazon Web Services build resource for your game server binary files. Game server binaries must be combined into a zip file for use with Amazon Web Services.
Important
When setting up a new game build for GameLift, we recommend using the AWS CLI command upload-build . This helper command combines two tasks: (1) it uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) it creates a new build resource.
The CreateBuild operation can used in the following scenarios:
• To create a new game build with build files that are in an Amazon S3 location under an AWS account that you control. To use this option, you must first give Amazon Web Services access to the Amazon S3 bucket. With permissions in place, call CreateBuild and specify a build name, operating system, and the Amazon S3 storage location of your game build.
• To directly upload your build files to a GameLift Amazon S3 location. To use this option, first call CreateBuild and 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. Build files can be uploaded to the GameLift Amazon S3 location once only; that can't be updated.
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 Related actions
CreateBuild (p. 16) | ListBuilds (p. 253) | DescribeBuild (p. 132) | UpdateBuild (p. 347) | DeleteBuild (p. 97) | All APIs by task
Request Syntax
{ "Name": "string",
"OperatingSystem": "string", "StorageLocation": { "Bucket": "string", "Key": "string",
"ObjectVersion": "string", "RoleArn": "string"
},
"Tags": [ {
"Key": "string", "Value": "string"
} ],
"Version": "string"
}
Request Parameters
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 509).
The request accepts the following data in JSON format.
NoteIn the following list, the required parameters are described first.
Name (p. 16)
A descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild (p. 347) to change this value later.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
OperatingSystem (p. 16)
The operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
Type: String
Valid Values: WINDOWS_2012 | AMAZON_LINUX | AMAZON_LINUX_2 Required: No
StorageLocation (p. 16)
Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon Web Services to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
If a StorageLocation is specified, the size of your file can be found in your Amazon S3 bucket.
Amazon Web Services will report a SizeOnDisk of 0.
Type: S3Location (p. 491) object Required: No
Tags (p. 16)
A list of labels to assign to the new build resource. Tags are developer-defined key-value pairs.
Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference.
Once the resource is created, you can use TagResource (p. 338), UntagResource (p. 341), and ListTagsForResource (p. 272) to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
Type: Array of Tag (p. 501) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Response Syntax
Required: No Version (p. 16)
Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateBuild (p. 347) to change this value later.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
Response Syntax
{
"Build": {
"BuildArn": "string", "BuildId": "string", "CreationTime": number, "Name": "string",
"OperatingSystem": "string", "SizeOnDisk": number, "Status": "string", "Version": "string"
},
"StorageLocation": { "Bucket": "string", "Key": "string",
"ObjectVersion": "string", "RoleArn": "string"
},
"UploadCredentials": { "AccessKeyId": "string", "SecretAccessKey": "string", "SessionToken": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Build (p. 18)
The newly created build resource, including a unique build IDs and status.
Type: Build (p. 404) object StorageLocation (p. 18)
Amazon S3 location for your game build file, including bucket name and key.
Type: S3Location (p. 491) object UploadCredentials (p. 18)
This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned
Errors
by Amazon Web Services. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials (p. 287).
Type: AwsCredentials (p. 403) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 511).
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.
HTTP Status Code: 400 InternalServiceException
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500 InvalidRequestException
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400 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.
HTTP Status Code: 400 UnauthorizedException
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400