Class: Aws::DataSync::Types::DescribeAgentResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-datasync/types.rb

Overview

DescribeAgentResponse

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_arn ⇒ String

The ARN of the agent.

Returns:

  • (String) 


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/aws-sdk-datasync/types.rb', line 1553

class DescribeAgentResponse < Struct.new(
  :agent_arn,
  :name,
  :status,
  :last_connection_time,
  :creation_time,
  :endpoint_type,
  :private_link_config,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time that the agent was [activated].

[1]: docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html

Returns:

  • (Time) 


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/aws-sdk-datasync/types.rb', line 1553

class DescribeAgentResponse < Struct.new(
  :agent_arn,
  :name,
  :status,
  :last_connection_time,
  :creation_time,
  :endpoint_type,
  :private_link_config,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_type ⇒ String

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

[1]: docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html

Returns:

  • (String) 


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/aws-sdk-datasync/types.rb', line 1553

class DescribeAgentResponse < Struct.new(
  :agent_arn,
  :name,
  :status,
  :last_connection_time,
  :creation_time,
  :endpoint_type,
  :private_link_config,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

#last_connection_time ⇒ Time

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

Returns:

  • (Time) 


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/aws-sdk-datasync/types.rb', line 1553

class DescribeAgentResponse < Struct.new(
  :agent_arn,
  :name,
  :status,
  :last_connection_time,
  :creation_time,
  :endpoint_type,
  :private_link_config,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the agent.

Returns:

  • (String) 


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/aws-sdk-datasync/types.rb', line 1553

class DescribeAgentResponse < Struct.new(
  :agent_arn,
  :name,
  :status,
  :last_connection_time,
  :creation_time,
  :endpoint_type,
  :private_link_config,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ Types::Platform

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

Returns:



1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/aws-sdk-datasync/types.rb', line 1553

class DescribeAgentResponse < Struct.new(
  :agent_arn,
  :name,
  :status,
  :last_connection_time,
  :creation_time,
  :endpoint_type,
  :private_link_config,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

#private_link_config ⇒ Types::PrivateLinkConfig

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

[1]: docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc

Returns:



1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/aws-sdk-datasync/types.rb', line 1553

class DescribeAgentResponse < Struct.new(
  :agent_arn,
  :name,
  :status,
  :last_connection_time,
  :creation_time,
  :endpoint_type,
  :private_link_config,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

#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?]

[1]: docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline

Returns:

  • (String) 


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/aws-sdk-datasync/types.rb', line 1553

class DescribeAgentResponse < Struct.new(
  :agent_arn,
  :name,
  :status,
  :last_connection_time,
  :creation_time,
  :endpoint_type,
  :private_link_config,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end