Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14104474602.4 KB

Updates a fleet's mutable attributes, including game session protection and resource creation limits.

To update fleet attributes, specify the fleet ID and the property values that you want to change.

If successful, an updated FleetAttributes object is returned.

Learn more

Setting up Amazon GameLift fleets

post/#X-Amz-Target=GameLift.UpdateFleetAttributes

Headers

X-Amz-Target'GameLift.UpdateFleetAttributes' required

Request body

FleetIdstring required

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Namestring

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Descriptionstring

A human-readable description of a fleet.

NewGameSessionProtectionPolicy'NoProtection' | 'FullProtection'
<p>The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> .</p> <ul> <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>
MetricGroupsMetricGroup[]

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Response

Success

FleetIdstring

A unique identifier for the fleet that was updated.

FleetArnstring

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>.