OpsWorksCM / Client / delete_server

delete_server#

OpsWorksCM.Client.delete_server(**kwargs)#

Deletes the server and the underlying AWS CloudFormation stacks (including the server’s EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

See also: AWS API Documentation

Request Syntax

response = client.delete_server(
    ServerName='string'
)
Parameters:

ServerName (string) –

[REQUIRED]

The ID of the server to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • OpsWorksCM.Client.exceptions.InvalidStateException

  • OpsWorksCM.Client.exceptions.ResourceNotFoundException

  • OpsWorksCM.Client.exceptions.ValidationException