:doc:`DataSync <../../datasync>` / Client / describe_agent

**************
describe_agent
**************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgent>`_  


  **Request Syntax**
  ::

    response = client.describe_agent(
        AgentArn='string'
    )
    
  :type AgentArn: string
  :param AgentArn: **[REQUIRED]** 

    Specifies the Amazon Resource Name (ARN) of the DataSync agent that you want information about.

    

  
  
  :rtype: 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'|'FIPS_PRIVATE_LINK',
          '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? <https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline>`__
        

        
      

      - **LastConnectionTime** *(datetime) --* 

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

        
      

      - **CreationTime** *(datetime) --* 

        The time that the agent was `activated <https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html>`__.

        
      

      - **EndpointType** *(string) --* 

        The type of `service endpoint <https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html>`__ that your agent is connected to.

        
      

      - **PrivateLinkConfig** *(dict) --* 

        The network configuration that the agent uses when connecting to a `VPC service endpoint <https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc>`__.

        
        

        - **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 <https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html>`__ 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**
  
  *   :py:class:`DataSync.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`DataSync.Client.exceptions.InternalException`

  