DataSync / Client / delete_agent

delete_agent#

DataSync.Client.delete_agent(**kwargs)#

Removes an DataSync agent resource from your Amazon Web Services account.

Keep in mind that this operation (which can’t be undone) doesn’t remove the agent’s virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.

Request Syntax

response = client.delete_agent(
    AgentArn='string'
)

Parameters:

AgentArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

DataSync.Client.exceptions.InvalidRequestException
DataSync.Client.exceptions.InternalException