Skip to content

DescribeAgentResponse

Source code in docs_src/capo_datasync/types/describe_agent_response.py
class DescribeAgentResponse(TypedDict, closed=True):
    agent_arn: NotRequired["capo_datasync.types.agent_arn.AgentArn"]
    """<p>The ARN of the agent.</p>"""
    name: NotRequired["capo_datasync.types.tag_value.TagValue"]
    """<p>The name of the agent.</p>"""
    status: NotRequired["capo_datasync.types.agent_status.AgentStatus"]
    """<p>The status of the agent.</p> <ul> <li> <p>If the status is <code>ONLINE</code>, the agent is configured properly and ready to use.</p> </li> <li> <p>If the status is <code>OFFLINE</code>, 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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline">What do I do if my agent is offline?</a> </p> </li> </ul>"""
    last_connection_time: NotRequired["capo_datasync.types.time.Time"]
    """<p>The last time that the agent was communicating with the DataSync service.</p>"""
    creation_time: NotRequired["capo_datasync.types.time.Time"]
    """<p>The time that the agent was <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">activated</a>.</p>"""
    endpoint_type: NotRequired["capo_datasync.types.endpoint_type.EndpointType"]
    """<p>The type of <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html">service endpoint</a> that your agent is connected to.</p>"""
    private_link_config: NotRequired[
        "capo_datasync.types.private_link_config.PrivateLinkConfig"
    ]
    """<p>The network configuration that the agent uses when connecting to a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">VPC service endpoint</a>.</p>"""
    platform: NotRequired["capo_datasync.types.platform.Platform"]
    """<p>The platform-related details about the agent, such as the version number.</p>"""

agent_arn instance-attribute

agent_arn: NotRequired[AgentArn]

The ARN of the agent.

creation_time instance-attribute

creation_time: NotRequired[Time]

The time that the agent was activated.

endpoint_type instance-attribute

endpoint_type: NotRequired[EndpointType]

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

last_connection_time instance-attribute

last_connection_time: NotRequired[Time]

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

name instance-attribute

name: NotRequired[TagValue]

The name of the agent.

platform instance-attribute

platform: NotRequired[Platform]

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

private_link_config: NotRequired[PrivateLinkConfig]

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

status instance-attribute

status: NotRequired[AgentStatus]

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?