DisassociateNode
Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.
A node can can only be disassociated from a server that is in a HEALTHY
state. Otherwise, an InvalidStateException
is thrown.
A ResourceNotFoundException
is thrown when the server does not exist.
A ValidationException
is raised when parameters of the request are not valid.
Request Syntax
{
"EngineAttributes": [
{
"Name": "string
",
"Value": "string
"
}
],
"NodeName": "string
",
"ServerName": "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.
- EngineAttributes
-
Engine attributes that are used for disassociating the node. No attributes are required for Puppet.
Attributes required in a DisassociateNode request for Chef
-
CHEF_ORGANIZATION
: The Chef organization with which the node was associated. By default only one organization nameddefault
can exist.
Type: Array of EngineAttribute objects
Required: No
-
- NodeName
-
The name of the client node.
Type: String
Length Constraints: Maximum length of 10000.
Pattern:
^[\-\p{Alnum}_:.]+$
Required: Yes
- ServerName
-
The name of the server from which to disassociate the node.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[a-zA-Z][a-zA-Z0-9\-]*
Required: Yes
Response Syntax
{
"NodeAssociationStatusToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NodeAssociationStatusToken
-
Contains a token which can be passed to the
DescribeNodeAssociationStatus
API call to get the status of the disassociation request.Type: String
Length Constraints: Maximum length of 10000.
Pattern:
(?s).*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidStateException
-
The resource is in a state that does not allow you to perform a specified action.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource does not exist, or access was denied.
HTTP Status Code: 400
- ValidationException
-
One or more of the provided request parameters are not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: