previewAgents method

Future<PreviewAgentsResponse> previewAgents({ required String previewAgentsArn, int? maxResults, String? nextToken, })

Previews the agents installed on the EC2 instances that are part of the specified assessment target.

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

Parameter previewAgentsArn : The ARN of the assessment target whose agents you want to preview.

Parameter maxResults : You can use this parameter to indicate the maximum number of items 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 PreviewAgents 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<PreviewAgentsResponse> previewAgents({
  required String previewAgentsArn,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(previewAgentsArn, 'previewAgentsArn');
  _s.validateStringLength(
    'previewAgentsArn',
    previewAgentsArn,
    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.PreviewAgents'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'previewAgentsArn': previewAgentsArn,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return PreviewAgentsResponse.fromJson(jsonResponse.body);
}