OpsWorks / Client / deregister_instance

deregister_instance#

OpsWorks.Client.deregister_instance(**kwargs)#

Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the instance from the stack and returns it to your control.

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.deregister_instance(
    InstanceId='string'
)
Parameters:

InstanceId (string) –

[REQUIRED]

The instance ID.

Returns:

None

Exceptions

  • OpsWorks.Client.exceptions.ValidationException

  • OpsWorks.Client.exceptions.ResourceNotFoundException