Class: Aws::DataSync::Types::AgentListEntry

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

Overview

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

[1]: docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_arn ⇒ String

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

Returns:

  • (String) 


129
130
131
132
133
134
135
136
 
# File 'lib/aws-sdk-datasync/types.rb', line 129

class AgentListEntry < Struct.new(
  :agent_arn,
  :name,
  :status,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of an agent.

Returns:

  • (String) 


129
130
131
132
133
134
135
136
 
# File 'lib/aws-sdk-datasync/types.rb', line 129

class AgentListEntry < Struct.new(
  :agent_arn,
  :name,
  :status,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ Types::Platform

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

Returns:



129
130
131
132
133
134
135
136
 
# File 'lib/aws-sdk-datasync/types.rb', line 129

class AgentListEntry < Struct.new(
  :agent_arn,
  :name,
  :status,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end

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

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

Returns:

  • (String) 


129
130
131
132
133
134
135
136
 
# File 'lib/aws-sdk-datasync/types.rb', line 129

class AgentListEntry < Struct.new(
  :agent_arn,
  :name,
  :status,
  :platform)
  SENSITIVE = []
  include Aws::Structure
end