Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1437208153.9 KB

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

post/#X-Amz-Target=InspectorService.PreviewAgents

Query parameters

maxResultsstring

Pagination limit

nextTokenstring

Pagination token

Headers

X-Amz-Target'InspectorService.PreviewAgents' required

Request body

previewAgentsArnstring required

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

nextTokenstring

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

maxResultsinteger

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.

Response

Success

nextTokenstring

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

Example response

{
  "agentPreviews": [
    {
      "agentId": "i-49113b93"
    }
  ],
  "nextToken": "1"
}