AWS DataSync

{'Platform': {'Version': 'string'}}

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

See also: AWS API Documentation

Request Syntax

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',
    '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.

      Warning

      Beginning December 7, 2023, we will discontinue version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, replace those agents before then to avoid data transfer or storage discovery disruptions. If you need more help, contact Amazon Web Services Support.

{'Agents': {'Platform': {'Version': 'string'}}}

Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.

With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.

ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents , that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.

See also: AWS API Documentation

Request Syntax

client.list_agents(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

Specifies the maximum number of DataSync agents to list in a response. By default, a response shows a maximum of 100 agents.

type NextToken

string

param NextToken

Specifies an opaque string that indicates the position to begin the next list of results in the response.

rtype

dict

returns

Response Syntax

{
    'Agents': [
        {
            'AgentArn': 'string',
            'Name': 'string',
            'Status': 'ONLINE'|'OFFLINE',
            'Platform': {
                'Version': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  ListAgentsResponse

  • Agents (list) --

    A list of DataSync agents in your Amazon Web Services account in the Amazon Web Services Region specified in the request. The list is ordered by the agents' Amazon Resource Names (ARNs).

    • (dict) --

      Represents a single entry in a list (or array) of DataSync agents when you call the ListAgents operation.

      • AgentArn (string) --

        The Amazon Resource Name (ARN) of a DataSync agent.

      • Name (string) --

        The name of an agent.

      • Status (string) --

        The status of an 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?

      • Platform (dict) --

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

        • Version (string) --

          The version of the DataSync agent.

          Warning

          Beginning December 7, 2023, we will discontinue version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, replace those agents before then to avoid data transfer or storage discovery disruptions. If you need more help, contact Amazon Web Services Support.

  • NextToken (string) --

    The opaque string that indicates the position to begin the next list of results in the response.