OpsWorksCM / Client / disassociate_node

disassociate_node#

OpsWorksCM.Client.disassociate_node(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_node(
    ServerName='string',
    NodeName='string',
    EngineAttributes=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ServerName (string) –

    [REQUIRED]

    The name of the server from which to disassociate the node.

  • NodeName (string) –

    [REQUIRED]

    The name of the client node.

  • EngineAttributes (list) –

    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 named default can exist.

    • (dict) –

      A name and value pair that is specific to the engine of the server.

      • Name (string) –

        The name of the engine attribute.

      • Value (string) –

        The value of the engine attribute.

Return type:

dict

Returns:

Response Syntax

{
    'NodeAssociationStatusToken': 'string'
}

Response Structure

  • (dict) –

    • NodeAssociationStatusToken (string) –

      Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the disassociation request.

Exceptions

  • OpsWorksCM.Client.exceptions.InvalidStateException

  • OpsWorksCM.Client.exceptions.ResourceNotFoundException

  • OpsWorksCM.Client.exceptions.ValidationException