OpsWorks / Client / stop_instance
stop_instance#
- OpsWorks.Client.stop_instance(**kwargs)#
Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
See also: AWS API Documentation
Request Syntax
response = client.stop_instance( InstanceId='string', Force=True|False )
- Parameters:
InstanceId (string) –
[REQUIRED]
The instance ID.
Force (boolean) – Specifies whether to force an instance to stop. If the instance’s root device type is
ebs
, or EBS-backed, adding theForce
parameter to theStopInstances
API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.
- Returns:
None
Exceptions
OpsWorks.Client.exceptions.ValidationException
OpsWorks.Client.exceptions.ResourceNotFoundException