AWS DataSync

{'EndpointOptions': {'Fips': 'boolean', 'PrivateLink': 'boolean'},
 'PrivateLinkConfig': {'PrivateLinkEndpoint': 'string',
                       'SecurityGroupArns': ['string'],
                       'SubnetArns': ['string']}}

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.

See also: AWS API Documentation

Request Syntax

client.describe_agent(
    AgentArn='string'
)

type AgentArn

string

param AgentArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'AgentArn': 'string',
    'Name': 'string',
    'Status': 'ONLINE'|'OFFLINE',
    'LastConnectionTime': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'EndpointOptions': {
        'Fips': True|False,
        'PrivateLink': True|False
    },
    'PrivateLinkConfig': {
        'PrivateLinkEndpoint': 'string',
        'SubnetArns': [
            'string',
        ],
        'SecurityGroupArns': [
            'string',
        ]
    }
}

Response Structure

• (dict) --

  DescribeAgentResponse

  • AgentArn (string) --

    The Amazon Resource Name (ARN) of the agent.

  • Name (string) --

    The name of the agent.

  • Status (string) --

    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.

  • LastConnectionTime (datetime) --

    The time that the agent last connected to DataSyc.

  • CreationTime (datetime) --

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

  • EndpointOptions (dict) --

    • Fips (boolean) --

    • PrivateLink (boolean) --

  • PrivateLinkConfig (dict) --

    • PrivateLinkEndpoint (string) --

    • SubnetArns (list) --

      • (string) --

    • SecurityGroupArns (list) --

      • (string) --