String hostname
The hostname of the EC2 instance on which the Amazon Inspector Agent is installed.
String agentId
The ID of the EC2 instance where the agent is installed.
String autoScalingGroup
The Auto Scaling group for the EC2 instance where the agent is installed.
String agentHealth
The health status of the Amazon Inspector Agent.
String agentVersion
The version of the Amazon Inspector Agent.
String operatingSystem
The operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.
String kernelVersion
The kernel version of the operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.
String ipv4Address
The IP address of the EC2 instance on which the Amazon Inspector Agent is installed.
String arn
The ARN of the assessment run.
String name
The auto-generated name for the assessment run.
String assessmentTemplateArn
The ARN of the assessment template that is associated with the assessment run.
String state
The state of the assessment run.
Integer durationInSeconds
The duration of the assessment run.
List<E> rulesPackageArns
The rules packages selected for the assessment run.
List<E> userAttributesForFindings
The user-defined attributes that are assigned to every generated finding.
Date createdAt
The time when StartAssessmentRun was called.
Date startedAt
The time when StartAssessmentRun was called.
Date completedAt
The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
Date stateChangedAt
The last time when the assessment run's state changed.
Boolean dataCollected
A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
List<E> stateChanges
A list of the assessment run state changes.
List<E> notifications
A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.
Map<K,V> findingCounts
Provides a total count of generated findings per severity.
String agentId
The AWS account of the EC2 instance where the agent is installed.
String assessmentRunArn
The ARN of the assessment run that is associated with the agent.
String agentHealth
The current health state of the agent.
String agentHealthCode
The detailed health state of the agent.
String agentHealthDetails
The description for the agent health code.
String autoScalingGroup
The Auto Scaling group of the EC2 instance that is specified by the agent ID.
List<E> telemetryMetadata
The Amazon Inspector application data metrics that are collected by the agent.
String 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 data type.
List<E> 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 data type.
DurationRange 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 data type.
List<E> 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 data type.
TimestampRange 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 data type.
TimestampRange 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 data type.
TimestampRange 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 data type.
List<E> assessmentRunArns
The ARNs of the assessment runs that are currently in progress.
Boolean assessmentRunArnsTruncated
Boolean value that indicates whether the ARN list of the assessment runs is truncated.
Boolean canRetry
You can immediately retry your request.
Date date
The date of the notification.
String event
The event for which a notification is sent.
String message
The message included in the notification.
Boolean error
The Boolean value that specifies whether the notification represents an error.
String snsTopicArn
The SNS topic to which the SNS notification is sent.
String snsPublishStatusCode
The status code of the SNS notification.
String arn
The ARN that specifies the Amazon Inspector assessment target.
String name
The name of the Amazon Inspector assessment target.
String resourceGroupArn
The ARN that specifies the resource group that is associated with the assessment target.
Date createdAt
The time at which the assessment target is created.
Date updatedAt
The time at which UpdateAssessmentTarget is called.
String assessmentTargetNamePattern
For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTargetName property of the AssessmentTarget data type.
String arn
The ARN of the assessment template.
String name
The name of the assessment template.
String assessmentTargetArn
The ARN of the assessment target that corresponds to this assessment template.
Integer durationInSeconds
The duration in seconds specified for this assessment template. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
List<E> rulesPackageArns
The rules packages that are specified for this assessment template.
List<E> userAttributesForFindings
The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.
String lastAssessmentRunArn
The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template. This value exists only when the value of assessmentRunCount is greaterpa than zero.
Integer assessmentRunCount
The number of existing assessment runs associated with this assessment template. This value can be zero or a positive integer.
Date createdAt
The time at which the assessment template is created.
String namePattern
For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTemplateName property of the AssessmentTemplate data type.
DurationRange durationRange
For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentTemplate data type.
List<E> rulesPackageArns
For a record to match a filter, the values that are specified for this data type property must be contained in the list of values of the rulesPackageArns property of the AssessmentTemplate data type.
Integer schemaVersion
The schema version of this data type.
String agentId
The ID of the agent that is installed on the EC2 instance where the finding is generated.
String autoScalingGroup
The Auto Scaling group of the EC2 instance where the finding is generated.
String amiId
The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where the finding is generated.
String hostname
The hostname of the EC2 instance where the finding is generated.
List<E> ipv4Addresses
The list of IP v4 addresses of the EC2 instance where the finding is generated.
List<E> tags
The tags related to the EC2 instance where the finding is generated.
List<E> networkInterfaces
An array of the network interfaces interacting with the EC2 instance where the finding is generated.
String assessmentTargetName
The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account.
String resourceGroupArn
The ARN that specifies the resource group that is used to create the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.
String assessmentTargetArn
The ARN that specifies the assessment target that is created.
String assessmentTargetArn
The ARN that specifies the assessment target for which you want to create the assessment template.
String assessmentTemplateName
The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.
Integer durationInSeconds
The duration of the assessment run in seconds.
List<E> rulesPackageArns
The ARNs that specify the rules packages that you want to attach to the assessment template.
List<E> userAttributesForFindings
The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template. An attribute is a key and value pair (an Attribute object). Within an assessment template, each key must be unique.
String assessmentTemplateArn
The ARN that specifies the assessment template that is created.
String assessmentTemplateArn
The ARN that specifies the assessment template for which you want to create an exclusions preview.
String previewToken
Specifies the unique identifier of the requested exclusions preview. You can use the unique identifier to retrieve the exclusions preview when running the GetExclusionsPreview API.
String resourceGroupArn
The ARN that specifies the resource group that is created.
String assessmentRunArn
The ARN that specifies the assessment run that you want to delete.
String assessmentTargetArn
The ARN that specifies the assessment target that you want to delete.
String assessmentTemplateArn
The ARN that specifies the assessment template that you want to delete.
String roleArn
The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS account.
Boolean valid
A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Amazon Inspector to access your AWS account.
Date registeredAt
The date when the cross-account access role was registered.
String event
The event for which Amazon Simple Notification Service (SNS) notifications are sent.
Date subscribedAt
The time at which SubscribeToEvent is called.
String arn
The ARN that specifies the exclusion.
String title
The name of the exclusion.
String description
The description of the exclusion.
String recommendation
The recommendation for the exclusion.
List<E> scopes
The AWS resources for which the exclusion pertains.
List<E> attributes
The system-defined attributes for the exclusion.
String title
The name of the exclusion preview.
String description
The description of the exclusion preview.
String recommendation
The recommendation for the exclusion preview.
List<E> scopes
The AWS resources for which the exclusion preview pertains.
List<E> attributes
The system-defined attributes for the exclusion preview.
String arn
The ARN that specifies the finding.
Integer schemaVersion
The schema version of this data type.
String service
The data element is set to "Inspector".
InspectorServiceAttributes serviceAttributes
This data type is used in the Finding data type.
String assetType
The type of the host from which the finding is generated.
AssetAttributes assetAttributes
A collection of attributes of the host from which the finding is generated.
String id
The ID of the finding.
String title
The name of the finding.
String description
The description of the finding.
String recommendation
The recommendation for the finding.
String severity
The finding severity. Values can be set to High, Medium, Low, and Informational.
Double numericSeverity
The numeric value of the finding severity.
Integer confidence
This data element is currently not used.
Boolean indicatorOfCompromise
This data element is currently not used.
List<E> attributes
The system-defined attributes for the finding.
List<E> userAttributes
The user-defined attributes that are assigned to the finding.
Date createdAt
The time when the finding was generated.
Date updatedAt
The time when AddAttributesToFindings is called.
List<E> agentIds
For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the agentId property of the Finding data type.
List<E> autoScalingGroups
For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the autoScalingGroup property of the Finding data type.
List<E> ruleNames
For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.
List<E> severities
For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the severity property of the Finding data type.
List<E> rulesPackageArns
For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.
List<E> attributes
For a record to match a filter, the list of values that are specified for this data type property must be contained in the list of values of the attributes property of the Finding data type.
List<E> userAttributes
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 userAttributes property of the Finding data type.
TimestampRange creationTimeRange
The time range during which the finding is generated.
String assessmentRunArn
The ARN that specifies the assessment run for which you want to generate a report.
String reportFileFormat
Specifies the file format (html or pdf) of the assessment report that you want to generate.
String reportType
Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports.
String assessmentTemplateArn
The ARN that specifies the assessment template for which the exclusions preview was requested.
String previewToken
The unique identifier associated of the exclusions preview.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.
String locale
The locale into which you want to translate the exclusion's title, description, and recommendation.
String previewStatus
Specifies the status of the request to generate an exclusions preview.
List<E> exclusionPreviews
Information about the exclusions included in the preview.
String nextToken
When a response is generated, if there is more data to be listed, this parameters 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.
String assessmentRunArn
The ARN that specifies the assessment run that has the telemetry data that you want to obtain.
Boolean canRetry
You can immediately retry your request.
String assessmentRunArn
The ARN that specifies the assessment run whose agents you want to list.
AgentFilter filter
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.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.
List<E> assessmentRunAgents
A list of ARNs that specifies the agents returned by the action.
String nextToken
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.
List<E> assessmentTemplateArns
The ARNs that specify the assessment templates whose assessment runs you want to list.
AssessmentRunFilter filter
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.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.
List<E> assessmentRunArns
A list of ARNs that specifies the assessment runs that are returned by the action.
String nextToken
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.
AssessmentTargetFilter filter
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.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTargets action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Integer 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.
List<E> assessmentTargetArns
A list of ARNs that specifies the assessment targets that are returned by the action.
String nextToken
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.
List<E> assessmentTargetArns
A list of ARNs that specifies the assessment targets whose assessment templates you want to list.
AssessmentTemplateFilter filter
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.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTemplates action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Integer 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.
List<E> assessmentTemplateArns
A list of ARNs that specifies the assessment templates returned by the action.
String nextToken
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.
String resourceArn
The ARN of the assessment template for which you want to list the existing event subscriptions.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListEventSubscriptions action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Integer 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.
List<E> subscriptions
Details of the returned event subscriptions.
String nextToken
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.
String assessmentRunArn
The ARN of the assessment run that generated the exclusions that you want to list.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListExclusionsRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.
List<E> exclusionArns
A list of exclusions' ARNs returned by the action.
String nextToken
When a response is generated, if there is more data to be listed, this parameters 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.
List<E> assessmentRunArns
The ARNs of the assessment runs that generate the findings that you want to list.
FindingFilter filter
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.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Integer 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.
List<E> findingArns
A list of ARNs that specifies the findings returned by the action.
String nextToken
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.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Integer 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.
List<E> rulesPackageArns
The list of ARNs that specifies the rules packages returned by the action.
String nextToken
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.
String resourceArn
The ARN that specifies the assessment template whose tags you want to list.
String networkInterfaceId
The ID of the network interface.
String subnetId
The ID of a subnet associated with the network interface.
String vpcId
The ID of a VPC associated with the network interface.
String privateDnsName
The name of a private DNS associated with the network interface.
String privateIpAddress
The private IP address associated with the network interface.
List<E> privateIpAddresses
A list of the private IP addresses associated with the network interface. Includes the privateDnsName and privateIpAddress.
String publicDnsName
The name of a public DNS associated with the network interface.
String publicIp
The public IP address from which the network interface is reachable.
List<E> ipv6Addresses
The IP addresses associated with the network interface.
List<E> securityGroups
A list of the security groups associated with the network interface. Includes the groupId and groupName.
String previewAgentsArn
The ARN of the assessment target whose agents you want to preview.
String 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.
Integer 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.
List<E> agentPreviews
The resulting list of agents.
String nextToken
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.
String roleArn
The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
String arn
The ARN of the resource group.
List<E> tags
The tags (key and value pairs) of the resource group. This data type property is used in the CreateResourceGroup action.
Date createdAt
The time at which resource group is created.
Boolean canRetry
You can wait and then retry your request.
String assessmentTemplateArn
The ARN of the assessment template of the assessment run that you want to start.
String assessmentRunName
You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is used to start the assessment run.
String assessmentRunArn
The ARN of the assessment run that has been started.
String assessmentRunArn
The ARN of the assessment run that you want to stop.
String stopAction
An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.
String resourceArn
The ARN of the assessment template that is used during the event for which you want to receive SNS notifications.
String event
The event for which you want to receive SNS notifications.
String topicArn
The ARN of the SNS topic to which the SNS notifications are sent.
String resourceArn
The ARN of the assessment template that is used during the event for which the SNS notification is sent.
String topicArn
The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS notifications are sent.
List<E> eventSubscriptions
The list of existing event subscriptions.
String resourceArn
The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications.
String event
The event for which you want to stop receiving SNS notifications.
String topicArn
The ARN of the SNS topic to which SNS notifications are sent.
Boolean canRetry
String assessmentTargetArn
The ARN of the assessment target that you want to update.
String assessmentTargetName
The name of the assessment target that you want to update.
String resourceGroupArn
The ARN of the resource group that is used to specify the new resource group to associate with the assessment target.
Copyright © 2025. All rights reserved.