listAssessmentRunAgents method

Future<ListAssessmentRunAgentsResponse> listAssessmentRunAgents({ required String assessmentRunArn, AgentFilter? filter, int? maxResults, String? nextToken, })

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

May throw InternalException. May throw InvalidInputException. May throw AccessDeniedException. May throw NoSuchEntityException.

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

Parameter filter : 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.

Parameter maxResults : 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.

Parameter nextToken : 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.

Implementation

Future<ListAssessmentRunAgentsResponse> listAssessmentRunAgents({
  required String assessmentRunArn,
  AgentFilter? filter,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(assessmentRunArn, 'assessmentRunArn');
  _s.validateStringLength(
    'assessmentRunArn',
    assessmentRunArn,
    1,
    300,
    isRequired: true,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    300,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'InspectorService.ListAssessmentRunAgents'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'assessmentRunArn': assessmentRunArn,
      if (filter != null) 'filter': filter,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return ListAssessmentRunAgentsResponse.fromJson(jsonResponse.body);
}