String message
Confirmation details of the action performed.
String agentId
The EC2 instance ID where the agent is installed.
String assessmentArn
The ARN of the assessment that is associated with the agent.
String agentHealth
The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.
String agentHealthCode
The detailed health state of the agent. Values can be set to RUNNING, HEALTHY, UNHEALTHY, UNKNOWN, BLACKLISTED, SHUTDOWN, THROTTLED.
String agentHealthDetails
The description for the agent health code.
String autoScalingGroup
This data type property is currently not used.
String accountId
AWS account of the EC2 instance where the agent is installed.
List<E> telemetry
The Inspector application data metrics collected by the agent.
List<E> applicationNamePatterns
For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the applicationName property of the Application data type.
String assessmentArn
The ARN of the assessment.
String assessmentName
The name of the assessment.
String applicationArn
The ARN of the application that corresponds to this assessment.
String assessmentState
The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.
String failureMessage
This data type property is not currently used.
Boolean dataCollected
Boolean value (true or false) specifying whether the data collection process is completed.
Date startTime
The assessment start time.
Date endTime
The assessment end time.
Integer durationInSeconds
The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
List<E> userAttributesForFindings
The user-defined attributes that are assigned to every generated finding.
List<E> assessmentNamePatterns
For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the assessmentName property of the Assessment data type.
List<E> assessmentStates
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the assessmentState property of the Assessment data type.
Boolean dataCollected
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the dataCollected property of the Assessment data type.
TimestampRange startTimeRange
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 startTime property of the Assessment data type.
TimestampRange endTimeRange
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 endTime property of the Assessment 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 Assessment data type.
String message
Confirmation details of the action performed.
String applicationArn
The ARN specifying the application that is created.
String applicationArn
The ARN specifying the application for which you want to create an assessment.
String assessmentName
The user-defined name identifying the assessment that you want to create. You can create several assessments for an application. The names of the assessments corresponding to a particular application must be unique.
Integer durationInSeconds
The duration of the assessment in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
List<E> userAttributesForFindings
The user-defined attributes that are assigned to every finding generated by running this assessment.
String assessmentArn
The ARN specifying the assessment that is created.
String resourceGroupTags
A collection of keys and an array of possible values in JSON format.
For example, [{"key":"key1","values":["Value1","Value2"]},{"key":"Key2","values" :["Value3"]}]
String resourceGroupArn
The ARN specifying the resource group that is created.
String applicationArn
The ARN specifying the application that you want to delete.
String message
Confirmation details of the action performed.
String assessmentArn
The ARN specifying the assessment that you want to delete.
String message
Confirmation details of the action performed.
String runArn
The ARN specifying the assessment run that you want to delete.
String message
Confirmation details of the action performed.
String applicationArn
The ARN specifying the application that you want to describe.
Application application
Information about the application.
String assessmentArn
The ARN specifying the assessment that you want to describe.
Assessment assessment
Information about the assessment.
String findingArn
The ARN specifying the finding that you want to describe.
Finding finding
Information about the finding.
String resourceGroupArn
The ARN specifying the resource group that you want to describe.
ResourceGroup resourceGroup
Information about the resource group.
String rulesPackageArn
The ARN specifying the rules package that you want to describe.
RulesPackage rulesPackage
Information about the rules package.
String runArn
The ARN specifying the assessment run that you want to describe.
Run run
Information about the assessment run.
String message
Confirmation details of the action performed.
String findingArn
The ARN specifying the finding.
String runArn
The ARN of the assessment run that generated the finding.
String rulesPackageArn
The ARN of the rules package that is used to generate the finding.
String ruleName
The rule name that is used to generate the finding.
String agentId
The EC2 instance ID where the agent is installed that is used during the assessment that generates the finding.
String autoScalingGroup
The autoscaling group of the EC2 instance where the agent is installed that is used during the assessment that generates the finding.
String severity
The finding severity. Values can be set to High, Medium, Low, and Informational.
LocalizedText finding
A short description that identifies the finding.
LocalizedText description
The description of the finding.
LocalizedText recommendation
The recommendation for the finding.
List<E> attributes
The system-defined attributes for the finding.
List<E> userAttributes
The user-defined attributes that are assigned to the finding.
List<E> rulesPackageArns
For a record to match a filter, the value 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> ruleNames
For a record to match a filter, the value 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, the value 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> attributes
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the attributes property of the Finding data type.
List<E> userAttributes
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the userAttributes property of the Finding data type.
String assessmentArn
The ARN specifying the assessment the telemetry of which you want to obtain.
ApplicationsFilter 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 ListApplications action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from 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> applicationArnList
A list of ARNs specifying the applications 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 assessmentArn
The ARN specifying the assessment whose agents you want to list.
AgentsFilter 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 ListAssessmentAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from 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> agentList
A list of ARNs specifying 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> applicationArns
A list of ARNs specifying the applications the assessments of which you want to list.
AssessmentsFilter 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 ListAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from 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> assessmentArnList
A list of ARNs specifying the assessments 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 rulesPackageArn
The ARN specifying the rules package whose assessments you want to list.
AssessmentsFilter 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 ListAttachedAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from 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> assessmentArnList
A list of ARNs specifying the assessments 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 assessmentArn
The ARN specifying the assessment whose rules packages 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 ListAttachedRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from 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> rulesPackageArnList
A list of ARNs specifying 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'.
List<E> runArns
The ARNs of the assessment runs that generate the findings that you want to list.
FindingsFilter 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 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> findingArnList
A list of ARNs specifying 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 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> rulesPackageArnList
The list of ARNs specifying 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'.
List<E> assessmentArns
The ARNs specifying the assessments whose runs you want to list.
RunsFilter 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 ListRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from 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> runArnList
A list of ARNs specifying the assessment runs 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 specifying the resource whose tags you want to list.
LocalizedTextKey key
The facility and id properties of the LocalizedTextKey data type.
List<E> parameters
Values for the dynamic elements of the string specified by the textual identifier.
String messageType
A specific type of behavioral data that is collected by the agent.
Long count
The number of times that the behavioral data is collected by the agent during an assessment.
Long dataSize
The total size of the behavioral data that is collected by the agent during an assessment.
String resourceGroupArn
The ARN of the resource group that is used to create an application.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the PreviewAgentsForResourceGroup action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from 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> agentPreviewList
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
String message
Confirmation details of the action performed.
String message
Confirmation details of the action performed.
String resourceGroupArn
The ARN of the resource group.
String resourceGroupTags
The tags (key and value pairs) of the resource group.
This data type property is used in the CreateResourceGroup action.
A collection of keys and an array of possible values in JSON format.
For example, [{ "key1" : ["Value1","Value2"]},{"Key2": ["Value3"]}]
String rulesPackageArn
The ARN of the rules package.
String rulesPackageName
The name of the rules package.
String version
The version id of the rules package.
String provider
The provider of the rules package.
LocalizedText description
The description of the rules package.
String runArn
The ARN of the run.
String runName
The auto-generated name for the run.
String assessmentArn
The ARN of the assessment that is associated with the run.
String runState
The state of the run. Values can be set to DataCollectionComplete, EvaluatingPolicies, EvaluatingPoliciesErrorCanRetry, Completed, Failed, TombStoned.
List<E> rulesPackages
Rules packages selected for the run of the assessment.
Date creationTime
Run creation time that corresponds to the data collection completion time or failure.
Date completionTime
Run completion time that corresponds to the rules packages evaluation completion time or failure.
String runArn
The ARN specifying the run of the assessment.
List<E> runNamePatterns
For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the runName property of the Run data type.
List<E> runStates
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the runState property of the Run data type.
List<E> rulesPackages
For a record to match a filter, the value specified for this data type property must match a list of values of the rulesPackages property of the Run data type.
TimestampRange creationTime
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 creationTime property of the Run data type.
TimestampRange completionTime
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 completionTime property of the Run data type.
String message
Confirmation details of the action performed.
String assessmentArn
The ARN of the assessment for which you want to start the data collection process.
String message
Confirmation details of the action performed.
String assessmentArn
The ARN of the assessment for which you want to stop the data collection process.
String message
Confirmation details of the action performed.
String message
Confirmation details of the action performed.
String assessmentArn
Asessment ARN that you want to update.
String assessmentName
Assessment name that you want to update.
Integer durationInSeconds
Assessment duration in seconds that you want to update. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
String message
Confirmation details of the action performed.
Copyright © 2015. All rights reserved.