AgentListEntry - AWS DataSync

Beginning December 7, 2023, we will discontinue version 1 DataSync agents. Check the Agents page on the DataSync console to see if you have affected agents. If you do, replace those agents before then to avoid data transfer or storage discovery disruptions. If you need more help, contact AWS Support.


Represents a single entry in a list (or array) of AWS DataSync agents when you call the ListAgents operation.



The Amazon Resource Name (ARN) of a DataSync agent.

Type: String

Length Constraints: Maximum length of 128.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

Required: No


The name of an agent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$

Required: No


The platform-related details about the agent, such as the version number.

Type: Platform object

Required: No


The status of an agent.

  • If the status is ONLINE, the agent is configured properly and ready to use.

  • If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?

Type: String

Valid Values: ONLINE | OFFLINE

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: