DeleteHost
The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.
Note
A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.
Request Syntax
{
"HostArn": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- HostArn
-
The Amazon Resource Name (ARN) of the host to be deleted.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws(-[\w]+)*:(codestar-connections|codeconnections):.+:[0-9]{12}:host\/.+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
Resource not found. Verify the connection resource ARN and try again.
HTTP Status Code: 400
- ResourceUnavailableException
-
Resource not found. Verify the ARN for the host resource and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: