DataSync / Client / describe_agent

describe_agent#

DataSync.Client.describe_agent(**kwargs)#

Returns information about an DataSync agent, such as its name, service 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 that you want information about.

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',
        ]
    },
    'Platform': {
        'Version': '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, 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?

    • LastConnectionTime (datetime) –

      The last time that the agent was communicating with the DataSync service.

    • CreationTime (datetime) –

      The time that the agent was activated.

    • EndpointType (string) –

      The type of service endpoint that your agent is connected to.

    • PrivateLinkConfig (dict) –

      The network configuration that the agent uses when connecting to a VPC service endpoint.

      • VpcEndpointId (string) –

        Specifies the ID of the VPC endpoint that your agent connects to.

      • PrivateLinkEndpoint (string) –

        Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.

      • SubnetArns (list) –

        Specifies the ARN of the subnet where your VPC endpoint is located. You can only specify one ARN.

        • (string) –

      • SecurityGroupArns (list) –

        Specifies the Amazon Resource Names (ARN) of the security group that provides DataSync access to your VPC endpoint. You can only specify one ARN.

        • (string) –

    • Platform (dict) –

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

      • Version (string) –

        The version of the DataSync agent.

Exceptions