You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Inspector::Types::AgentFilter

Inherits:

Struct

Object
Struct
Aws::Inspector::Types::AgentFilter

show all

Defined in:: gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb

Overview

Note:

When making an API call, you may pass AgentFilter data as a hash:

{
  agent_healths: ["HEALTHY"], # required, accepts HEALTHY, UNHEALTHY, UNKNOWN
  agent_health_codes: ["IDLE"], # required, accepts IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, UNKNOWN
}

Contains information about an Amazon Inspector agent. This data type is used as a request parameter in the ListAssessmentRunAgents action.

Instance Attribute Summary collapse

#agent_health_codes ⇒ Array<String>
The detailed health state of the agent.
#agent_healths ⇒ Array<String>
The current health state of the agent.

Instance Attribute Details

#agent_health_codes ⇒ `Array<String>`

The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.

Returns:

(Array<String>)

# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 122

class AgentFilter < Struct.new(
  :agent_healths,
  :agent_health_codes)
  include Aws::Structure
end

#agent_healths ⇒ `Array<String>`

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.