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 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
- createdAt
-
The time when StartAssessmentRun 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.
Required: Yes
- findingCounts
-
Provides a total count of generated findings per severity.
Type: String to integer map
Valid Keys:
Low | Medium | High | Informational | UndefinedRequired: 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 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
- 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 | CANCELEDRequired: Yes
- 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 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 objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
- completedAt
-
The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
Type: Timestamp
Required: No
- startedAt
-
The time when StartAssessmentRun was called.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
