@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.
Files changed (51) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/README.md +5 -5
  3. package/dist-types/GameLift.d.ts +182 -125
  4. package/dist-types/GameLiftClient.d.ts +5 -5
  5. package/dist-types/commands/CreateAliasCommand.d.ts +1 -1
  6. package/dist-types/commands/CreateBuildCommand.d.ts +4 -4
  7. package/dist-types/commands/CreateFleetCommand.d.ts +6 -3
  8. package/dist-types/commands/CreateFleetLocationsCommand.d.ts +1 -1
  9. package/dist-types/commands/CreateGameServerGroupCommand.d.ts +6 -6
  10. package/dist-types/commands/CreateGameSessionCommand.d.ts +1 -1
  11. package/dist-types/commands/CreateGameSessionQueueCommand.d.ts +13 -6
  12. package/dist-types/commands/CreateMatchmakingConfigurationCommand.d.ts +1 -1
  13. package/dist-types/commands/CreatePlayerSessionCommand.d.ts +3 -1
  14. package/dist-types/commands/CreatePlayerSessionsCommand.d.ts +3 -1
  15. package/dist-types/commands/CreateScriptCommand.d.ts +6 -6
  16. package/dist-types/commands/CreateVpcPeeringAuthorizationCommand.d.ts +12 -12
  17. package/dist-types/commands/CreateVpcPeeringConnectionCommand.d.ts +8 -8
  18. package/dist-types/commands/DeleteGameSessionQueueCommand.d.ts +10 -5
  19. package/dist-types/commands/DeleteScriptCommand.d.ts +1 -1
  20. package/dist-types/commands/DeleteVpcPeeringConnectionCommand.d.ts +2 -2
  21. package/dist-types/commands/DescribeEC2InstanceLimitsCommand.d.ts +6 -6
  22. package/dist-types/commands/DescribeGameSessionDetailsCommand.d.ts +1 -1
  23. package/dist-types/commands/DescribeGameSessionPlacementCommand.d.ts +10 -2
  24. package/dist-types/commands/DescribeGameSessionQueuesCommand.d.ts +8 -4
  25. package/dist-types/commands/DescribeGameSessionsCommand.d.ts +16 -2
  26. package/dist-types/commands/DescribeMatchmakingCommand.d.ts +1 -1
  27. package/dist-types/commands/DescribePlayerSessionsCommand.d.ts +1 -1
  28. package/dist-types/commands/DescribeScriptCommand.d.ts +1 -1
  29. package/dist-types/commands/DescribeVpcPeeringAuthorizationsCommand.d.ts +1 -1
  30. package/dist-types/commands/DescribeVpcPeeringConnectionsCommand.d.ts +2 -2
  31. package/dist-types/commands/GetGameSessionLogUrlCommand.d.ts +1 -1
  32. package/dist-types/commands/GetInstanceAccessCommand.d.ts +1 -1
  33. package/dist-types/commands/ListAliasesCommand.d.ts +1 -1
  34. package/dist-types/commands/ListBuildsCommand.d.ts +1 -1
  35. package/dist-types/commands/ListFleetsCommand.d.ts +1 -1
  36. package/dist-types/commands/ListGameServerGroupsCommand.d.ts +1 -1
  37. package/dist-types/commands/ListScriptsCommand.d.ts +2 -2
  38. package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -4
  39. package/dist-types/commands/PutScalingPolicyCommand.d.ts +4 -4
  40. package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +1 -1
  41. package/dist-types/commands/SearchGameSessionsCommand.d.ts +7 -0
  42. package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +5 -5
  43. package/dist-types/commands/StartMatchBackfillCommand.d.ts +1 -0
  44. package/dist-types/commands/StartMatchmakingCommand.d.ts +1 -1
  45. package/dist-types/commands/TagResourceCommand.d.ts +5 -5
  46. package/dist-types/commands/UntagResourceCommand.d.ts +4 -4
  47. package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +2 -2
  48. package/dist-types/commands/UpdateGameSessionQueueCommand.d.ts +8 -4
  49. package/dist-types/commands/UpdateScriptCommand.d.ts +2 -2
  50. package/dist-types/models/models_0.d.ts +302 -259
  51. package/package.json +40 -34
@@ -7,7 +7,7 @@ export interface ListBuildsCommandInput extends ListBuildsInput {
7
7
  export interface ListBuildsCommandOutput extends ListBuildsOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves build resources for all builds associated with the AWS account in use. You
10
+ * <p>Retrieves build resources for all builds associated with the Amazon Web Services account in use. You
11
11
  * can limit results to builds that are in a specific status by using the
12
12
  * <code>Status</code> parameter. Use the pagination parameters to retrieve results in
13
13
  * a set of sequential pages. </p>
@@ -7,7 +7,7 @@ export interface ListFleetsCommandInput extends ListFleetsInput {
7
7
  export interface ListFleetsCommandOutput extends ListFleetsOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves a collection of fleet resources in an AWS Region. You can call this operation
10
+ * <p>Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation
11
11
  * to get fleets in a previously selected default Region (see <a href="https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html">https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html</a>or specify a Region in your
12
12
  * request. You can filter the result set to find only those fleets that are deployed with
13
13
  * a specific build or script. For fleets that have multiple locations, this operation
@@ -10,7 +10,7 @@ export interface ListGameServerGroupsCommandOutput extends ListGameServerGroupsO
10
10
  * <p>
11
11
  * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
12
12
  * </p>
13
- * <p>Retrieves information on all game servers groups that exist in the current AWS
13
+ * <p>Retrieves information on all game servers groups that exist in the current Amazon Web Services
14
14
  * account for the selected Region. Use the pagination parameters to retrieve results in a
15
15
  * set of sequential segments. </p>
16
16
  * <p>
@@ -7,12 +7,12 @@ export interface ListScriptsCommandInput extends ListScriptsInput {
7
7
  export interface ListScriptsCommandOutput extends ListScriptsOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves script records for all Realtime scripts that are associated with the AWS account in use. </p>
10
+ * <p>Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use. </p>
11
11
  * <p>
12
12
  * <b>Learn more</b>
13
13
  * </p>
14
14
  * <p>
15
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
15
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon Web Services Realtime Servers</a>
16
16
  * </p>
17
17
  * <p>
18
18
  * <b>Related actions</b>
@@ -9,7 +9,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
9
9
  /**
10
10
  * <p>
11
11
  * Retrieves all tags that are assigned to a GameLift resource.
12
- * Resource tags are used to organize AWS resources for a range of purposes.
12
+ * Resource tags are used to organize Amazon Web Services resources for a range of purposes.
13
13
  * This operation handles the permissions necessary to manage tags for the following
14
14
  * GameLift resource types:</p>
15
15
  * <ul>
@@ -40,12 +40,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
40
40
  * <b>Learn more</b>
41
41
  * </p>
42
42
  * <p>
43
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> in the
44
- * <i>AWS General Reference</i>
43
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the
44
+ * <i>Amazon Web Services General Reference</i>
45
45
  * </p>
46
46
  * <p>
47
47
  * <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
48
- * AWS Tagging Strategies</a>
48
+ * Amazon Web Services Tagging Strategies</a>
49
49
  * </p>
50
50
  * <p>
51
51
  * <b>Related actions</b>
@@ -9,7 +9,7 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyOutput, _
9
9
  /**
10
10
  * <p>Creates or updates a scaling policy for a fleet. Scaling policies are used to
11
11
  * automatically scale a fleet's hosting capacity to meet player demand. An active scaling
12
- * policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's
12
+ * policy instructs Amazon Web Services to track a fleet metric and automatically change the fleet's
13
13
  * capacity when a certain threshold is reached. There are two types of scaling policies:
14
14
  * target-based and rule-based. Use a target-based policy to quickly and efficiently manage
15
15
  * fleet scaling; this option is the most commonly used. Use rule-based policies when you
@@ -31,12 +31,12 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyOutput, _
31
31
  * metric tells us how much of a fleet's hosting capacity is ready to host game sessions
32
32
  * but is not currently in use. This is the fleet's buffer; it measures the additional
33
33
  * player demand that the fleet could handle at current capacity. With a target-based
34
- * policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action
34
+ * policy, you set your ideal buffer size and leave it to Amazon Web Services to take whatever action
35
35
  * is needed to maintain that target. </p>
36
36
  * <p>For example, you might choose to maintain a 10% buffer for a fleet that has the
37
- * capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take
37
+ * capacity to host 100 simultaneous game sessions. This policy tells Amazon Web Services to take
38
38
  * action whenever the fleet's available capacity falls below or rises above 10 game
39
- * sessions. Amazon GameLift will start new instances or stop unused instances in order to return
39
+ * sessions. Amazon Web Services will start new instances or stop unused instances in order to return
40
40
  * to the 10% buffer. </p>
41
41
  * <p>To create or update a target-based policy, specify a fleet ID and name, and set the
42
42
  * policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions)
@@ -8,7 +8,7 @@ export interface RequestUploadCredentialsCommandOutput extends RequestUploadCred
8
8
  }
9
9
  /**
10
10
  * <p>Retrieves a fresh set of credentials for use when uploading a new set of game build
11
- * files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see
11
+ * files to Amazon Web Services's Amazon S3. This is done as part of the build creation process; see
12
12
  * <a>CreateBuild</a>.</p>
13
13
  * <p>To request new credentials, specify the build ID as returned with an initial
14
14
  * <code>CreateBuild</code> request. If successful, a new set of credentials are
@@ -9,6 +9,13 @@ export interface SearchGameSessionsCommandOutput extends SearchGameSessionsOutpu
9
9
  /**
10
10
  * <p>Retrieves all active game sessions that match a set of search criteria and sorts them
11
11
  * into a specified order. </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 game session status
16
+ * with <code>DescribeGameSessions</code> should only be used for games in development with
17
+ * low game session usage.
18
+ * </p>
12
19
  * <p>When searching for game sessions, you specify exactly where you want to search and
13
20
  * provide a search filter expression, a sort expression, or both. A search request can
14
21
  * search only one fleet, but it can search all of a fleet's locations. </p>
@@ -7,20 +7,20 @@ export interface StartGameSessionPlacementCommandInput extends StartGameSessionP
7
7
  export interface StartGameSessionPlacementCommandOutput extends StartGameSessionPlacementOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Places a request for a new game session in a queue (see <a>CreateGameSessionQueue</a>). When processing a placement request, Amazon GameLift
10
+ * <p>Places a request for a new game session in a queue (see <a>CreateGameSessionQueue</a>). When processing a placement request, Amazon Web Services
11
11
  * searches for available resources on the queue's destinations, scanning each until it
12
12
  * finds resources or the placement request times out.</p>
13
13
  * <p>A game session placement request can also request player sessions. When a new game
14
- * session is successfully created, Amazon GameLift creates a player session for each player
14
+ * session is successfully created, Amazon Web Services creates a player session for each player
15
15
  * included in the request.</p>
16
- * <p>When placing a game session, by default Amazon GameLift tries each fleet in the order they
16
+ * <p>When placing a game session, by default Amazon Web Services tries each fleet in the order they
17
17
  * are listed in the queue configuration. Ideally, a queue's destinations are listed in
18
18
  * preference order.</p>
19
19
  * <p>Alternatively, when requesting a game session with players, you can also provide
20
20
  * latency data for each player in relevant Regions. Latency data indicates the performance
21
- * lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency
21
+ * lag a player experiences when connected to a fleet in the Region. Amazon Web Services uses latency
22
22
  * data to reorder the list of destinations to place the game session in a Region with
23
- * minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each
23
+ * minimal lag. If latency data is provided for multiple players, Amazon Web Services calculates each
24
24
  * Region's average lag for all players and reorders to get the best game play across all
25
25
  * players. </p>
26
26
  * <p>To place a new game session request, specify the following:</p>
@@ -29,6 +29,7 @@ export interface StartMatchBackfillCommandOutput extends StartMatchBackfillOutpu
29
29
  * backfilled. Optionally, specify the <code>GameSession</code> ARN. If successful, a match
30
30
  * backfill ticket is created and returned with status set to QUEUED. Track the status of
31
31
  * backfill tickets using the same method for tracking tickets for new matches.</p>
32
+ * <p>Only game sessions created by FlexMatch are supported for match backfill.</p>
32
33
  * <p>
33
34
  * <b>Learn more</b>
34
35
  * </p>
@@ -20,7 +20,7 @@ export interface StartMatchmakingCommandOutput extends StartMatchmakingOutput, _
20
20
  * ticket is returned with status set to <code>QUEUED</code>. </p>
21
21
  * <p>Track matchmaking events to respond as needed and acquire game session connection
22
22
  * information for successfully completed matches. Ticket status updates are tracked using
23
- * event notification through Amazon Simple Notification Service (SNS), which is defined in the matchmaking
23
+ * event notification through Amazon Simple Notification Service, which is defined in the matchmaking
24
24
  * configuration.</p>
25
25
  * <p>
26
26
  * <b>Learn more</b>
@@ -7,9 +7,9 @@ export interface TagResourceCommandInput extends TagResourceRequest {
7
7
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p> Assigns a tag to a GameLift resource. AWS resource tags provide an additional
10
+ * <p> Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional
11
11
  * management tool set. You can use tags to organize resources, create IAM permissions
12
- * policies to manage access to groups of resources, customize AWS cost breakdowns, etc.
12
+ * policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc.
13
13
  * This operation handles the permissions necessary to manage tags for the following GameLift
14
14
  * resource types:</p>
15
15
  * <ul>
@@ -42,12 +42,12 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
42
42
  * <b>Learn more</b>
43
43
  * </p>
44
44
  * <p>
45
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> in the
46
- * <i>AWS General Reference</i>
45
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the
46
+ * <i>Amazon Web Services General Reference</i>
47
47
  * </p>
48
48
  * <p>
49
49
  * <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
50
- * AWS Tagging Strategies</a>
50
+ * Amazon Web Services Tagging Strategies</a>
51
51
  * </p>
52
52
  * <p>
53
53
  * <b>Related actions</b>
@@ -8,7 +8,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
8
8
  }
9
9
  /**
10
10
  * <p>Removes a tag that is assigned to a GameLift resource.
11
- * Resource tags are used to organize AWS resources for a range of purposes.
11
+ * Resource tags are used to organize Amazon Web Services resources for a range of purposes.
12
12
  * This operation handles the permissions necessary to manage tags for the following
13
13
  * GameLift resource types:</p>
14
14
  * <ul>
@@ -42,12 +42,12 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
42
42
  * <b>Learn more</b>
43
43
  * </p>
44
44
  * <p>
45
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> in the
46
- * <i>AWS General Reference</i>
45
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the
46
+ * <i>Amazon Web Services General Reference</i>
47
47
  * </p>
48
48
  * <p>
49
49
  * <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
50
- * AWS Tagging Strategies</a>
50
+ * Amazon Web Services Tagging Strategies</a>
51
51
  * </p>
52
52
  * <p>
53
53
  * <b>Related actions</b>
@@ -18,10 +18,10 @@ export interface UpdateFleetCapacityCommandOutput extends UpdateFleetCapacityOut
18
18
  * changed manually or through automatic scaling. </p>
19
19
  * </li>
20
20
  * <li>
21
- * <p>Desired capacity: Manually set the number of EC2 instances to be maintained
21
+ * <p>Desired capacity: Manually set the number of Amazon EC2 instances to be maintained
22
22
  * in a fleet location. Before changing a fleet's desired capacity, you may want to
23
23
  * call <a>DescribeEC2InstanceLimits</a> to get the maximum capacity of
24
- * the fleet's EC2 instance type. Alternatively, consider using automatic scaling
24
+ * the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling
25
25
  * to adjust capacity based on player demand.</p>
26
26
  * </li>
27
27
  * </ul>
@@ -22,10 +22,14 @@ export interface UpdateGameSessionQueueCommandOutput extends UpdateGameSessionQu
22
22
  * <b>Related actions</b>
23
23
  * </p>
24
24
  * <p>
25
- * <a>CreateGameSessionQueue</a> |
26
- * <a>DescribeGameSessionQueues</a> |
27
- * <a>UpdateGameSessionQueue</a> |
28
- * <a>DeleteGameSessionQueue</a> |
25
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html">CreateGameSessionQueue</a>
26
+ * |
27
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html">DescribeGameSessionQueues</a>
28
+ * |
29
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html">UpdateGameSessionQueue</a>
30
+ * |
31
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html">DeleteGameSessionQueue</a>
32
+ * |
29
33
  * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
30
34
  * </p>
31
35
  * @example
@@ -15,13 +15,13 @@ export interface UpdateScriptCommandOutput extends UpdateScriptOutput, __Metadat
15
15
  * original script was uploaded. Use the <i>Version</i> parameter to track
16
16
  * updates to the script.</p>
17
17
  * <p>If the call is successful, the updated metadata is stored in the script record and a
18
- * revised script is uploaded to the Amazon GameLift service. Once the script is updated and
18
+ * revised script is uploaded to the Amazon Web Services service. Once the script is updated and
19
19
  * acquired by a fleet instance, the new version is used for all new game sessions. </p>
20
20
  * <p>
21
21
  * <b>Learn more</b>
22
22
  * </p>
23
23
  * <p>
24
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
24
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon Web Services Realtime Servers</a>
25
25
  * </p>
26
26
  * <p>
27
27
  * <b>Related actions</b>