Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444219188.6 KB

Returns metadata about an DataSync agent, such as its name, endpoint type, and status.

post/#X-Amz-Target=FmrsService.DescribeAgent

Headers

X-Amz-Target'FmrsService.DescribeAgent' required

Request body

AgentArnstring required

Specifies the Amazon Resource Name (ARN) of the DataSync agent to describe.

Response

Success

AgentArnstring

The ARN of the agent.

Namestring

The name of the agent.

Status'ONLINE' | 'OFFLINE'

The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.

LastConnectionTimestring date-time

The time that the agent last connected to DataSync.

CreationTimestring date-time

The time that the agent was activated (that is, created in your account).

EndpointType'PUBLIC' | 'PRIVATE_LINK' | 'FIPS'

The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.