# StopFleetActions **This API works with the following fleet types:** EC2, Container Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location. Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations. This operation can be used in the following ways: + To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend. + To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend. If successful, Amazon GameLift Servers no longer initiates scaling events except in response to manual changes using [UpdateFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html). To restart fleet actions again, call [StartFleetActions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartFleetActions.html). **Learn more** [Setting up Amazon GameLift Servers Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) ## Request Syntax ``` { "Actions": [ "string" ], "FleetId": "string", "Location": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. **Note** In the following list, the required parameters are described first. ** [Actions](#API_StopFleetActions_RequestSyntax) ** List of actions to suspend on the fleet. Type: Array of strings Array Members: Fixed number of 1 item. Valid Values: `AUTO_SCALING` Required: Yes ** [FleetId](#API_StopFleetActions_RequestSyntax) ** A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: `^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$` Required: Yes ** [Location](#API_StopFleetActions_RequestSyntax) ** The fleet location to stop fleet actions for. Specify a location in the form of an AWS Region code, such as `us-west-2`. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[A-Za-z0-9\-]+` Required: No ## Response Syntax ``` { "FleetArn": "string", "FleetId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FleetArn](#API_StopFleetActions_ResponseSyntax) ** The Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: `^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$` ** [FleetId](#API_StopFleetActions_ResponseSyntax) ** A unique identifier for the fleet to stop actions on. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-z]*fleet-[a-zA-Z0-9\-]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServiceException ** The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period. HTTP Status Code: 500 ** InvalidRequestException ** One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying. HTTP Status Code: 400 ** NotFoundException ** The requested resources was not found. The resource was either not created yet or deleted. HTTP Status Code: 400 ** UnauthorizedException ** The client failed authentication. Clients should not retry such requests. HTTP Status Code: 400 ** UnsupportedRegionException ** The requested operation is not supported in the Region specified. HTTP Status Code: 400 ## Examples ### Stop auto-scaling activity in a fleet's remote location In this example, we want to suspend all auto-scaling activity for a fleet's capacity in the remote location of `ca-central-1`. The fleet in question resides in the AWS Region us-west-2 (which is implicitly defined as our default Region). Once the policies are suspended, fleet capacity remains at the last "desired instances" setting unless fleet capacity is manually adjusted. HTTP requests are authenticated using an [AWS Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) signature in the `Authorization` header field. #### Sample Request ``` { "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "Location": "ca-central-1", "Actions": ["AUTO_SCALING"] } ``` #### Sample Response ``` { "FleetArn": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "FleetId": "arn:aws:gamelift:us-west-2::fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/gamelift-2015-10-01/StopFleetActions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/gamelift-2015-10-01/StopFleetActions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/gamelift-2015-10-01/StopFleetActions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/gamelift-2015-10-01/StopFleetActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/gamelift-2015-10-01/StopFleetActions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/gamelift-2015-10-01/StopFleetActions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/gamelift-2015-10-01/StopFleetActions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/gamelift-2015-10-01/StopFleetActions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/gamelift-2015-10-01/StopFleetActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/gamelift-2015-10-01/StopFleetActions)