DataSync / Client / describe_agent

describe_agent#

DataSync.Client.describe_agent(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_agent(
    AgentArn='string'
)
Parameters:

AgentArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'AgentArn': 'string',
    'Name': 'string',
    'Status': 'ONLINE'|'OFFLINE',
    'LastConnectionTime': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'EndpointType': 'PUBLIC'|'PRIVATE_LINK'|'FIPS',
    'PrivateLinkConfig': {
        'VpcEndpointId': 'string',
        'PrivateLinkEndpoint': 'string',
        'SubnetArns': [
            'string',
        ],
        'SecurityGroupArns': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    DescribeAgentResponse

    • AgentArn (string) –

      The 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 DataSync.

    • CreationTime (datetime) –

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

    • EndpointType (string) –

      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.

    • PrivateLinkConfig (dict) –

      The subnet and the security group that DataSync used to access a VPC endpoint.

      • VpcEndpointId (string) –

        The ID of the VPC endpoint that is configured for an agent. An agent that is configured with a VPC endpoint will not be accessible over the public internet.

      • PrivateLinkEndpoint (string) –

        The private endpoint that is configured for an agent that has access to IP addresses in a PrivateLink. An agent that is configured with this endpoint will not be accessible over the public internet.

      • SubnetArns (list) –

        The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated in a VPC or an agent that has access to a VPC endpoint.

        • (string) –

      • SecurityGroupArns (list) –

        The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an agent activated in a VPC or an agent that has access to a VPC endpoint.

        • (string) –

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException