You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Inspector::Types::ListAssessmentRunAgentsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Inspector::Types::ListAssessmentRunAgentsRequest
- Defined in:
- (unknown)
Overview
When passing ListAssessmentRunAgentsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
assessment_run_arn: "Arn", # required
filter: {
agent_healths: ["HEALTHY"], # required, accepts HEALTHY, UNHEALTHY, UNKNOWN
agent_health_codes: ["IDLE"], # required, accepts IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, UNKNOWN
},
next_token: "PaginationToken",
max_results: 1,
}
Instance Attribute Summary collapse
-
#assessment_run_arn ⇒ String
The ARN that specifies the assessment run whose agents you want to list.
-
#filter ⇒ Types::AgentFilter
You can use this parameter to specify a subset of data to be included in the action\'s response.
-
#max_results ⇒ Integer
You can use this parameter to indicate the maximum number of items that you want in the response.
-
#next_token ⇒ String
You can use this parameter when paginating results.
Instance Attribute Details
#assessment_run_arn ⇒ String
The ARN that specifies the assessment run whose agents you want to list.
#filter ⇒ Types::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.
#max_results ⇒ Integer
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.
#next_token ⇒ String
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.