Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
list-assessment-run-agents¶
Description¶
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
See also: AWS API Documentation
list-assessment-run-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: assessmentRunAgents
Synopsis¶
list-assessment-run-agents
--assessment-run-arn <value>
[--filter <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--assessment-run-arn (string)
The ARN that specifies the assessment run whose agents you want to list.
--filter (structure)
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.
agentHealths -> (list)
The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY .
(string)
agentHealthCodes -> (list)
The detailed health state of the agent. Values can be set to IDLE , RUNNING , SHUTDOWN , UNHEALTHY , THROTTLED , and UNKNOWN .
(string)
Shorthand Syntax:
agentHealths=string,string,agentHealthCodes=string,string
JSON Syntax:
{
"agentHealths": ["HEALTHY"|"UNHEALTHY"|"UNKNOWN", ...],
"agentHealthCodes": ["IDLE"|"RUNNING"|"SHUTDOWN"|"UNHEALTHY"|"THROTTLED"|"UNKNOWN", ...]
}
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom 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
NextTokenis provided in the command's output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse 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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
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 list assessment run agents
The following list-assessment-run-agents command lists the agents of the assessment run with the specified ARN.
aws inspector list-assessment-run-agents \
--assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE
Output:
{
"assessmentRunAgents": [
{
"agentHealth": "HEALTHY",
"agentHealthCode": "HEALTHY",
"agentId": "i-49113b93",
"assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE",
"telemetryMetadata": [
{
"count": 2,
"dataSize": 345,
"messageType": "InspectorDuplicateProcess"
},
{
"count": 3,
"dataSize": 255,
"messageType": "InspectorTimeEventMsg"
},
{
"count": 4,
"dataSize": 1082,
"messageType": "InspectorNetworkInterface"
},
{
"count": 2,
"dataSize": 349,
"messageType": "InspectorDnsEntry"
},
{
"count": 11,
"dataSize": 2514,
"messageType": "InspectorDirectoryInfoMsg"
},
{
"count": 1,
"dataSize": 179,
"messageType": "InspectorTcpV6ListeningPort"
},
{
"count": 101,
"dataSize": 10949,
"messageType": "InspectorTerminal"
},
{
"count": 26,
"dataSize": 5916,
"messageType": "InspectorUser"
},
{
"count": 282,
"dataSize": 32148,
"messageType": "InspectorDynamicallyLoadedCodeModule"
},
{
"count": 18,
"dataSize": 10172,
"messageType": "InspectorCreateProcess"
},
{
"count": 3,
"dataSize": 8001,
"messageType": "InspectorProcessPerformance"
},
{
"count": 1,
"dataSize": 360,
"messageType": "InspectorOperatingSystem"
},
{
"count": 6,
"dataSize": 546,
"messageType": "InspectorStopProcess"
},
{
"count": 1,
"dataSize": 1553,
"messageType": "InspectorInstanceMetaData"
},
{
"count": 2,
"dataSize": 434,
"messageType": "InspectorTcpV4Connection"
},
{
"count": 474,
"dataSize": 2960322,
"messageType": "InspectorPackageInfo"
},
{
"count": 3,
"dataSize": 2235,
"messageType": "InspectorSystemPerformance"
},
{
"count": 105,
"dataSize": 46048,
"messageType": "InspectorCodeModule"
},
{
"count": 1,
"dataSize": 182,
"messageType": "InspectorUdpV6ListeningPort"
},
{
"count": 2,
"dataSize": 371,
"messageType": "InspectorUdpV4ListeningPort"
},
{
"count": 18,
"dataSize": 8362,
"messageType": "InspectorKernelModule"
},
{
"count": 29,
"dataSize": 48788,
"messageType": "InspectorConfigurationInfo"
},
{
"count": 1,
"dataSize": 79,
"messageType": "InspectorMonitoringStart"
},
{
"count": 5,
"dataSize": 0,
"messageType": "InspectorSplitMsgBegin"
},
{
"count": 51,
"dataSize": 4593,
"messageType": "InspectorGroup"
},
{
"count": 1,
"dataSize": 184,
"messageType": "InspectorTcpV4ListeningPort"
},
{
"count": 1159,
"dataSize": 3146579,
"messageType": "Total"
},
{
"count": 5,
"dataSize": 0,
"messageType": "InspectorSplitMsgEnd"
},
{
"count": 1,
"dataSize": 612,
"messageType": "InspectorLoadImageInProcess"
}
]
}
]
}
For more information, see AWS Agents in the Amazon Inspector User Guide.
Output¶
assessmentRunAgents -> (list)
A list of ARNs that specifies the agents returned by the action.
(structure)
Contains information about an Amazon Inspector agent. This data type is used as a response element in the ListAssessmentRunAgents action.
agentId -> (string)
The AWS account of the EC2 instance where the agent is installed.assessmentRunArn -> (string)
The ARN of the assessment run that is associated with the agent.agentHealth -> (string)
The current health state of the agent.agentHealthCode -> (string)
The detailed health state of the agent.agentHealthDetails -> (string)
The description for the agent health code.autoScalingGroup -> (string)
The Auto Scaling group of the EC2 instance that is specified by the agent ID.telemetryMetadata -> (list)
The Amazon Inspector application data metrics that are collected by the agent.
(structure)
The metadata about the Amazon Inspector application data metrics collected by the agent. This data type is used as the response element in the GetTelemetryMetadata action.
messageType -> (string)
A specific type of behavioral data that is collected by the agent.count -> (long)
The count of messages that the agent sends to the Amazon Inspector service.dataSize -> (long)
The data size of messages that the agent sends to the Amazon Inspector service.
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.