[ aws . inspector ]

preview-agents

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

preview-agents is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: agentPreviews

Synopsis

  preview-agents
--preview-agents-arn <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--preview-agents-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To preview agents

The following preview-agents command previews the agents installed on the EC2 instances that are part of the assessment target with the ARN of arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq:

aws inspector preview-agents --preview-agents-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq

Output:

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

For more information, see Amazon Inspector Assessment Targets in the Amazon Inspector guide.

Output

agentPreviews -> (list)

The resulting list of agents.

(structure)

Used as a response element in the PreviewAgents action.

hostname -> (string)

The hostname of the EC2 instance on which the Amazon Inspector Agent is installed.

agentId -> (string)

The ID of the EC2 instance where the agent is installed.

autoScalingGroup -> (string)

The Auto Scaling group for the EC2 instance where the agent is installed.

agentHealth -> (string)

The health status of the Amazon Inspector Agent.

agentVersion -> (string)

The version of the Amazon Inspector Agent.

operatingSystem -> (string)

The operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.

kernelVersion -> (string)

The kernel version of the operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.

ipv4Address -> (string)

The IP address of the EC2 instance on which the Amazon Inspector Agent is installed.

nextToken -> (string)

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 nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.