# Inspector

This page documents function available when using the Inspector module, created with @service Inspector.

### Documentation

Main.Inspector.add_attributes_to_findingsMethod
add_attributes_to_findings(attributes, finding_arns)
add_attributes_to_findings(attributes, finding_arns, params::Dict{String,<:Any})

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.

Arguments

• attributes: The array of attributes that you want to assign to specified findings.
• finding_arns: The ARNs that specify the findings that you want to assign attributes to.
source
Main.Inspector.create_assessment_targetMethod
create_assessment_target(assessment_target_name)
create_assessment_target(assessment_target_name, params::Dict{String,<:Any})

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.

Arguments

• assessment_target_name: The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
source
Main.Inspector.create_assessment_templateMethod
create_assessment_template(assessment_target_arn, assessment_template_name, duration_in_seconds, rules_package_arns)
create_assessment_template(assessment_target_arn, assessment_template_name, duration_in_seconds, rules_package_arns, params::Dict{String,<:Any})

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.

Arguments

• assessment_target_arn: The ARN that specifies the assessment target for which you want to create the assessment template.
• assessment_template_name: 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.
• duration_in_seconds: The duration of the assessment run in seconds.
• rules_package_arns: The ARNs that specify the rules packages that you want to attach to the assessment template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
source
Main.Inspector.create_exclusions_previewMethod
create_exclusions_preview(assessment_template_arn)
create_exclusions_preview(assessment_template_arn, params::Dict{String,<:Any})

Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.

Arguments

• assessment_template_arn: The ARN that specifies the assessment template for which you want to create an exclusions preview.
source
Main.Inspector.create_resource_groupMethod
create_resource_group(resource_group_tags)
create_resource_group(resource_group_tags, params::Dict{String,<:Any})

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.

Arguments

• resource_group_tags: A collection of keys and an array of possible values, '[{"key":"key1","values":["Value1","Value2"]},{"key":"Key2","values":["Valu e3"]}]'. For example,'[{"key":"Name","values":["TestEC2Instance"]}]'.
source
Main.Inspector.delete_assessment_runMethod
delete_assessment_run(assessment_run_arn)
delete_assessment_run(assessment_run_arn, params::Dict{String,<:Any})

Deletes the assessment run that is specified by the ARN of the assessment run.

Arguments

• assessment_run_arn: The ARN that specifies the assessment run that you want to delete.
source
Main.Inspector.delete_assessment_targetMethod
delete_assessment_target(assessment_target_arn)
delete_assessment_target(assessment_target_arn, params::Dict{String,<:Any})

Deletes the assessment target that is specified by the ARN of the assessment target.

Arguments

• assessment_target_arn: The ARN that specifies the assessment target that you want to delete.
source
Main.Inspector.delete_assessment_templateMethod
delete_assessment_template(assessment_template_arn)
delete_assessment_template(assessment_template_arn, params::Dict{String,<:Any})

Deletes the assessment template that is specified by the ARN of the assessment template.

Arguments

• assessment_template_arn: The ARN that specifies the assessment template that you want to delete.
source
Main.Inspector.describe_assessment_runsMethod
describe_assessment_runs(assessment_run_arns)
describe_assessment_runs(assessment_run_arns, params::Dict{String,<:Any})

Describes the assessment runs that are specified by the ARNs of the assessment runs.

Arguments

• assessment_run_arns: The ARN that specifies the assessment run that you want to describe.
source
Main.Inspector.describe_assessment_targetsMethod
describe_assessment_targets(assessment_target_arns)
describe_assessment_targets(assessment_target_arns, params::Dict{String,<:Any})

Describes the assessment targets that are specified by the ARNs of the assessment targets.

Arguments

• assessment_target_arns: The ARNs that specifies the assessment targets that you want to describe.
source
Main.Inspector.describe_assessment_templatesMethod
describe_assessment_templates(assessment_template_arns)
describe_assessment_templates(assessment_template_arns, params::Dict{String,<:Any})

Describes the assessment templates that are specified by the ARNs of the assessment templates.

Arguments

• assessment_template_arns:
source
Main.Inspector.describe_exclusionsMethod
describe_exclusions(exclusion_arns)
describe_exclusions(exclusion_arns, params::Dict{String,<:Any})

Describes the exclusions that are specified by the exclusions' ARNs.

Arguments

• exclusion_arns: The list of ARNs that specify the exclusions that you want to describe.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "locale": The locale into which you want to translate the exclusion's title, description, and recommendation.
source
Main.Inspector.describe_findingsMethod
describe_findings(finding_arns)
describe_findings(finding_arns, params::Dict{String,<:Any})

Describes the findings that are specified by the ARNs of the findings.

Arguments

• finding_arns: The ARN that specifies the finding that you want to describe.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "locale": The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding.
source
Main.Inspector.describe_resource_groupsMethod
describe_resource_groups(resource_group_arns)
describe_resource_groups(resource_group_arns, params::Dict{String,<:Any})

Describes the resource groups that are specified by the ARNs of the resource groups.

Arguments

• resource_group_arns: The ARN that specifies the resource group that you want to describe.
source
Main.Inspector.describe_rules_packagesMethod
describe_rules_packages(rules_package_arns)
describe_rules_packages(rules_package_arns, params::Dict{String,<:Any})

Describes the rules packages that are specified by the ARNs of the rules packages.

Arguments

• rules_package_arns: The ARN that specifies the rules package that you want to describe.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "locale": The locale that you want to translate a rules package description into.
source
Main.Inspector.get_assessment_reportMethod
get_assessment_report(assessment_run_arn, report_file_format, report_type)
get_assessment_report(assessment_run_arn, report_file_format, report_type, params::Dict{String,<:Any})

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

Arguments

• assessment_run_arn: The ARN that specifies the assessment run for which you want to generate a report.
• report_file_format: Specifies the file format (html or pdf) of the assessment report that you want to generate.
• report_type: 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.
source
Main.Inspector.get_exclusions_previewMethod
get_exclusions_preview(assessment_template_arn, preview_token)
get_exclusions_preview(assessment_template_arn, preview_token, params::Dict{String,<:Any})

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

Arguments

• assessment_template_arn: The ARN that specifies the assessment template for which the exclusions preview was requested.
• preview_token: The unique identifier associated of the exclusions preview.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "locale": The locale into which you want to translate the exclusion's title, description, and recommendation.
• "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.
• "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.
source
Main.Inspector.get_telemetry_metadataMethod
get_telemetry_metadata(assessment_run_arn)
get_telemetry_metadata(assessment_run_arn, params::Dict{String,<:Any})

Information about the data that is collected for the specified assessment run.

Arguments

• assessment_run_arn: The ARN that specifies the assessment run that has the telemetry data that you want to obtain.
source
Main.Inspector.list_assessment_run_agentsMethod
list_assessment_run_agents(assessment_run_arn)
list_assessment_run_agents(assessment_run_arn, params::Dict{String,<:Any})

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

Arguments

• assessment_run_arn: The ARN that specifies the assessment run whose agents you want to list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "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.
• "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.
source
Main.Inspector.list_assessment_runsMethod
list_assessment_runs()
list_assessment_runs(params::Dict{String,<:Any})

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "assessmentTemplateArns": The ARNs that specify the assessment templates whose assessment runs you want to list.
• "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.
• "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.
• "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.
source
Main.Inspector.list_assessment_targetsMethod
list_assessment_targets()
list_assessment_targets(params::Dict{String,<:Any})

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "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.
• "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.
source
Main.Inspector.list_assessment_templatesMethod
list_assessment_templates()
list_assessment_templates(params::Dict{String,<:Any})

Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "assessmentTargetArns": A list of ARNs that specifies the assessment targets whose assessment templates you want to list.
• "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.
• "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.
• "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.
source
Main.Inspector.list_event_subscriptionsMethod
list_event_subscriptions()
list_event_subscriptions(params::Dict{String,<:Any})

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "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.
• "resourceArn": The ARN of the assessment template for which you want to list the existing event subscriptions.
source
Main.Inspector.list_exclusionsMethod
list_exclusions(assessment_run_arn)
list_exclusions(assessment_run_arn, params::Dict{String,<:Any})

List exclusions that are generated by the assessment run.

Arguments

• assessment_run_arn: The ARN of the assessment run that generated the exclusions that you want to list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "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.
source
Main.Inspector.list_findingsMethod
list_findings()
list_findings(params::Dict{String,<:Any})

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "assessmentRunArns": The ARNs of the assessment runs that generate the findings that you want to list.
• "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.
• "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.
• "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.
source
Main.Inspector.list_rules_packagesMethod
list_rules_packages()
list_rules_packages(params::Dict{String,<:Any})

Lists all available Amazon Inspector rules packages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "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.
source
Main.Inspector.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists all tags associated with an assessment template.

Arguments

• resource_arn: The ARN that specifies the assessment template whose tags you want to list.
source
Main.Inspector.preview_agentsMethod
preview_agents(preview_agents_arn)
preview_agents(preview_agents_arn, params::Dict{String,<:Any})

Previews the agents installed on the EC2 instances that are part of the specified assessment target.

Arguments

• preview_agents_arn: The ARN of the assessment target whose agents you want to preview.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "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.
source
Main.Inspector.register_cross_account_access_roleMethod
register_cross_account_access_role(role_arn)
register_cross_account_access_role(role_arn, params::Dict{String,<:Any})

Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.

Arguments

• role_arn: The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
source
Main.Inspector.remove_attributes_from_findingsMethod
remove_attributes_from_findings(attribute_keys, finding_arns)
remove_attributes_from_findings(attribute_keys, finding_arns, params::Dict{String,<:Any})

Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.

Arguments

• attribute_keys: The array of attribute keys that you want to remove from specified findings.
• finding_arns: The ARNs that specify the findings that you want to remove attributes from.
source
Main.Inspector.set_tags_for_resourceMethod
set_tags_for_resource(resource_arn)
set_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.

Arguments

• resource_arn: The ARN of the assessment template that you want to set tags to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": A collection of key and value pairs that you want to set to the assessment template.
source
Main.Inspector.start_assessment_runMethod
start_assessment_run(assessment_template_arn)
start_assessment_run(assessment_template_arn, params::Dict{String,<:Any})

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

Arguments

• assessment_template_arn: The ARN of the assessment template of the assessment run that you want to start.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
source
Main.Inspector.stop_assessment_runMethod
stop_assessment_run(assessment_run_arn)
stop_assessment_run(assessment_run_arn, params::Dict{String,<:Any})

Stops the assessment run that is specified by the ARN of the assessment run.

Arguments

• assessment_run_arn: The ARN of the assessment run that you want to stop.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "stopAction": An input option that can be set to either STARTEVALUATION or SKIPEVALUATION. STARTEVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIPEVALUATION cancels the assessment run immediately, after which no findings are generated.
source
Main.Inspector.subscribe_to_eventMethod
subscribe_to_event(event, resource_arn, topic_arn)
subscribe_to_event(event, resource_arn, topic_arn, params::Dict{String,<:Any})

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

Arguments

• event: The event for which you want to receive SNS notifications.
• resource_arn: The ARN of the assessment template that is used during the event for which you want to receive SNS notifications.
• topic_arn: The ARN of the SNS topic to which the SNS notifications are sent.
source
Main.Inspector.unsubscribe_from_eventMethod
unsubscribe_from_event(event, resource_arn, topic_arn)
unsubscribe_from_event(event, resource_arn, topic_arn, params::Dict{String,<:Any})

Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

Arguments

• event: The event for which you want to stop receiving SNS notifications.
• resource_arn: The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications.
• topic_arn: The ARN of the SNS topic to which SNS notifications are sent.
source
Main.Inspector.update_assessment_targetMethod
update_assessment_target(assessment_target_arn, assessment_target_name)
update_assessment_target(assessment_target_arn, assessment_target_name, params::Dict{String,<:Any})

Updates the assessment target that is specified by the ARN of the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

Arguments

• assessment_target_arn: The ARN of the assessment target that you want to update.
• assessment_target_name: The name of the assessment target that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "resourceGroupArn": The ARN of the resource group that is used to specify the new resource group to associate with the assessment target.
source