delete_agent

DataSync.Client.delete_agent(**kwargs)

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.

See also: AWS API Documentation

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