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) –

        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) –

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException