Skip to content

Commit 0660dd0

Browse files
author
awstools
committed
docs(client-gamelift): Documentation updates for Amazon GameLift.
1 parent 7b173c3 commit 0660dd0

23 files changed

+186
-189
lines changed

clients/client-gamelift/src/GameLift.ts

Lines changed: 47 additions & 47 deletions
Large diffs are not rendered by default.

clients/client-gamelift/src/commands/AcceptMatchCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ export interface AcceptMatchCommandOutput extends AcceptMatchOutput, __MetadataB
3636
* <code>PLACING</code>, where a new game session is created for the match. </p>
3737
* <p>If any player rejects the match, or if acceptances are not received before a specified
3838
* timeout, the proposed match is dropped. The matchmaking tickets are then handled in one
39-
* of two ways: For tickets where one or more players rejected the match, the ticket status
40-
* is returned to <code>SEARCHING</code> to find a new match. For tickets where one or more
41-
* players failed to respond, the ticket status is set to <code>CANCELLED</code>, and
42-
* processing is terminated. A new matchmaking request for these players can be submitted
43-
* as needed. </p>
39+
* of two ways: For tickets where one or more players rejected the match or failed to
40+
* respond, the ticket status is set to <code>CANCELLED</code>, and processing is
41+
* terminated. For tickets where players have accepted or not yet responded, the ticket
42+
* status is returned to <code>SEARCHING</code> to find a new match. A new matchmaking
43+
* request for these players can be submitted as needed. </p>
4444
* <p>
4545
* <b>Learn more</b>
4646
* </p>

clients/client-gamelift/src/commands/CreateAliasCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface CreateAliasCommandOutput extends CreateAliasOutput, __MetadataB
2626
* a fleet ID. An alias provides a level of abstraction for a fleet that is useful when
2727
* redirecting player traffic from one fleet to another, such as when updating your game
2828
* build. </p>
29-
* <p>Amazon Web Services supports two types of routing strategies for aliases: simple and terminal. A
29+
* <p>Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A
3030
* simple alias points to an active fleet. A terminal alias is used to display messaging or
3131
* link to a URL instead of routing players to an active fleet. For example, you might use
3232
* a terminal alias when a game version is no longer supported and you want to direct

clients/client-gamelift/src/commands/CreateBuildCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ export interface CreateBuildCommandInput extends CreateBuildInput {}
2222
export interface CreateBuildCommandOutput extends CreateBuildOutput, __MetadataBearer {}
2323

2424
/**
25-
* <p>Creates a new Amazon Web Services build resource for your game server binary files. Game server
26-
* binaries must be combined into a zip file for use with Amazon Web Services. </p>
25+
* <p>Creates a new Amazon GameLift build resource for your game server binary files. Game server
26+
* binaries must be combined into a zip file for use with Amazon GameLift. </p>
2727
* <important>
2828
* <p>When setting up a new game build for GameLift, we recommend using the Amazon Web Services CLI
2929
* command <b>
@@ -36,7 +36,7 @@ export interface CreateBuildCommandOutput extends CreateBuildOutput, __MetadataB
3636
* <ul>
3737
* <li>
3838
* <p>To create a new game build with build files that are in an Amazon S3 location under
39-
* an Amazon Web Services account that you control. To use this option, you must first give Amazon Web Services
39+
* an Amazon Web Services account that you control. To use this option, you must first give Amazon GameLift
4040
* access to the Amazon S3 bucket. With permissions in place, call
4141
* <code>CreateBuild</code> and specify a build name, operating system, and the
4242
* Amazon S3 storage location of your game build.</p>

clients/client-gamelift/src/commands/CreateGameSessionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export interface CreateGameSessionCommandOutput extends CreateGameSessionOutput,
5353
* <p>Game session logs are retained for all active game sessions for 14 days. To access the
5454
* logs, call <a>GetGameSessionLogUrl</a> to download the log files.</p>
5555
* <p>
56-
* <i>Available in Amazon Web Services Local.</i>
56+
* <i>Available in Amazon GameLift Local.</i>
5757
* </p>
5858
* <p>
5959
* <b>Learn more</b>

clients/client-gamelift/src/commands/CreatePlayerSessionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface CreatePlayerSessionCommandOutput extends CreatePlayerSessionOut
3535
* <p>The maximum number of players per game session is 200. It is not adjustable.
3636
* </p>
3737
* <p>
38-
* <i>Available in Amazon Web Services Local.</i>
38+
* <i>Available in Amazon GameLift Local.</i>
3939
* </p>
4040
* <p>
4141
* <b>Related actions</b>

clients/client-gamelift/src/commands/CreatePlayerSessionsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface CreatePlayerSessionsCommandOutput extends CreatePlayerSessionsO
3535
* <p>The maximum number of players per game session is 200. It is not adjustable.
3636
* </p>
3737
* <p>
38-
* <i>Available in Amazon Web Services Local.</i>
38+
* <i>Available in Amazon GameLift Local.</i>
3939
* </p>
4040
* <p>
4141
* <b>Related actions</b>

clients/client-gamelift/src/commands/CreateScriptCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,23 @@ export interface CreateScriptCommandOutput extends CreateScriptOutput, __Metadat
3737
* <li>
3838
* <p>An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the
3939
* <i>StorageLocation</i> parameter for this option. You'll need
40-
* to have an Identity Access Management (IAM) role that allows the Amazon Web Services
40+
* to have an Identity Access Management (IAM) role that allows the Amazon GameLift
4141
* service to access your S3 bucket. </p>
4242
* </li>
4343
* </ul>
4444
* <p>If the call is successful, a new script record is created with a unique script ID. If the
45-
* script file is provided as a local file, the file is uploaded to an Amazon Web Services-owned S3 bucket
45+
* script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket
4646
* and the script record's storage location reflects this location. If the script file is provided
47-
* as an S3 bucket, Amazon Web Services accesses the file at this storage location as needed for deployment.</p>
47+
* as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.</p>
4848
* <p>
4949
* <b>Learn more</b>
5050
* </p>
5151
*
5252
* <p>
53-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon Web Services Realtime Servers</a>
53+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
5454
* </p>
5555
* <p>
56-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html">Set Up a Role for Amazon Web Services Access</a>
56+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html">Set Up a Role for Amazon GameLift Access</a>
5757
* </p>
5858
* <p>
5959
* <b>Related actions</b>

clients/client-gamelift/src/commands/CreateVpcPeeringAuthorizationCommand.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,24 @@ export interface CreateVpcPeeringAuthorizationCommandOutput
2525

2626
/**
2727
* <p>Requests authorization to create or delete a peer connection between the VPC for
28-
* your Amazon Web Services fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game
28+
* your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game
2929
* servers on your fleet to communicate directly with other Amazon Web Services resources. Once you've
3030
* received authorization, call <a>CreateVpcPeeringConnection</a> to establish
31-
* 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
31+
* the peering connection. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift
3232
* Fleets</a>.</p>
3333
* <p>You can peer with VPCs that are owned by any Amazon Web Services account you have access to,
34-
* including the account that you use to manage your Amazon Web Services fleets. You cannot peer with
34+
* including the account that you use to manage your Amazon GameLift fleets. You cannot peer with
3535
* VPCs that are in different Regions.</p>
3636
* <p>To request authorization to create a connection, call this operation from the Amazon Web Services
37-
* account with the VPC that you want to peer to your Amazon Web Services fleet. For example, to
37+
* account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to
3838
* enable your game servers to retrieve data from a DynamoDB table, use the account that
3939
* manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC
4040
* that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage
41-
* Amazon Web Services. If successful, VPC peering is authorized for the specified VPC. </p>
41+
* Amazon GameLift. If successful, VPC peering is authorized for the specified VPC. </p>
4242
* <p>To request authorization to delete a connection, call this operation from the Amazon Web Services
43-
* account with the VPC that is peered with your Amazon Web Services fleet. Identify the following
43+
* account with the VPC that is peered with your Amazon GameLift fleet. Identify the following
4444
* values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the
45-
* Amazon Web Services account that you use to manage Amazon Web Services. </p>
45+
* Amazon Web Services account that you use to manage Amazon GameLift. </p>
4646
* <p>The authorization remains valid for 24 hours unless it is canceled by a call to
4747
* <a>DeleteVpcPeeringAuthorization</a>. You must create or delete the
4848
* peering connection while the authorization is valid. </p>

clients/client-gamelift/src/commands/CreateVpcPeeringConnectionCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ export interface CreateVpcPeeringConnectionCommandOutput extends CreateVpcPeerin
2323

2424
/**
2525
* <p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC
26-
* for your Amazon Web Services fleet. VPC peering enables the game servers on your fleet to
26+
* for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to
2727
* communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account
28-
* that you have access to, including the account that you use to manage your Amazon Web Services
28+
* that you have access to, including the account that you use to manage your Amazon GameLift
2929
* fleets. You cannot peer with VPCs that are in different Regions. For more information,
30-
* see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon Web Services Fleets</a>.</p>
30+
* see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</p>
3131
* <p>Before calling this operation to establish the peering connection, you first need
3232
* to call <a>CreateVpcPeeringAuthorization</a> and identify the VPC you want to
3333
* peer with. Once the authorization for the specified VPC is issued, you have 24 hours to
3434
* establish the connection. These two operations handle all tasks necessary to peer the
3535
* two VPCs, including acceptance, updating routing tables, etc. </p>
3636
* <p>To establish the connection, call this operation from the Amazon Web Services account that is used
37-
* to manage the Amazon Web Services fleets. Identify the following values: (1) The ID of the fleet
37+
* to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet
3838
* you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC
3939
* that you want to peer with; and (3) The ID of the VPC you want to peer with. This
4040
* operation is asynchronous. If successful, a <a>VpcPeeringConnection</a>

clients/client-gamelift/src/commands/DeleteScriptCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DeleteScriptCommandOutput extends __MetadataBearer {}
3333
* <b>Learn more</b>
3434
* </p>
3535
* <p>
36-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon Web Services Realtime Servers</a>
36+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
3737
* </p>
3838
* <p>
3939
* <b>Related actions</b>

clients/client-gamelift/src/commands/DeleteVpcPeeringConnectionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface DeleteVpcPeeringConnectionCommandOutput extends DeleteVpcPeerin
2727
* an authorization by calling <a>DescribeVpcPeeringAuthorizations</a> or
2828
* request a new one using <a>CreateVpcPeeringAuthorization</a>. </p>
2929
* <p>Once a valid authorization exists, call this operation from the Amazon Web Services account that is
30-
* used to manage the Amazon Web Services fleets. Identify the connection to delete by the connection
30+
* used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection
3131
* ID and fleet ID. If successful, the connection is removed. </p>
3232
* <p>
3333
* <b>Related actions</b>

clients/client-gamelift/src/commands/DescribeGameSessionsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export interface DescribeGameSessionsCommandOutput extends DescribeGameSessionsO
6464
* <a>DescribeGameSessions</a> should only be used for games in development
6565
* with low matchmaking usage.</p>
6666
* <p>
67-
* <i>Available in Amazon Web Services Local.</i>
67+
* <i>Available in Amazon GameLift Local.</i>
6868
* </p>
6969
* <p>
7070
* <b>Learn more</b>

clients/client-gamelift/src/commands/DescribePlayerSessionsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface DescribePlayerSessionsCommandOutput extends DescribePlayerSessi
4444
* <p>If successful, a <code>PlayerSession</code> object is returned for each session that
4545
* matches the request.</p>
4646
* <p>
47-
* <i>Available in Amazon Web Services Local.</i>
47+
* <i>Available in Amazon GameLift Local.</i>
4848
* </p>
4949
* <p>
5050
* <b>Related actions</b>

clients/client-gamelift/src/commands/DescribeScriptCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface DescribeScriptCommandOutput extends DescribeScriptOutput, __Met
2929
* <b>Learn more</b>
3030
* </p>
3131
* <p>
32-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon Web Services Realtime Servers</a>
32+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
3333
* </p>
3434
* <p>
3535
* <b>Related actions</b>

clients/client-gamelift/src/commands/DescribeVpcPeeringConnectionsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface DescribeVpcPeeringConnectionsCommandOutput
2727
* <p>Retrieves information on VPC peering connections. Use this operation to get peering
2828
* information for all fleets or for one specific fleet ID. </p>
2929
* <p>To retrieve connection information, call this operation from the Amazon Web Services account that
30-
* is used to manage the Amazon Web Services fleets. Specify a fleet ID or leave the parameter empty
30+
* is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty
3131
* to retrieve all connection records. If successful, the retrieved information includes
3232
* both active and pending connections. Active connections identify the IpV4 CIDR block
3333
* that the VPC uses to connect. </p>

clients/client-gamelift/src/commands/ListScriptsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface ListScriptsCommandOutput extends ListScriptsOutput, __MetadataB
2727
* <b>Learn more</b>
2828
* </p>
2929
* <p>
30-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon Web Services Realtime Servers</a>
30+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
3131
* </p>
3232
* <p>
3333
* <b>Related actions</b>

clients/client-gamelift/src/commands/PutScalingPolicyCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyOutput, _
2424
/**
2525
* <p>Creates or updates a scaling policy for a fleet. Scaling policies are used to
2626
* automatically scale a fleet's hosting capacity to meet player demand. An active scaling
27-
* policy instructs Amazon Web Services to track a fleet metric and automatically change the fleet's
27+
* policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's
2828
* capacity when a certain threshold is reached. There are two types of scaling policies:
2929
* target-based and rule-based. Use a target-based policy to quickly and efficiently manage
3030
* fleet scaling; this option is the most commonly used. Use rule-based policies when you
@@ -46,12 +46,12 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyOutput, _
4646
* metric tells us how much of a fleet's hosting capacity is ready to host game sessions
4747
* but is not currently in use. This is the fleet's buffer; it measures the additional
4848
* player demand that the fleet could handle at current capacity. With a target-based
49-
* policy, you set your ideal buffer size and leave it to Amazon Web Services to take whatever action
49+
* policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action
5050
* is needed to maintain that target. </p>
5151
* <p>For example, you might choose to maintain a 10% buffer for a fleet that has the
52-
* capacity to host 100 simultaneous game sessions. This policy tells Amazon Web Services to take
52+
* capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take
5353
* action whenever the fleet's available capacity falls below or rises above 10 game
54-
* sessions. Amazon Web Services will start new instances or stop unused instances in order to return
54+
* sessions. Amazon GameLift will start new instances or stop unused instances in order to return
5555
* to the 10% buffer. </p>
5656
* <p>To create or update a target-based policy, specify a fleet ID and name, and set the
5757
* policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions)

clients/client-gamelift/src/commands/RequestUploadCredentialsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface RequestUploadCredentialsCommandOutput extends RequestUploadCred
2323

2424
/**
2525
* <p>Retrieves a fresh set of credentials for use when uploading a new set of game build
26-
* files to Amazon Web Services's Amazon S3. This is done as part of the build creation process; see
26+
* files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see
2727
* <a>CreateBuild</a>.</p>
2828
* <p>To request new credentials, specify the build ID as returned with an initial
2929
* <code>CreateBuild</code> request. If successful, a new set of credentials are

0 commit comments

Comments
 (0)