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

Class: Aws::Inspector::Types::ListAssessmentRunAgentsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb

Overview

Note:

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

{
  assessment_run_arn: "Arn", # required
  filter: {
    agent_healths: ["HEALTHY"], # required, accepts HEALTHY, UNHEALTHY
    agent_health_codes: ["IDLE"], # required, accepts IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, UNKNOWN
  },
  next_token: "PaginationToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_run_arnString

The ARN that specifies the assessment run whose agents you want to list.

Returns:

  • (String)


1484
1485
1486
1487
1488
1489
1490
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1484

class ListAssessmentRunAgentsRequest < Struct.new(
  :assessment_run_arn,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#filterTypes::AgentFilter

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

Returns:



1484
1485
1486
1487
1488
1489
1490
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1484

class ListAssessmentRunAgentsRequest < Struct.new(
  :assessment_run_arn,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.

Returns:

  • (Integer)


1484
1485
1486
1487
1488
1489
1490
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1484

class ListAssessmentRunAgentsRequest < Struct.new(
  :assessment_run_arn,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Returns:

  • (String)


1484
1485
1486
1487
1488
1489
1490
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 1484

class ListAssessmentRunAgentsRequest < Struct.new(
  :assessment_run_arn,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end