@aws-sdk/client-gamelift 3.533.0 → 3.540.0

package/dist-types/models/models_1.d.ts

@@ -4,35 +4,35 @@ import { BackfillMode, BalancingStrategy, FilterConfiguration, FlexMatchMode, Ga
  */
 export interface UpdateFleetCapacityInput {
     /**
-     * @public
      * <p>A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN
      *             value.</p>
+     * @public
      */
     FleetId: string | undefined;
     /**
-     * @public
      * <p>The number of Amazon EC2 instances you want to maintain in the specified fleet location.
      *             This value must fall between the minimum and maximum size limits. Changes in desired
      *             instance value can take up to 1 minute to be reflected when viewing the fleet's capacity
      *             settings.</p>
+     * @public
      */
     DesiredInstances?: number;
     /**
-     * @public
      * <p>The minimum number of instances that are allowed in the specified fleet location. If
      *             this parameter is not set, the default is 0.</p>
+     * @public
      */
     MinSize?: number;
     /**
-     * @public
      * <p>The maximum number of instances that are allowed in the specified fleet location. If
      *             this parameter is not set, the default is 1.</p>
+     * @public
      */
     MaxSize?: number;
     /**
-     * @public
      * <p>The name of a remote location to update fleet capacity settings for, in the form of an
      *             Amazon Web Services Region code such as <code>us-west-2</code>.</p>
+     * @public
      */
     Location?: string;
 }
@@ -41,19 +41,19 @@ export interface UpdateFleetCapacityInput {
  */
 export interface UpdateFleetCapacityOutput {
     /**
-     * @public
      * <p>A unique identifier for the fleet that was updated.</p>
+     * @public
      */
     FleetId?: string;
     /**
-     * @public
      * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. </p>
+     * @public
      */
     FleetArn?: string;
     /**
-     * @public
      * <p>The remote location being updated, expressed as an Amazon Web Services Region code, such as
      *                 <code>us-west-2</code>.</p>
+     * @public
      */
     Location?: string;
 }
@@ -62,19 +62,19 @@ export interface UpdateFleetCapacityOutput {
  */
 export interface UpdateFleetPortSettingsInput {
     /**
-     * @public
      * <p>A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN
      *             value.</p>
+     * @public
      */
     FleetId: string | undefined;
     /**
-     * @public
      * <p>A collection of port settings to be added to the fleet resource.</p>
+     * @public
      */
     InboundPermissionAuthorizations?: IpPermission[];
     /**
-     * @public
      * <p>A collection of port settings to be removed from the fleet resource.</p>
+     * @public
      */
     InboundPermissionRevocations?: IpPermission[];
 }
@@ -83,13 +83,13 @@ export interface UpdateFleetPortSettingsInput {
  */
 export interface UpdateFleetPortSettingsOutput {
     /**
-     * @public
      * <p>A unique identifier for the fleet that was updated.</p>
+     * @public
      */
     FleetId?: string;
     /**
-     * @public
      * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
+     * @public
      */
     FleetArn?: string;
 }
@@ -109,33 +109,33 @@ export type GameServerHealthCheck = (typeof GameServerHealthCheck)[keyof typeof
  */
 export interface UpdateGameServerInput {
     /**
-     * @public
      * <p>A unique identifier for the game server group where the game server is running.</p>
+     * @public
      */
     GameServerGroupName: string | undefined;
     /**
-     * @public
      * <p>A custom string that uniquely identifies the game server to update.</p>
+     * @public
      */
     GameServerId: string | undefined;
     /**
-     * @public
      * <p>A set of custom game server properties, formatted as a single string value. This data
      *             is passed to a game client or service when it requests information on game servers. </p>
+     * @public
      */
     GameServerData?: string;
     /**
-     * @public
      * <p>Indicates if the game server is available or is currently hosting gameplay. You can
      *             update a game server status from <code>AVAILABLE</code> to <code>UTILIZED</code>, but
      *             you can't change a the status from <code>UTILIZED</code> to
      *             <code>AVAILABLE</code>.</p>
+     * @public
      */
     UtilizationStatus?: GameServerUtilizationStatus;
     /**
-     * @public
      * <p>Indicates health status of the game server. A request that includes this parameter
      *             updates the game server's <i>LastHealthCheckTime</i> timestamp. </p>
+     * @public
      */
     HealthCheck?: GameServerHealthCheck;
 }
@@ -144,8 +144,8 @@ export interface UpdateGameServerInput {
  */
 export interface UpdateGameServerOutput {
     /**
-     * @public
      * <p>Object that describes the newly updated game server.</p>
+     * @public
      */
     GameServer?: GameServer;
 }
@@ -154,18 +154,17 @@ export interface UpdateGameServerOutput {
  */
 export interface UpdateGameServerGroupInput {
     /**
-     * @public
      * <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
+     * @public
      */
     GameServerGroupName: string | undefined;
     /**
-     * @public
      * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that
      *             allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</p>
+     * @public
      */
     RoleArn?: string;
     /**
-     * @public
      * <p>An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance
      *             definitions must specify at least two different instance types that are supported by
      *             Amazon GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for
@@ -175,20 +174,20 @@ export interface UpdateGameServerGroupInput {
      *             an instance type, it is set to the default value "1". For more information about
      *             capacity weighting, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html"> Instance Weighting for
      *                 Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>
+     * @public
      */
     InstanceDefinitions?: InstanceDefinition[];
     /**
-     * @public
      * <p>A flag that indicates whether instances in the game server group are protected
      *             from early termination. Unprotected instances that have active game servers running might
      *             be terminated during a scale-down event, causing players to be dropped from the game.
      *             Protected instances cannot be terminated while there are active game servers running except
      *             in the event of a forced game server group deletion (see ). An exception to this is with Spot
      *             Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>
+     * @public
      */
     GameServerProtectionPolicy?: GameServerProtectionPolicy;
     /**
-     * @public
      * <p>Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the
      *             game server group. Method options include the following:</p>
      *          <ul>
@@ -215,6 +214,7 @@ export interface UpdateGameServerGroupInput {
      *                     balancing strategy is in force.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     BalancingStrategy?: BalancingStrategy;
 }
@@ -223,9 +223,9 @@ export interface UpdateGameServerGroupInput {
  */
 export interface UpdateGameServerGroupOutput {
     /**
-     * @public
      * <p>An object that describes the game server group resource with updated properties.
      *         </p>
+     * @public
      */
     GameServerGroup?: GameServerGroup;
 }
@@ -234,27 +234,26 @@ export interface UpdateGameServerGroupOutput {
  */
 export interface UpdateGameSessionInput {
     /**
-     * @public
      * <p>A unique identifier for the game session to update. </p>
+     * @public
      */
     GameSessionId: string | undefined;
     /**
-     * @public
      * <p>The maximum number of players that can be connected simultaneously to the game session.</p>
+     * @public
      */
     MaximumPlayerSessionCount?: number;
     /**
-     * @public
      * <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>A policy that determines whether the game session is accepting new players.</p>
+     * @public
      */
     PlayerSessionCreationPolicy?: PlayerSessionCreationPolicy;
     /**
-     * @public
      * <p>Game session protection policy to apply to this game session only.</p>
      *          <ul>
      *             <li>
@@ -269,10 +268,10 @@ export interface UpdateGameSessionInput {
      *                     event.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     ProtectionPolicy?: ProtectionPolicy;
     /**
-     * @public
      * <p>A set of key-value pairs that can store custom data in a game session.
      *   For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.
      *         You can use this parameter to modify game properties in an active game session.
@@ -280,6 +279,7 @@ export interface UpdateGameSessionInput {
      *         There is no way to delete properties.
      *         For an example, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-update">Update the value of a game property</a>.
      *       </p>
+     * @public
      */
     GameProperties?: GameProperty[];
 }
@@ -288,8 +288,8 @@ export interface UpdateGameSessionInput {
  */
 export interface UpdateGameSessionOutput {
     /**
-     * @public
      * <p>The updated game session properties.</p>
+     * @public
      */
     GameSession?: GameSession;
 }
@@ -298,55 +298,55 @@ export interface UpdateGameSessionOutput {
  */
 export interface UpdateGameSessionQueueInput {
     /**
-     * @public
      * <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. </p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status. By default, this property is set to <code>600</code>.</p>
+     * @public
      */
     TimeoutInSeconds?: number;
     /**
-     * @public
      * <p>A set of policies that act as a sliding cap on player latency. FleetIQ works to
      *             deliver low latency for most players in a game session. These policies ensure that no
      *             individual player can be placed into a game with unreasonably high latency. Use multiple
      *             policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their
      *             maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.</p>
+     * @public
      */
     PlayerLatencyPolicies?: PlayerLatencyPolicy[];
     /**
-     * @public
      * <p>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
      *     Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.</p>
+     * @public
      */
     Destinations?: GameSessionQueueDestination[];
     /**
-     * @public
      * <p>A list of locations where a queue is allowed to place new game sessions. Locations
      *             are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is
      *             not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.</p>
+     * @public
      */
     FilterConfiguration?: FilterConfiguration;
     /**
-     * @public
      * <p>Custom settings to use when prioritizing destinations and locations for game session placements. This
      *             configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly
      *             named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.</p>
+     * @public
      */
     PriorityConfiguration?: PriorityConfiguration;
     /**
-     * @public
      * <p>Information to be added to all events that are related to this game session
      *             queue.</p>
+     * @public
      */
     CustomEventData?: string;
     /**
-     * @public
      * <p>An SNS topic ARN that is set up to receive game session placement notifications. See
      *                 <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up
      *                 notifications for game session placement</a>.</p>
+     * @public
      */
     NotificationTarget?: string;
 }
@@ -355,8 +355,8 @@ export interface UpdateGameSessionQueueInput {
  */
 export interface UpdateGameSessionQueueOutput {
     /**
-     * @public
      * <p>An object that describes the newly updated game session queue.</p>
+     * @public
      */
     GameSessionQueue?: GameSessionQueue;
 }
@@ -365,86 +365,85 @@ export interface UpdateGameSessionQueueOutput {
  */
 export interface UpdateMatchmakingConfigurationInput {
     /**
-     * @public
      * <p>A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value. </p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>A description for the matchmaking configuration.</p>
+     * @public
      */
     Description?: string;
     /**
-     * @public
      * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. Queues can be located in any Region. Queues are used to start new
      *             Amazon GameLift-hosted game sessions for matches that are created with this matchmaking
      *             configuration. If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not
      *             set this parameter.</p>
+     * @public
      */
     GameSessionQueueArns?: string[];
     /**
-     * @public
      * <p>The maximum duration, in seconds, that a matchmaking ticket can remain in process
      *             before timing out. Requests that fail due to timing out can be resubmitted as
      *             needed.</p>
+     * @public
      */
     RequestTimeoutSeconds?: number;
     /**
-     * @public
      * <p>The length of time (in seconds) to wait for players to accept a proposed match, if
      *             acceptance is required.</p>
+     * @public
      */
     AcceptanceTimeoutSeconds?: number;
     /**
-     * @public
      * <p>A flag that indicates whether a match that was created with this configuration must be
      *             accepted by the matched players. To require acceptance, set to TRUE. With this option
      *             enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate
      *             when a completed potential match is waiting for player acceptance. </p>
+     * @public
      */
     AcceptanceRequired?: boolean;
     /**
-     * @public
      * <p>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN
      *             value. A matchmaking configuration can only use rule sets that are defined in the same
      *             Region.</p>
+     * @public
      */
     RuleSetName?: string;
     /**
-     * @public
      * <p>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html">
      *                 Setting up notifications for matchmaking</a> for more information.</p>
+     * @public
      */
     NotificationTarget?: string;
     /**
-     * @public
      * <p>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies
      *             a match for a single 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if <code>FlexMatchMode</code> is set to
      *                 <code>STANDALONE</code>.</p>
+     * @public
      */
     AdditionalPlayerCount?: number;
     /**
-     * @public
      * <p>Information to add to all events related to the matchmaking configuration. </p>
+     * @public
      */
     CustomEventData?: string;
     /**
-     * @public
      * <p>A set of key-value pairs that can store custom data in a game session.
      *   For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>. This information is added to the new <code>GameSession</code> object that is
      *             created for a successful match. This parameter is not used if <code>FlexMatchMode</code>
      *             is set to <code>STANDALONE</code>.</p>
+     * @public
      */
     GameProperties?: GameProperty[];
     /**
-     * @public
      * <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the game session
      *             that is created for a successful match. This parameter is not used if
      *                 <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
+     * @public
      */
     GameSessionData?: string;
     /**
-     * @public
      * <p>The method that is used to backfill game sessions created with this matchmaking
      *             configuration. Specify MANUAL when your game manages backfill requests manually or does
      *             not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill
@@ -452,10 +451,10 @@ export interface UpdateMatchmakingConfigurationInput {
      *             slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html">Backfill Existing Games
      *                 with FlexMatch</a>. Automatic backfill is not available when
      *                 <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
+     * @public
      */
     BackfillMode?: BackfillMode;
     /**
-     * @public
      * <p>Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or
      *             as a standalone matchmaking solution. </p>
      *          <ul>
@@ -470,6 +469,7 @@ export interface UpdateMatchmakingConfigurationInput {
      *                     the specified Amazon GameLift queue to start a game session for the match. </p>
      *             </li>
      *          </ul>
+     * @public
      */
     FlexMatchMode?: FlexMatchMode;
 }
@@ -478,8 +478,8 @@ export interface UpdateMatchmakingConfigurationInput {
  */
 export interface UpdateMatchmakingConfigurationOutput {
     /**
-     * @public
      * <p>The updated matchmaking configuration.</p>
+     * @public
      */
     Configuration?: MatchmakingConfiguration;
 }
@@ -488,17 +488,17 @@ export interface UpdateMatchmakingConfigurationOutput {
  */
 export interface UpdateRuntimeConfigurationInput {
     /**
-     * @public
      * <p>A unique identifier for the fleet to update runtime configuration for. You can use either the fleet ID or ARN
      *             value.</p>
+     * @public
      */
     FleetId: string | undefined;
     /**
-     * @public
      * <p>Instructions for launching server processes on each instance in the fleet. Server
      *             processes run either a custom game build executable or a Realtime Servers script. The runtime
      *             configuration lists the types of server processes to run on an instance, how to launch
      *             them, and the number of processes to run concurrently.</p>
+     * @public
      */
     RuntimeConfiguration: RuntimeConfiguration | undefined;
 }
@@ -507,9 +507,9 @@ export interface UpdateRuntimeConfigurationInput {
  */
 export interface UpdateRuntimeConfigurationOutput {
     /**
-     * @public
      * <p>The runtime configuration currently in use by all instances in the fleet. If the
      *             update was successful, all property changes are shown. </p>
+     * @public
      */
     RuntimeConfiguration?: RuntimeConfiguration;
 }
@@ -518,22 +518,21 @@ export interface UpdateRuntimeConfigurationOutput {
  */
 export interface UpdateScriptInput {
     /**
-     * @public
      * <p>A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.</p>
+     * @public
      */
     ScriptId: string | undefined;
     /**
-     * @public
      * <p>A descriptive label that is associated with a script. Script names don't need to be unique.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>Version information associated with a build or script. Version strings don't need to be unique.</p>
+     * @public
      */
     Version?: string;
     /**
-     * @public
      * <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is
      *             stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the
      *             "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3
@@ -541,16 +540,17 @@ export interface UpdateScriptInput {
      *             Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning
      *             turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier
      *             version. </p>
+     * @public
      */
     StorageLocation?: S3Location;
     /**
-     * @public
      * <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip
      *             file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
      *          <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip
      *             file name. It must be prepended with the string "fileb://" to indicate that the file
      *             data is a binary object. For example: <code>--zip-file
      *                 fileb://myRealtimeScript.zip</code>.</p>
+     * @public
      */
     ZipFile?: Uint8Array;
 }
@@ -559,13 +559,13 @@ export interface UpdateScriptInput {
  */
 export interface UpdateScriptOutput {
     /**
-     * @public
      * <p>The newly created script record with a unique script ID. The new script's storage
      *             location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket
      *             under your account, the storage location reflects the information that was provided in
      *             the <i>CreateScript</i> request; (2) If the script file was uploaded from
      *             a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift
      *             service.</p>
+     * @public
      */
     Script?: Script;
 }
@@ -574,8 +574,8 @@ export interface UpdateScriptOutput {
  */
 export interface ValidateMatchmakingRuleSetInput {
     /**
-     * @public
      * <p>A collection of matchmaking rules to validate, formatted as a JSON string.</p>
+     * @public
      */
     RuleSetBody: string | undefined;
 }
@@ -584,8 +584,8 @@ export interface ValidateMatchmakingRuleSetInput {
  */
 export interface ValidateMatchmakingRuleSetOutput {
     /**
-     * @public
      * <p>A response indicating whether the rule set is valid.</p>
+     * @public
      */
     Valid?: boolean;
 }