Post x amz targetlightsail_20161128.stopinstance

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14159650798.5 KB

Stops a specific Amazon Lightsail instance that is currently running.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

post/#X-Amz-Target=Lightsail_20161128.StopInstance

Headers

X-Amz-Target'Lightsail_20161128.StopInstance' required

Request body

instanceNamestring required

The name of the instance (a virtual private server) to stop.

forceboolean

<p>When set to <code>True</code>, forces a Lightsail instance that is stuck in a <code>stopping</code> state to stop.</p> <important> <p>Only use the <code>force</code> parameter if your instance is stuck in the <code>stopping</code> state. In any other state, your instance should stop normally without adding this parameter to your API request.</p> </important>

Response

Success