ApplicationDiscoveryService / Client / batch_delete_agents

batch_delete_agents#

ApplicationDiscoveryService.Client.batch_delete_agents(**kwargs)#

Deletes one or more agents or collectors as specified by ID. Deleting an agent or collector does not delete the previously discovered data. To delete the data collected, use StartBatchDeleteConfigurationTask.

Request Syntax

response = client.batch_delete_agents(
    deleteAgents=[
        {
            'agentId': 'string',
            'force': True|False
        },
    ]
)

Parameters:

deleteAgents (list) –

[REQUIRED]

The list of agents to delete.

(dict) –

An object representing the agent or data collector to be deleted along with the optional configurations for error handling.
- agentId (string) – [REQUIRED]
  
  The ID of the agent or data collector to delete.
- force (boolean) –
  
  Optional flag used to force delete an agent or data collector. It is needed to delete any agent in HEALTHY/UNHEALTHY/RUNNING status. Note that deleting an agent that is actively reporting health causes it to be re-registered with a different agent ID after data collector re-connects with Amazon Web Services.

Return type:

dict

Returns:

Response Syntax

{
    'errors': [
        {
            'agentId': 'string',
            'errorMessage': 'string',
            'errorCode': 'NOT_FOUND'|'INTERNAL_SERVER_ERROR'|'AGENT_IN_USE'
        },
    ]
}

Response Structure

(dict) –
- errors (list) –
  
  A list of agent IDs that failed to delete during the deletion task, each paired with an error message.
  - (dict) –
    
    An object representing the agent or data collector that failed to delete, each containing agentId, errorMessage, and errorCode.
    - agentId (string) –
      
      The ID of the agent or data collector to delete.
    - errorMessage (string) –
      
      The description of the error that occurred for the delete failed agent.
    - errorCode (string) –
      
      The type of error that occurred for the delete failed agent. Valid status are: AGENT_IN_USE | NOT_FOUND | INTERNAL_SERVER_ERROR.

Exceptions

ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException
ApplicationDiscoveryService.Client.exceptions.InvalidParameterException
ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException
ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException