The Amazon Inspector API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• AgentAlreadyRunningAssessment (p. 128)
AgentAlreadyRunningAssessment
AgentAlreadyRunningAssessment
Used in the exception error that is thrown if you start an assessment run for an assessment target that includes an EC2 instance that is already participating in another started assessment run.
Contents
agentId
ID of the agent that is running on an EC2 instance that is already participating in another started assessment run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes assessmentRunArn
The ARN of the assessment run that has already been started.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AgentFilter
AgentFilter
Contains information about an Amazon Inspector Classic agent. This data type is used as a request parameter in the ListAssessmentRunAgents (p. 65) action.
Contents
agentHealthCodes
The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Valid Values: IDLE | RUNNING | SHUTDOWN | UNHEALTHY | THROTTLED | UNKNOWN Required: Yes
agentHealths
The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Valid Values: HEALTHY | UNHEALTHY | UNKNOWN Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AgentPreview
AgentPreview
Used as a response element in the PreviewAgents (p. 99) action.
Contents
agentHealth
The health status of the Amazon Inspector Classic Agent.
Type: String
Valid Values: HEALTHY | UNHEALTHY | UNKNOWN Required: No
agentId
The ID of the EC2 instance where the agent is installed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes agentVersion
The version of the Amazon Inspector Classic Agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No autoScalingGroup
The Auto Scaling group for the EC2 instance where the agent is installed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No hostname
The hostname of the EC2 instance on which the Amazon Inspector Classic Agent is installed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No ipv4Address
The IP address of the EC2 instance on which the Amazon Inspector Classic Agent is installed.
Type: String
Length Constraints: Minimum length of 7. Maximum length of 15.
See Also
Required: No kernelVersion
The kernel version of the operating system running on the EC2 instance on which the Amazon Inspector Classic Agent is installed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No operatingSystem
The operating system running on the EC2 instance on which the Amazon Inspector Classic Agent is installed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AssessmentRun
AssessmentRun
A snapshot of an Amazon Inspector Classic assessment run that contains the findings of the assessment run .
Used as the response element in the DescribeAssessmentRuns (p. 27) action.
Contents
arn
The ARN of the assessment run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes assessmentTemplateArn
The ARN of the assessment template that is associated with the assessment run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes completedAt
The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
Type: Timestamp Required: No createdAt
The time when StartAssessmentRun (p. 112) was called.
Type: Timestamp Required: Yes dataCollected
A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
Type: Boolean Required: Yes durationInSeconds
The duration of the assessment run.
Type: Integer
Valid Range: Minimum value of 180. Maximum value of 86400.
Contents
Required: Yes findingCounts
Provides a total count of generated findings per severity.
Type: String to integer map
Valid Keys: Low | Medium | High | Informational | Undefined Required: Yes
name
The auto-generated name for the assessment run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Required: Yes notifications
A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.
Type: Array of AssessmentRunNotification (p. 139) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: Yes rulesPackageArns
The rules packages selected for the assessment run.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes startedAt
The time when StartAssessmentRun (p. 112) was called.
Type: Timestamp Required: No state
The state of the assessment run.
Type: String
Valid Values: CREATED | START_DATA_COLLECTION_PENDING | START_DATA_COLLECTION_IN_PROGRESS | COLLECTING_DATA
| STOP_DATA_COLLECTION_PENDING | DATA_COLLECTED |
START_EVALUATING_RULES_PENDING | EVALUATING_RULES | FAILED | ERROR | COMPLETED | COMPLETED_WITH_ERRORS | CANCELED
Required: Yes
See Also
stateChangedAt
The last time when the assessment run's state changed.
Type: Timestamp Required: Yes stateChanges
A list of the assessment run state changes.
Type: Array of AssessmentRunStateChange (p. 141) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: Yes
userAttributesForFindings
The user-defined attributes that are assigned to every generated finding.
Type: Array of Attribute (p. 150) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AssessmentRunAgent
AssessmentRunAgent
Contains information about an Amazon Inspector Classic agent. This data type is used as a response element in the ListAssessmentRunAgents (p. 65) action.
Contents
agentHealth
The current health state of the agent.
Type: String
Valid Values: HEALTHY | UNHEALTHY | UNKNOWN Required: Yes
agentHealthCode
The detailed health state of the agent.
Type: String
Valid Values: IDLE | RUNNING | SHUTDOWN | UNHEALTHY | THROTTLED | UNKNOWN Required: Yes
agentHealthDetails
The description for the agent health code.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: No agentId
The AWS account of the EC2 instance where the agent is installed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes assessmentRunArn
The ARN of the assessment run that is associated with the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes autoScalingGroup
The Auto Scaling group of the EC2 instance that is specified by the agent ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
See Also
Required: No telemetryMetadata
The Amazon Inspector Classic application data metrics that are collected by the agent.
Type: Array of TelemetryMetadata (p. 175) objects
Array Members: Minimum number of 0 items. Maximum number of 5000 items.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AssessmentRunFilter
AssessmentRunFilter
Used as the request parameter in the ListAssessmentRuns (p. 71) action.
Contents
completionTimeRange
For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completedAt property of the AssessmentRun (p. 132) data type.
Type: TimestampRange (p. 176) object Required: No
durationRange
For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentRun (p. 132) data type.
Type: DurationRange (p. 151) object Required: No
namePattern
For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun (p. 132) data type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Required: No rulesPackageArns
For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the rulesPackages property of the AssessmentRun (p. 132) data type.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No startTimeRange
For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the AssessmentRun (p. 132) data type.
Type: TimestampRange (p. 176) object Required: No
See Also
stateChangeTimeRange
For a record to match a filter, the value that is specified for this data type property must match the stateChangedAt property of the AssessmentRun (p. 132) data type.
Type: TimestampRange (p. 176) object Required: No
states
For a record to match a filter, one of the values specified for this data type property must be the exact match of the value of the assessmentRunState property of the AssessmentRun (p. 132) data type.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Valid Values: CREATED | START_DATA_COLLECTION_PENDING | START_DATA_COLLECTION_IN_PROGRESS | COLLECTING_DATA
| STOP_DATA_COLLECTION_PENDING | DATA_COLLECTED |
START_EVALUATING_RULES_PENDING | EVALUATING_RULES | FAILED | ERROR | COMPLETED | COMPLETED_WITH_ERRORS | CANCELED
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3