@aws-sdk/client-gamelift 3.48.0 → 3.52.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +35 -0
- package/README.md +5 -5
- package/dist-types/GameLift.d.ts +182 -125
- package/dist-types/GameLiftClient.d.ts +5 -5
- package/dist-types/commands/CreateAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateBuildCommand.d.ts +4 -4
- package/dist-types/commands/CreateFleetCommand.d.ts +6 -3
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +1 -1
- package/dist-types/commands/CreateGameServerGroupCommand.d.ts +6 -6
- package/dist-types/commands/CreateGameSessionCommand.d.ts +1 -1
- package/dist-types/commands/CreateGameSessionQueueCommand.d.ts +13 -6
- package/dist-types/commands/CreateMatchmakingConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/CreatePlayerSessionCommand.d.ts +3 -1
- package/dist-types/commands/CreatePlayerSessionsCommand.d.ts +3 -1
- package/dist-types/commands/CreateScriptCommand.d.ts +6 -6
- package/dist-types/commands/CreateVpcPeeringAuthorizationCommand.d.ts +12 -12
- package/dist-types/commands/CreateVpcPeeringConnectionCommand.d.ts +8 -8
- package/dist-types/commands/DeleteGameSessionQueueCommand.d.ts +10 -5
- package/dist-types/commands/DeleteScriptCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVpcPeeringConnectionCommand.d.ts +2 -2
- package/dist-types/commands/DescribeEC2InstanceLimitsCommand.d.ts +6 -6
- package/dist-types/commands/DescribeGameSessionDetailsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGameSessionPlacementCommand.d.ts +10 -2
- package/dist-types/commands/DescribeGameSessionQueuesCommand.d.ts +8 -4
- package/dist-types/commands/DescribeGameSessionsCommand.d.ts +16 -2
- package/dist-types/commands/DescribeMatchmakingCommand.d.ts +1 -1
- package/dist-types/commands/DescribePlayerSessionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeScriptCommand.d.ts +1 -1
- package/dist-types/commands/DescribeVpcPeeringAuthorizationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeVpcPeeringConnectionsCommand.d.ts +2 -2
- package/dist-types/commands/GetGameSessionLogUrlCommand.d.ts +1 -1
- package/dist-types/commands/GetInstanceAccessCommand.d.ts +1 -1
- package/dist-types/commands/ListAliasesCommand.d.ts +1 -1
- package/dist-types/commands/ListBuildsCommand.d.ts +1 -1
- package/dist-types/commands/ListFleetsCommand.d.ts +1 -1
- package/dist-types/commands/ListGameServerGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListScriptsCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -4
- package/dist-types/commands/PutScalingPolicyCommand.d.ts +4 -4
- package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +1 -1
- package/dist-types/commands/SearchGameSessionsCommand.d.ts +7 -0
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +5 -5
- package/dist-types/commands/StartMatchBackfillCommand.d.ts +1 -0
- package/dist-types/commands/StartMatchmakingCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +5 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +2 -2
- package/dist-types/commands/UpdateGameSessionQueueCommand.d.ts +8 -4
- package/dist-types/commands/UpdateScriptCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +302 -259
- package/package.json +40 -34
|
@@ -221,9 +221,9 @@ declare type GameLiftClientResolvedConfigType = __SmithyResolvedConfiguration<__
|
|
|
221
221
|
export interface GameLiftClientResolvedConfig extends GameLiftClientResolvedConfigType {
|
|
222
222
|
}
|
|
223
223
|
/**
|
|
224
|
-
* <fullname>
|
|
225
|
-
* <p>
|
|
226
|
-
* cloud, including tools for deploying, operating, and scaling game servers. Built on
|
|
224
|
+
* <fullname>GameLift Service</fullname>
|
|
225
|
+
* <p>Amazon Web Services provides solutions for hosting session-based multiplayer game servers in the
|
|
226
|
+
* cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services
|
|
227
227
|
* global computing infrastructure, GameLift helps you deliver high-performance,
|
|
228
228
|
* high-reliability, low-cost game servers while dynamically scaling your resource usage to
|
|
229
229
|
* meet player demand. </p>
|
|
@@ -262,8 +262,8 @@ export interface GameLiftClientResolvedConfig extends GameLiftClientResolvedConf
|
|
|
262
262
|
* <p>
|
|
263
263
|
* <b>About this API Reference</b>
|
|
264
264
|
* </p>
|
|
265
|
-
* <p>This reference guide describes the low-level service API for Amazon
|
|
266
|
-
* in this guide, you can find links to language-specific SDK guides and the
|
|
265
|
+
* <p>This reference guide describes the low-level service API for Amazon Web Services. With each topic
|
|
266
|
+
* in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI
|
|
267
267
|
* reference. Useful links:</p>
|
|
268
268
|
* <ul>
|
|
269
269
|
* <li>
|
|
@@ -11,7 +11,7 @@ export interface CreateAliasCommandOutput extends CreateAliasOutput, __MetadataB
|
|
|
11
11
|
* a fleet ID. An alias provides a level of abstraction for a fleet that is useful when
|
|
12
12
|
* redirecting player traffic from one fleet to another, such as when updating your game
|
|
13
13
|
* build. </p>
|
|
14
|
-
* <p>Amazon
|
|
14
|
+
* <p>Amazon Web Services supports two types of routing strategies for aliases: simple and terminal. A
|
|
15
15
|
* simple alias points to an active fleet. A terminal alias is used to display messaging or
|
|
16
16
|
* link to a URL instead of routing players to an active fleet. For example, you might use
|
|
17
17
|
* a terminal alias when a game version is no longer supported and you want to direct
|
|
@@ -7,10 +7,10 @@ export interface CreateBuildCommandInput extends CreateBuildInput {
|
|
|
7
7
|
export interface CreateBuildCommandOutput extends CreateBuildOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new Amazon
|
|
11
|
-
* binaries must be combined into a zip file for use with Amazon
|
|
10
|
+
* <p>Creates a new Amazon Web Services build resource for your game server binary files. Game server
|
|
11
|
+
* binaries must be combined into a zip file for use with Amazon Web Services. </p>
|
|
12
12
|
* <important>
|
|
13
|
-
* <p>When setting up a new game build for GameLift, we recommend using the
|
|
13
|
+
* <p>When setting up a new game build for GameLift, we recommend using the Amazon Web Services CLI
|
|
14
14
|
* command <b>
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
|
|
16
16
|
* </b>. This helper command combines two tasks: (1) it
|
|
@@ -21,7 +21,7 @@ export interface CreateBuildCommandOutput extends CreateBuildOutput, __MetadataB
|
|
|
21
21
|
* <ul>
|
|
22
22
|
* <li>
|
|
23
23
|
* <p>To create a new game build with build files that are in an Amazon S3 location under
|
|
24
|
-
* an
|
|
24
|
+
* an Amazon Web Services account that you control. To use this option, you must first give Amazon Web Services
|
|
25
25
|
* access to the Amazon S3 bucket. With permissions in place, call
|
|
26
26
|
* <code>CreateBuild</code> and specify a build name, operating system, and the
|
|
27
27
|
* Amazon S3 storage location of your game build.</p>
|
|
@@ -7,12 +7,12 @@ export interface CreateFleetCommandInput extends CreateFleetInput {
|
|
|
7
7
|
export interface CreateFleetCommandOutput extends CreateFleetOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a fleet of Amazon Elastic Compute Cloud (Amazon
|
|
10
|
+
* <p>Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your
|
|
11
11
|
* custom game server or Realtime Servers. Use this operation to configure the computing resources for
|
|
12
12
|
* your fleet and provide instructions for running game servers on each instance.</p>
|
|
13
13
|
* <p>Most GameLift fleets can deploy instances to multiple locations, including the home
|
|
14
14
|
* Region (where the fleet is created) and an optional set of remote locations. Fleets that
|
|
15
|
-
* are created in the following
|
|
15
|
+
* are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N.
|
|
16
16
|
* Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland),
|
|
17
17
|
* ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that
|
|
18
18
|
* are created in other GameLift Regions can deploy instances in the fleet's home Region
|
|
@@ -23,7 +23,10 @@ export interface CreateFleetCommandOutput extends CreateFleetOutput, __MetadataB
|
|
|
23
23
|
* to start and run game servers on each instance in the fleet. Set permissions for inbound
|
|
24
24
|
* traffic to your game servers, and enable optional features as needed. When creating a
|
|
25
25
|
* multi-location fleet, provide a list of additional remote locations.</p>
|
|
26
|
-
*
|
|
26
|
+
* <p>If you need to debug your fleet, fetch logs, view performance metrics
|
|
27
|
+
* or other actions on the fleet, create the development fleet with port 22/3389 open.
|
|
28
|
+
* As a best practice, we recommend opening ports for remote access only when you need them
|
|
29
|
+
* and closing them when you're finished. </p>
|
|
27
30
|
* <p>If successful, this operation creates a new Fleet resource and places it in
|
|
28
31
|
* <code>NEW</code> status, which prompts GameLift to initiate the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html">fleet creation
|
|
29
32
|
* workflow</a>. You can track fleet creation by checking fleet status using <a>DescribeFleetAttributes</a> and <a>DescribeFleetLocationAttributes</a>/, or by monitoring fleet creation events
|
|
@@ -12,7 +12,7 @@ export interface CreateFleetLocationsCommandOutput extends CreateFleetLocationsO
|
|
|
12
12
|
* other configuration settings. </p>
|
|
13
13
|
* <note>
|
|
14
14
|
* <p>This operation cannot be used with fleets that don't support remote locations. Fleets
|
|
15
|
-
* can have multiple locations only if they reside in
|
|
15
|
+
* can have multiple locations only if they reside in Amazon Web Services Regions that support this
|
|
16
16
|
* feature (see <a>CreateFleet</a> for the complete list) and were created
|
|
17
17
|
* after the feature was released in March 2021.</p>
|
|
18
18
|
* </note>
|
|
@@ -11,24 +11,24 @@ export interface CreateGameServerGroupCommandOutput extends CreateGameServerGrou
|
|
|
11
11
|
* <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
|
|
12
12
|
* </p>
|
|
13
13
|
* <p>Creates a GameLift FleetIQ game server group for managing game hosting on a collection of
|
|
14
|
-
* Amazon
|
|
15
|
-
* creates an Auto Scaling group in your
|
|
14
|
+
* Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group,
|
|
15
|
+
* creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the
|
|
16
16
|
* two groups. You can view the status of your game server groups in the GameLift console.
|
|
17
17
|
* Game server group metrics and events are emitted to Amazon CloudWatch.</p>
|
|
18
18
|
* <p>Before creating a new game server group, you must have the following: </p>
|
|
19
19
|
* <ul>
|
|
20
20
|
* <li>
|
|
21
|
-
* <p>An Amazon
|
|
21
|
+
* <p>An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances
|
|
22
22
|
* with your game server build. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html"> Launching an Instance from a Launch Template</a> in the
|
|
23
|
-
* <i>Amazon
|
|
23
|
+
* <i>Amazon Elastic Compute Cloud User Guide</i>. </p>
|
|
24
24
|
* </li>
|
|
25
25
|
* <li>
|
|
26
|
-
* <p>An IAM role that extends limited access to your
|
|
26
|
+
* <p>An IAM role that extends limited access to your Amazon Web Services account to allow GameLift FleetIQ to create and
|
|
27
27
|
* interact with the Auto Scaling group. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html">Create IAM roles for cross-service interaction</a> in the <i>GameLift FleetIQ Developer
|
|
28
28
|
* Guide</i>.</p>
|
|
29
29
|
* </li>
|
|
30
30
|
* </ul>
|
|
31
|
-
* <p>To create a new game server group, specify a unique group name, IAM role and Amazon
|
|
31
|
+
* <p>To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud
|
|
32
32
|
* launch template, and provide a list of instance types that can be used in the group. You
|
|
33
33
|
* must also set initial maximum and minimum limits on the group's instance count. You can
|
|
34
34
|
* optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ
|
|
@@ -38,7 +38,7 @@ export interface CreateGameSessionCommandOutput extends CreateGameSessionOutput,
|
|
|
38
38
|
* <p>Game session logs are retained for all active game sessions for 14 days. To access the
|
|
39
39
|
* logs, call <a>GetGameSessionLogUrl</a> to download the log files.</p>
|
|
40
40
|
* <p>
|
|
41
|
-
* <i>Available in
|
|
41
|
+
* <i>Available in Amazon Web Services Local.</i>
|
|
42
42
|
* </p>
|
|
43
43
|
* <p>
|
|
44
44
|
* <b>Learn more</b>
|
|
@@ -14,7 +14,7 @@ export interface CreateGameSessionQueueCommandOutput extends CreateGameSessionQu
|
|
|
14
14
|
* <p>A game session queue is configured with a set of destinations (GameLift fleets or
|
|
15
15
|
* aliases), which determine the locations where the queue can place new game sessions.
|
|
16
16
|
* These destinations can span multiple fleet types (Spot and On-Demand), instance types,
|
|
17
|
-
* and
|
|
17
|
+
* and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place
|
|
18
18
|
* game sessions in all of a fleet's remote locations. You can opt to filter out individual
|
|
19
19
|
* locations if needed.</p>
|
|
20
20
|
* <p>The queue configuration also determines how FleetIQ selects the best available placement
|
|
@@ -28,7 +28,10 @@ export interface CreateGameSessionQueueCommandOutput extends CreateGameSessionQu
|
|
|
28
28
|
* (SNS) topic to receive notifications of game session placement activity. Notifications
|
|
29
29
|
* using SNS or CloudWatch events is the preferred way to track placement activity.</p>
|
|
30
30
|
* <p>If successful, a new <code>GameSessionQueue</code> object is returned with an assigned
|
|
31
|
-
* queue ARN. New game session requests, which are submitted to
|
|
31
|
+
* queue ARN. New game session requests, which are submitted to queue with
|
|
32
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a>
|
|
33
|
+
* or
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html">StartMatchmaking</a>,
|
|
32
35
|
* reference a queue's name or ARN. </p>
|
|
33
36
|
* <p>
|
|
34
37
|
* <b>Learn more</b>
|
|
@@ -45,10 +48,14 @@ export interface CreateGameSessionQueueCommandOutput extends CreateGameSessionQu
|
|
|
45
48
|
* <b>Related actions</b>
|
|
46
49
|
* </p>
|
|
47
50
|
* <p>
|
|
48
|
-
* <a>CreateGameSessionQueue</a>
|
|
49
|
-
*
|
|
50
|
-
* <a>
|
|
51
|
-
*
|
|
51
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html">CreateGameSessionQueue</a>
|
|
52
|
+
* |
|
|
53
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html">DescribeGameSessionQueues</a>
|
|
54
|
+
* |
|
|
55
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html">UpdateGameSessionQueue</a>
|
|
56
|
+
* |
|
|
57
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html">DeleteGameSessionQueue</a>
|
|
58
|
+
* |
|
|
52
59
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
53
60
|
* </p>
|
|
54
61
|
* @example
|
|
@@ -20,7 +20,7 @@ export interface CreateMatchmakingConfigurationCommandOutput extends CreateMatch
|
|
|
20
20
|
* and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift
|
|
21
21
|
* hosting, you also need to identify the game session queue to use when starting a game
|
|
22
22
|
* session for the match.</p>
|
|
23
|
-
* <p>In addition, you must set up an Amazon Simple Notification Service
|
|
23
|
+
* <p>In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications.
|
|
24
24
|
* Provide the topic ARN in the matchmaking configuration. An alternative method,
|
|
25
25
|
* continuously polling ticket status with <a>DescribeMatchmaking</a>, is only
|
|
26
26
|
* suitable for games in development with low matchmaking usage.</p>
|
|
@@ -17,8 +17,10 @@ export interface CreatePlayerSessionCommandOutput extends CreatePlayerSessionOut
|
|
|
17
17
|
* references the player session ID when sending a connection request to the game session,
|
|
18
18
|
* and the game server can use it to validate the player reservation with the GameLift service. Player
|
|
19
19
|
* sessions cannot be updated. </p>
|
|
20
|
+
* <p>The maximum number of players per game session is 200. It is not adjustable.
|
|
21
|
+
* </p>
|
|
20
22
|
* <p>
|
|
21
|
-
* <i>Available in Amazon
|
|
23
|
+
* <i>Available in Amazon Web Services Local.</i>
|
|
22
24
|
* </p>
|
|
23
25
|
* <p>
|
|
24
26
|
* <b>Related actions</b>
|
|
@@ -17,8 +17,10 @@ export interface CreatePlayerSessionsCommandOutput extends CreatePlayerSessionsO
|
|
|
17
17
|
* references their player session ID when sending a connection request to the game
|
|
18
18
|
* session, and the game server can use it to validate the player reservation with the
|
|
19
19
|
* GameLift service. Player sessions cannot be updated.</p>
|
|
20
|
+
* <p>The maximum number of players per game session is 200. It is not adjustable.
|
|
21
|
+
* </p>
|
|
20
22
|
* <p>
|
|
21
|
-
* <i>Available in Amazon
|
|
23
|
+
* <i>Available in Amazon Web Services Local.</i>
|
|
22
24
|
* </p>
|
|
23
25
|
* <p>
|
|
24
26
|
* <b>Related actions</b>
|
|
@@ -20,25 +20,25 @@ export interface CreateScriptCommandOutput extends CreateScriptOutput, __Metadat
|
|
|
20
20
|
* option.</p>
|
|
21
21
|
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
* <p>An Amazon Simple Storage Service (Amazon S3) bucket under your
|
|
23
|
+
* <p>An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the
|
|
24
24
|
* <i>StorageLocation</i> parameter for this option. You'll need
|
|
25
|
-
* to have an Identity Access Management (IAM) role that allows the Amazon
|
|
25
|
+
* to have an Identity Access Management (IAM) role that allows the Amazon Web Services
|
|
26
26
|
* service to access your S3 bucket. </p>
|
|
27
27
|
* </li>
|
|
28
28
|
* </ul>
|
|
29
29
|
* <p>If the call is successful, a new script record is created with a unique script ID. If the
|
|
30
|
-
* script file is provided as a local file, the file is uploaded to an Amazon
|
|
30
|
+
* script file is provided as a local file, the file is uploaded to an Amazon Web Services-owned S3 bucket
|
|
31
31
|
* and the script record's storage location reflects this location. If the script file is provided
|
|
32
|
-
* as an S3 bucket, Amazon
|
|
32
|
+
* as an S3 bucket, Amazon Web Services accesses the file at this storage location as needed for deployment.</p>
|
|
33
33
|
* <p>
|
|
34
34
|
* <b>Learn more</b>
|
|
35
35
|
* </p>
|
|
36
36
|
*
|
|
37
37
|
* <p>
|
|
38
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon
|
|
38
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon Web Services Realtime Servers</a>
|
|
39
39
|
* </p>
|
|
40
40
|
* <p>
|
|
41
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html">Set Up a Role for Amazon
|
|
41
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html">Set Up a Role for Amazon Web Services Access</a>
|
|
42
42
|
* </p>
|
|
43
43
|
* <p>
|
|
44
44
|
* <b>Related actions</b>
|
|
@@ -8,24 +8,24 @@ export interface CreateVpcPeeringAuthorizationCommandOutput extends CreateVpcPee
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Requests authorization to create or delete a peer connection between the VPC for
|
|
11
|
-
* your Amazon
|
|
12
|
-
* servers on your fleet to communicate directly with other
|
|
11
|
+
* your Amazon Web Services fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game
|
|
12
|
+
* servers on your fleet to communicate directly with other Amazon Web Services resources. Once you've
|
|
13
13
|
* received authorization, call <a>CreateVpcPeeringConnection</a> to establish
|
|
14
|
-
* the peering connection. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon
|
|
14
|
+
* the peering connection. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon Web Services
|
|
15
15
|
* Fleets</a>.</p>
|
|
16
|
-
* <p>You can peer with VPCs that are owned by any
|
|
17
|
-
* including the account that you use to manage your Amazon
|
|
16
|
+
* <p>You can peer with VPCs that are owned by any Amazon Web Services account you have access to,
|
|
17
|
+
* including the account that you use to manage your Amazon Web Services fleets. You cannot peer with
|
|
18
18
|
* VPCs that are in different Regions.</p>
|
|
19
|
-
* <p>To request authorization to create a connection, call this operation from the
|
|
20
|
-
* account with the VPC that you want to peer to your Amazon
|
|
19
|
+
* <p>To request authorization to create a connection, call this operation from the Amazon Web Services
|
|
20
|
+
* account with the VPC that you want to peer to your Amazon Web Services fleet. For example, to
|
|
21
21
|
* enable your game servers to retrieve data from a DynamoDB table, use the account that
|
|
22
22
|
* manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC
|
|
23
|
-
* that you want to peer with, and (2) the ID of the
|
|
24
|
-
* Amazon
|
|
25
|
-
* <p>To request authorization to delete a connection, call this operation from the
|
|
26
|
-
* account with the VPC that is peered with your Amazon
|
|
23
|
+
* that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage
|
|
24
|
+
* Amazon Web Services. If successful, VPC peering is authorized for the specified VPC. </p>
|
|
25
|
+
* <p>To request authorization to delete a connection, call this operation from the Amazon Web Services
|
|
26
|
+
* account with the VPC that is peered with your Amazon Web Services fleet. Identify the following
|
|
27
27
|
* values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the
|
|
28
|
-
*
|
|
28
|
+
* Amazon Web Services account that you use to manage Amazon Web Services. </p>
|
|
29
29
|
* <p>The authorization remains valid for 24 hours unless it is canceled by a call to
|
|
30
30
|
* <a>DeleteVpcPeeringAuthorization</a>. You must create or delete the
|
|
31
31
|
* peering connection while the authorization is valid. </p>
|
|
@@ -7,20 +7,20 @@ export interface CreateVpcPeeringConnectionCommandInput extends CreateVpcPeering
|
|
|
7
7
|
export interface CreateVpcPeeringConnectionCommandOutput extends CreateVpcPeeringConnectionOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an
|
|
11
|
-
* for your Amazon
|
|
12
|
-
* communicate directly with other
|
|
13
|
-
* that you have access to, including the account that you use to manage your Amazon
|
|
10
|
+
* <p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC
|
|
11
|
+
* for your Amazon Web Services fleet. VPC peering enables the game servers on your fleet to
|
|
12
|
+
* communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account
|
|
13
|
+
* that you have access to, including the account that you use to manage your Amazon Web Services
|
|
14
14
|
* fleets. You cannot peer with VPCs that are in different Regions. For more information,
|
|
15
|
-
* see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon
|
|
15
|
+
* see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon Web Services Fleets</a>.</p>
|
|
16
16
|
* <p>Before calling this operation to establish the peering connection, you first need
|
|
17
17
|
* to call <a>CreateVpcPeeringAuthorization</a> and identify the VPC you want to
|
|
18
18
|
* peer with. Once the authorization for the specified VPC is issued, you have 24 hours to
|
|
19
19
|
* establish the connection. These two operations handle all tasks necessary to peer the
|
|
20
20
|
* two VPCs, including acceptance, updating routing tables, etc. </p>
|
|
21
|
-
* <p>To establish the connection, call this operation from the
|
|
22
|
-
* to manage the Amazon
|
|
23
|
-
* you want to be enable a VPC peering connection for; (2) The
|
|
21
|
+
* <p>To establish the connection, call this operation from the Amazon Web Services account that is used
|
|
22
|
+
* to manage the Amazon Web Services fleets. Identify the following values: (1) The ID of the fleet
|
|
23
|
+
* you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC
|
|
24
24
|
* that you want to peer with; and (3) The ID of the VPC you want to peer with. This
|
|
25
25
|
* operation is asynchronous. If successful, a <a>VpcPeeringConnection</a>
|
|
26
26
|
* request is created. You can use continuous polling to track the request's status using
|
|
@@ -7,7 +7,8 @@ export interface DeleteGameSessionQueueCommandInput extends DeleteGameSessionQue
|
|
|
7
7
|
export interface DeleteGameSessionQueueCommandOutput extends DeleteGameSessionQueueOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a game session queue. Once a queue is successfully deleted, unfulfilled
|
|
10
|
+
* <p>Deletes a game session queue. Once a queue is successfully deleted, unfulfilled
|
|
11
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> requests that reference the queue will fail.
|
|
11
12
|
* To delete a queue, specify the queue name.</p>
|
|
12
13
|
* <p>
|
|
13
14
|
* <b>Learn more</b>
|
|
@@ -20,10 +21,14 @@ export interface DeleteGameSessionQueueCommandOutput extends DeleteGameSessionQu
|
|
|
20
21
|
* <b>Related actions</b>
|
|
21
22
|
* </p>
|
|
22
23
|
* <p>
|
|
23
|
-
* <a>CreateGameSessionQueue</a>
|
|
24
|
-
*
|
|
25
|
-
* <a>
|
|
26
|
-
*
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html">CreateGameSessionQueue</a>
|
|
25
|
+
* |
|
|
26
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html">DescribeGameSessionQueues</a>
|
|
27
|
+
* |
|
|
28
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html">UpdateGameSessionQueue</a>
|
|
29
|
+
* |
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html">DeleteGameSessionQueue</a>
|
|
31
|
+
* |
|
|
27
32
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
28
33
|
* </p>
|
|
29
34
|
* @example
|
|
@@ -18,7 +18,7 @@ export interface DeleteScriptCommandOutput extends __MetadataBearer {
|
|
|
18
18
|
* <b>Learn more</b>
|
|
19
19
|
* </p>
|
|
20
20
|
* <p>
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon
|
|
21
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon Web Services Realtime Servers</a>
|
|
22
22
|
* </p>
|
|
23
23
|
* <p>
|
|
24
24
|
* <b>Related actions</b>
|
|
@@ -11,8 +11,8 @@ export interface DeleteVpcPeeringConnectionCommandOutput extends DeleteVpcPeerin
|
|
|
11
11
|
* authorization for the VPC peering connection that you want to delete. You can check for
|
|
12
12
|
* an authorization by calling <a>DescribeVpcPeeringAuthorizations</a> or
|
|
13
13
|
* request a new one using <a>CreateVpcPeeringAuthorization</a>. </p>
|
|
14
|
-
* <p>Once a valid authorization exists, call this operation from the
|
|
15
|
-
* used to manage the Amazon
|
|
14
|
+
* <p>Once a valid authorization exists, call this operation from the Amazon Web Services account that is
|
|
15
|
+
* used to manage the Amazon Web Services fleets. Identify the connection to delete by the connection
|
|
16
16
|
* ID and fleet ID. If successful, the connection is removed. </p>
|
|
17
17
|
* <p>
|
|
18
18
|
* <b>Related actions</b>
|
|
@@ -7,15 +7,15 @@ export interface DescribeEC2InstanceLimitsCommandInput extends DescribeEC2Instan
|
|
|
7
7
|
export interface DescribeEC2InstanceLimitsCommandOutput extends DescribeEC2InstanceLimitsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>The GameLift service limits and current utilization for an
|
|
10
|
+
* <p>The GameLift service limits and current utilization for an Amazon Web Services Region or location.
|
|
11
11
|
* Instance limits control the number of instances, per instance type, per location, that
|
|
12
|
-
* your
|
|
12
|
+
* your Amazon Web Services account can use. Learn more at <a href="http://aws.amazon.com/ec2/instance-types/">Amazon EC2 Instance Types</a>. The information
|
|
13
13
|
* returned includes the maximum number of instances allowed and your account's current
|
|
14
14
|
* usage across all fleets. This information can affect your ability to scale your GameLift
|
|
15
15
|
* fleets. You can request a limit increase for your account by using the <b>Service limits</b> page in the GameLift console.</p>
|
|
16
16
|
* <p>Instance limits differ based on whether the instances are deployed in a fleet's home
|
|
17
17
|
* Region or in a remote location. For remote locations, limits also differ based on the
|
|
18
|
-
* combination of home Region and remote location. All requests must specify an
|
|
18
|
+
* combination of home Region and remote location. All requests must specify an Amazon Web Services Region
|
|
19
19
|
* (either explicitly or as your default settings). To get the limit for a remote location,
|
|
20
20
|
* you must also specify the location. For example, the following requests all return
|
|
21
21
|
* different results: </p>
|
|
@@ -43,14 +43,14 @@ export interface DescribeEC2InstanceLimitsCommandOutput extends DescribeEC2Insta
|
|
|
43
43
|
* <p>This operation can be used in the following ways:</p>
|
|
44
44
|
* <ul>
|
|
45
45
|
* <li>
|
|
46
|
-
* <p>To get limit and usage data for all instance types that are deployed in an
|
|
46
|
+
* <p>To get limit and usage data for all instance types that are deployed in an Amazon Web Services
|
|
47
47
|
* Region by fleets that reside in the same Region: Specify the Region only.
|
|
48
48
|
* Optionally, specify a single instance type to retrieve information for.</p>
|
|
49
49
|
* </li>
|
|
50
50
|
* <li>
|
|
51
51
|
* <p>To get limit and usage data for all instance types that are deployed to a
|
|
52
|
-
* remote location by fleets that reside in different
|
|
53
|
-
*
|
|
52
|
+
* remote location by fleets that reside in different Amazon Web Services Region: Provide both the
|
|
53
|
+
* Amazon Web Services Region and the remote location. Optionally, specify a single instance type
|
|
54
54
|
* to retrieve information for.</p>
|
|
55
55
|
* </li>
|
|
56
56
|
* </ul>
|
|
@@ -28,7 +28,7 @@ export interface DescribeGameSessionDetailsCommandOutput extends DescribeGameSes
|
|
|
28
28
|
* </li>
|
|
29
29
|
* <li>
|
|
30
30
|
* <p>To retrieve details for a specific game session, provide the game session ID.
|
|
31
|
-
* This approach looks for the game session ID in all fleets that reside in the
|
|
31
|
+
* This approach looks for the game session ID in all fleets that reside in the Amazon Web Services
|
|
32
32
|
* Region defined in the request.</p>
|
|
33
33
|
* </li>
|
|
34
34
|
* </ul>
|
|
@@ -8,8 +8,16 @@ export interface DescribeGameSessionPlacementCommandOutput extends DescribeGameS
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves information, including current status, about a game session placement request. </p>
|
|
11
|
-
*
|
|
12
|
-
*
|
|
11
|
+
* <p>To get game session placement details, specify the placement ID.</p>
|
|
12
|
+
* <p>This operation is not designed to be continually called to track game session status.
|
|
13
|
+
* This practice can cause you to exceed your API limit, which results in errors. Instead,
|
|
14
|
+
* you must configure configure an
|
|
15
|
+
* Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling
|
|
16
|
+
* with <code>DescribeGameSessionPlacement</code> should only be used for games in development with
|
|
17
|
+
* low game session usage.
|
|
18
|
+
* </p>
|
|
19
|
+
*
|
|
20
|
+
* <p>If successful, a <a>GameSessionPlacement</a> object is returned.</p>
|
|
13
21
|
* <p>
|
|
14
22
|
* <b>Related actions</b>
|
|
15
23
|
* </p>
|
|
@@ -23,10 +23,14 @@ export interface DescribeGameSessionQueuesCommandOutput extends DescribeGameSess
|
|
|
23
23
|
* <b>Related actions</b>
|
|
24
24
|
* </p>
|
|
25
25
|
* <p>
|
|
26
|
-
* <a>CreateGameSessionQueue</a>
|
|
27
|
-
*
|
|
28
|
-
* <a>
|
|
29
|
-
*
|
|
26
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html">CreateGameSessionQueue</a>
|
|
27
|
+
* |
|
|
28
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html">DescribeGameSessionQueues</a>
|
|
29
|
+
* |
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html">UpdateGameSessionQueue</a>
|
|
31
|
+
* |
|
|
32
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html">DeleteGameSessionQueue</a>
|
|
33
|
+
* |
|
|
30
34
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
31
35
|
* </p>
|
|
32
36
|
* @example
|
|
@@ -11,6 +11,14 @@ export interface DescribeGameSessionsCommandOutput extends DescribeGameSessionsO
|
|
|
11
11
|
* optionally filter the results by current game session status. Alternatively, use <a>SearchGameSessions</a> to request a set of active game sessions that are
|
|
12
12
|
* filtered by certain criteria. To retrieve the protection policy for game sessions, use
|
|
13
13
|
* <a>DescribeGameSessionDetails</a>.</p>
|
|
14
|
+
* <p>This operation is not designed to be continually called to track game session status.
|
|
15
|
+
* This practice can cause you to exceed your API limit, which results in errors. Instead,
|
|
16
|
+
* you must configure configure an
|
|
17
|
+
* Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling
|
|
18
|
+
* with <code>DescribeGameSessions</code> should only be used for games in development with
|
|
19
|
+
* low game session usage.
|
|
20
|
+
* </p>
|
|
21
|
+
*
|
|
14
22
|
* <p>This operation can be used in the following ways: </p>
|
|
15
23
|
* <ul>
|
|
16
24
|
* <li>
|
|
@@ -27,15 +35,21 @@ export interface DescribeGameSessionsCommandOutput extends DescribeGameSessionsO
|
|
|
27
35
|
* </li>
|
|
28
36
|
* <li>
|
|
29
37
|
* <p>To retrieve a specific game session, provide the game session ID. This
|
|
30
|
-
* approach looks for the game session ID in all fleets that reside in the
|
|
38
|
+
* approach looks for the game session ID in all fleets that reside in the Amazon Web Services
|
|
31
39
|
* Region defined in the request.</p>
|
|
32
40
|
* </li>
|
|
33
41
|
* </ul>
|
|
34
42
|
* <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
|
|
35
43
|
* <p>If successful, a <code>GameSession</code> object is returned for each game session
|
|
36
44
|
* that matches the request.</p>
|
|
45
|
+
* <p>This operation is not designed to be continually called to track matchmaking ticket
|
|
46
|
+
* status. This practice can cause you to exceed your API limit, which results in errors.
|
|
47
|
+
* Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide
|
|
48
|
+
* the topic ARN in the matchmaking configuration. Continuously poling ticket status with
|
|
49
|
+
* <a>DescribeGameSessions</a> should only be used for games in development
|
|
50
|
+
* with low matchmaking usage.</p>
|
|
37
51
|
* <p>
|
|
38
|
-
* <i>Available in
|
|
52
|
+
* <i>Available in Amazon Web Services Local.</i>
|
|
39
53
|
* </p>
|
|
40
54
|
* <p>
|
|
41
55
|
* <b>Learn more</b>
|
|
@@ -15,7 +15,7 @@ export interface DescribeMatchmakingCommandOutput extends DescribeMatchmakingOut
|
|
|
15
15
|
* exists.</p>
|
|
16
16
|
* <p>This operation is not designed to be continually called to track matchmaking ticket
|
|
17
17
|
* status. This practice can cause you to exceed your API limit, which results in errors.
|
|
18
|
-
* Instead, as a best practice, set up an Amazon Simple Notification Service
|
|
18
|
+
* Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide
|
|
19
19
|
* the topic ARN in the matchmaking configuration. Continuously poling ticket status with
|
|
20
20
|
* <a>DescribeMatchmaking</a> should only be used for games in development
|
|
21
21
|
* with low matchmaking usage.</p>
|
|
@@ -29,7 +29,7 @@ export interface DescribePlayerSessionsCommandOutput extends DescribePlayerSessi
|
|
|
29
29
|
* <p>If successful, a <code>PlayerSession</code> object is returned for each session that
|
|
30
30
|
* matches the request.</p>
|
|
31
31
|
* <p>
|
|
32
|
-
* <i>Available in Amazon
|
|
32
|
+
* <i>Available in Amazon Web Services Local.</i>
|
|
33
33
|
* </p>
|
|
34
34
|
* <p>
|
|
35
35
|
* <b>Related actions</b>
|
|
@@ -14,7 +14,7 @@ export interface DescribeScriptCommandOutput extends DescribeScriptOutput, __Met
|
|
|
14
14
|
* <b>Learn more</b>
|
|
15
15
|
* </p>
|
|
16
16
|
* <p>
|
|
17
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon
|
|
17
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon Web Services Realtime Servers</a>
|
|
18
18
|
* </p>
|
|
19
19
|
* <p>
|
|
20
20
|
* <b>Related actions</b>
|
|
@@ -7,7 +7,7 @@ export interface DescribeVpcPeeringAuthorizationsCommandInput extends DescribeVp
|
|
|
7
7
|
export interface DescribeVpcPeeringAuthorizationsCommandOutput extends DescribeVpcPeeringAuthorizationsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves valid VPC peering authorizations that are pending for the
|
|
10
|
+
* <p>Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.
|
|
11
11
|
* This operation returns all VPC peering authorizations and requests for peering. This
|
|
12
12
|
* includes those initiated and received by this account. </p>
|
|
13
13
|
* <p>
|
|
@@ -9,8 +9,8 @@ export interface DescribeVpcPeeringConnectionsCommandOutput extends DescribeVpcP
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves information on VPC peering connections. Use this operation to get peering
|
|
11
11
|
* information for all fleets or for one specific fleet ID. </p>
|
|
12
|
-
* <p>To retrieve connection information, call this operation from the
|
|
13
|
-
* is used to manage the Amazon
|
|
12
|
+
* <p>To retrieve connection information, call this operation from the Amazon Web Services account that
|
|
13
|
+
* is used to manage the Amazon Web Services fleets. Specify a fleet ID or leave the parameter empty
|
|
14
14
|
* to retrieve all connection records. If successful, the retrieved information includes
|
|
15
15
|
* both active and pending connections. Active connections identify the IpV4 CIDR block
|
|
16
16
|
* that the VPC uses to connect. </p>
|
|
@@ -11,7 +11,7 @@ export interface GetGameSessionLogUrlCommandOutput extends GetGameSessionLogUrlO
|
|
|
11
11
|
* When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and
|
|
12
12
|
* retains them for 14 days. Use this URL to download the logs.</p>
|
|
13
13
|
* <note>
|
|
14
|
-
* <p>See the <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift">
|
|
14
|
+
* <p>See the <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift">Amazon Web Services Service
|
|
15
15
|
* Limits</a> page for maximum log file sizes. Log files that exceed this limit
|
|
16
16
|
* are not saved.</p>
|
|
17
17
|
* </note>
|
|
@@ -14,7 +14,7 @@ export interface GetInstanceAccessCommandOutput extends GetInstanceAccessOutput,
|
|
|
14
14
|
* strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift
|
|
15
15
|
* returns a user name and RSA private key, also as strings, for use with an SSH client.
|
|
16
16
|
* The private key must be saved in the proper format to a <code>.pem</code> file before
|
|
17
|
-
* using. If you're making this request using the
|
|
17
|
+
* using. If you're making this request using the CLI, saving the secret can be handled
|
|
18
18
|
* as part of the <code>GetInstanceAccess</code> request, as shown in one of the examples
|
|
19
19
|
* for this operation. </p>
|
|
20
20
|
* <p>To request access to a specific instance, specify the IDs of both the instance and the
|
|
@@ -7,7 +7,7 @@ export interface ListAliasesCommandInput extends ListAliasesInput {
|
|
|
7
7
|
export interface ListAliasesCommandOutput extends ListAliasesOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves all aliases for this
|
|
10
|
+
* <p>Retrieves all aliases for this Amazon Web Services account. You can filter the result set by
|
|
11
11
|
* alias name and/or routing strategy type. Use the pagination parameters to retrieve
|
|
12
12
|
* results in sequential pages.</p>
|
|
13
13
|
* <note>
|