Skip to content

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

Description

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

Usage

inspector_preview_agents(previewAgentsArn, nextToken, maxResults)

Arguments

  • previewAgentsArn

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

  • 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.

  • 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.

Value

A list with the following syntax:

list(
  agentPreviews = list(
    list(
      hostname = "string",
      agentId = "string",
      autoScalingGroup = "string",
      agentHealth = "HEALTHY"|"UNHEALTHY"|"UNKNOWN",
      agentVersion = "string",
      operatingSystem = "string",
      kernelVersion = "string",
      ipv4Address = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$preview_agents(
  previewAgentsArn = "string",
  nextToken = "string",
  maxResults = 123
)

Examples

# Previews the agents installed on the EC2 instances that are part of the
# specified assessment target.
svc$preview_agents(
  maxResults = 123L,
  previewAgentsArn = "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
)