AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:
Minimum/maximum size: Set hard limits on fleet capacity. Amazon GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling.
Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.
This operation can be used in the following ways:
To update capacity for a fleet's home Region, or if the fleet has no remote locations,
omit the Location parameter. The fleet must be in ACTIVE status.
To update capacity for a fleet's remote location, include the Location parameter
set to the location to be updated. The location must be in ACTIVE status.
If successful, capacity settings are updated immediately. In response a change in
desired capacity, Amazon GameLift initiates steps to start new instances or terminate
existing instances in the requested fleet location. This continues until the location's
active instance count matches the new desired instance count. You can track a fleet's
current capacity by calling DescribeFleetCapacity
or DescribeFleetLocationCapacity.
If the requested desired instance count is higher than the instance type's limit,
the LimitExceeded exception occurs.
Learn more
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginUpdateFleetCapacity and EndUpdateFleetCapacity.
Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public abstract Task<UpdateFleetCapacityResponse> UpdateFleetCapacityAsync( UpdateFleetCapacityRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the UpdateFleetCapacity service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| ConflictException | The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. |
| InternalServiceException | The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period. |
| InvalidFleetStatusException | The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying. |
| InvalidRequestException | One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying. |
| LimitExceededException | The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying. |
| NotFoundException | THe requested resources was not found. The resource was either not created yet or deleted. |
| UnauthorizedException | The client failed authentication. Clients should not retry such requests. |
| UnsupportedRegionException | The requested operation is not supported in the Region specified. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5