Inspector2
This page documents function available when using the Inspector2
module, created with @service Inspector2
.
Index
Main.Inspector2.associate_member
Main.Inspector2.batch_get_account_status
Main.Inspector2.batch_get_code_snippet
Main.Inspector2.batch_get_finding_details
Main.Inspector2.batch_get_free_trial_info
Main.Inspector2.batch_get_member_ec2_deep_inspection_status
Main.Inspector2.batch_update_member_ec2_deep_inspection_status
Main.Inspector2.cancel_findings_report
Main.Inspector2.cancel_sbom_export
Main.Inspector2.create_cis_scan_configuration
Main.Inspector2.create_filter
Main.Inspector2.create_findings_report
Main.Inspector2.create_sbom_export
Main.Inspector2.delete_cis_scan_configuration
Main.Inspector2.delete_filter
Main.Inspector2.describe_organization_configuration
Main.Inspector2.disable
Main.Inspector2.disable_delegated_admin_account
Main.Inspector2.disassociate_member
Main.Inspector2.enable
Main.Inspector2.enable_delegated_admin_account
Main.Inspector2.get_cis_scan_report
Main.Inspector2.get_cis_scan_result_details
Main.Inspector2.get_configuration
Main.Inspector2.get_delegated_admin_account
Main.Inspector2.get_ec2_deep_inspection_configuration
Main.Inspector2.get_encryption_key
Main.Inspector2.get_findings_report_status
Main.Inspector2.get_member
Main.Inspector2.get_sbom_export
Main.Inspector2.list_account_permissions
Main.Inspector2.list_cis_scan_configurations
Main.Inspector2.list_cis_scan_results_aggregated_by_checks
Main.Inspector2.list_cis_scan_results_aggregated_by_target_resource
Main.Inspector2.list_cis_scans
Main.Inspector2.list_coverage
Main.Inspector2.list_coverage_statistics
Main.Inspector2.list_delegated_admin_accounts
Main.Inspector2.list_filters
Main.Inspector2.list_finding_aggregations
Main.Inspector2.list_findings
Main.Inspector2.list_members
Main.Inspector2.list_tags_for_resource
Main.Inspector2.list_usage_totals
Main.Inspector2.reset_encryption_key
Main.Inspector2.search_vulnerabilities
Main.Inspector2.send_cis_session_health
Main.Inspector2.send_cis_session_telemetry
Main.Inspector2.start_cis_session
Main.Inspector2.stop_cis_session
Main.Inspector2.tag_resource
Main.Inspector2.untag_resource
Main.Inspector2.update_cis_scan_configuration
Main.Inspector2.update_configuration
Main.Inspector2.update_ec2_deep_inspection_configuration
Main.Inspector2.update_encryption_key
Main.Inspector2.update_filter
Main.Inspector2.update_org_ec2_deep_inspection_configuration
Main.Inspector2.update_organization_configuration
Documentation
Main.Inspector2.associate_member
— Methodassociate_member(account_id)
associate_member(account_id, params::Dict{String,<:Any})
Associates an Amazon Web Services account with an Amazon Inspector delegated administrator. An HTTP 200 response indicates the association was successfully started, but doesn’t indicate whether it was completed. You can check if the association completed by using ListMembers for multiple accounts or GetMembers for a single account.
Arguments
account_id
: The Amazon Web Services account ID of the member account to be associated.
Main.Inspector2.batch_get_account_status
— Methodbatch_get_account_status()
batch_get_account_status(params::Dict{String,<:Any})
Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"accountIds"
: The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.
Main.Inspector2.batch_get_code_snippet
— Methodbatch_get_code_snippet(finding_arns)
batch_get_code_snippet(finding_arns, params::Dict{String,<:Any})
Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.
Arguments
finding_arns
: An array of finding ARNs for the findings you want to retrieve code snippets from.
Main.Inspector2.batch_get_finding_details
— Methodbatch_get_finding_details(finding_arns)
batch_get_finding_details(finding_arns, params::Dict{String,<:Any})
Gets vulnerability details for findings.
Arguments
finding_arns
: A list of finding ARNs.
Main.Inspector2.batch_get_free_trial_info
— Methodbatch_get_free_trial_info(account_ids)
batch_get_free_trial_info(account_ids, params::Dict{String,<:Any})
Gets free trial status for multiple Amazon Web Services accounts.
Arguments
account_ids
: The account IDs to get free trial status for.
Main.Inspector2.batch_get_member_ec2_deep_inspection_status
— Methodbatch_get_member_ec2_deep_inspection_status()
batch_get_member_ec2_deep_inspection_status(params::Dict{String,<:Any})
Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"accountIds"
: The unique identifiers for the Amazon Web Services accounts to retrieve Amazon Inspector deep inspection activation status for. </p>
Main.Inspector2.batch_update_member_ec2_deep_inspection_status
— Methodbatch_update_member_ec2_deep_inspection_status(account_ids)
batch_update_member_ec2_deep_inspection_status(account_ids, params::Dict{String,<:Any})
Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.
Arguments
account_ids
: The unique identifiers for the Amazon Web Services accounts to change Amazon Inspector deep inspection status for.
Main.Inspector2.cancel_findings_report
— Methodcancel_findings_report(report_id)
cancel_findings_report(report_id, params::Dict{String,<:Any})
Cancels the given findings report.
Arguments
report_id
: The ID of the report to be canceled.
Main.Inspector2.cancel_sbom_export
— Methodcancel_sbom_export(report_id)
cancel_sbom_export(report_id, params::Dict{String,<:Any})
Cancels a software bill of materials (SBOM) report.
Arguments
report_id
: The report ID of the SBOM export to cancel.
Main.Inspector2.create_cis_scan_configuration
— Methodcreate_cis_scan_configuration(scan_name, schedule, security_level, targets)
create_cis_scan_configuration(scan_name, schedule, security_level, targets, params::Dict{String,<:Any})
Creates a CIS scan configuration.
Arguments
scan_name
: The scan name for the CIS scan configuration.schedule
: The schedule for the CIS scan configuration.security_level
: The security level for the CIS scan configuration. Security level refers to the Benchmark levels that CIS assigns to a profile.targets
: The targets for the CIS scan configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"tags"
: The tags for the CIS scan configuration.
Main.Inspector2.create_filter
— Methodcreate_filter(action, filter_criteria, name)
create_filter(action, filter_criteria, name, params::Dict{String,<:Any})
Creates a filter resource using specified filter criteria. When the filter action is set to SUPPRESS this action creates a suppression rule.
Arguments
action
: Defines the action that is to be applied to the findings that match the filter.filter_criteria
: Defines the criteria to be used in the filter for querying findings.name
: The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: A description of the filter."reason"
: The reason for creating the filter."tags"
: A list of tags for the filter.
Main.Inspector2.create_findings_report
— Methodcreate_findings_report(report_format, s3_destination)
create_findings_report(report_format, s3_destination, params::Dict{String,<:Any})
Creates a finding report. By default only ACTIVE findings are returned in the report. To see SUPRESSED or CLOSED findings you must specify a value for the findingStatus filter criteria.
Arguments
report_format
: The format to generate the report in.s3_destination
: The Amazon S3 export destination for the report.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filterCriteria"
: The filter criteria to apply to the results of the finding report.
Main.Inspector2.create_sbom_export
— Methodcreate_sbom_export(report_format, s3_destination)
create_sbom_export(report_format, s3_destination, params::Dict{String,<:Any})
Creates a software bill of materials (SBOM) report.
Arguments
report_format
: The output format for the software bill of materials (SBOM) report.s3_destination
:
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"resourceFilterCriteria"
: The resource filter criteria for the software bill of materials (SBOM) report.
Main.Inspector2.delete_cis_scan_configuration
— Methoddelete_cis_scan_configuration(scan_configuration_arn)
delete_cis_scan_configuration(scan_configuration_arn, params::Dict{String,<:Any})
Deletes a CIS scan configuration.
Arguments
scan_configuration_arn
: The ARN of the CIS scan configuration.
Main.Inspector2.delete_filter
— Methoddelete_filter(arn)
delete_filter(arn, params::Dict{String,<:Any})
Deletes a filter resource.
Arguments
arn
: The Amazon Resource Number (ARN) of the filter to be deleted.
Main.Inspector2.describe_organization_configuration
— Methoddescribe_organization_configuration()
describe_organization_configuration(params::Dict{String,<:Any})
Describe Amazon Inspector configuration settings for an Amazon Web Services organization.
Main.Inspector2.disable
— Methoddisable()
disable(params::Dict{String,<:Any})
Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"accountIds"
: An array of account IDs you want to disable Amazon Inspector scans for."resourceTypes"
: The resource scan types you want to disable.
Main.Inspector2.disable_delegated_admin_account
— Methoddisable_delegated_admin_account(delegated_admin_account_id)
disable_delegated_admin_account(delegated_admin_account_id, params::Dict{String,<:Any})
Disables the Amazon Inspector delegated administrator for your organization.
Arguments
delegated_admin_account_id
: The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.
Main.Inspector2.disassociate_member
— Methoddisassociate_member(account_id)
disassociate_member(account_id, params::Dict{String,<:Any})
Disassociates a member account from an Amazon Inspector delegated administrator.
Arguments
account_id
: The Amazon Web Services account ID of the member account to disassociate.
Main.Inspector2.enable
— Methodenable(resource_types)
enable(resource_types, params::Dict{String,<:Any})
Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
Arguments
resource_types
: The resource scan types you want to enable.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"accountIds"
: A list of account IDs you want to enable Amazon Inspector scans for."clientToken"
: The idempotency token for the request.
Main.Inspector2.enable_delegated_admin_account
— Methodenable_delegated_admin_account(delegated_admin_account_id)
enable_delegated_admin_account(delegated_admin_account_id, params::Dict{String,<:Any})
Enables the Amazon Inspector delegated administrator for your Organizations organization.
Arguments
delegated_admin_account_id
: The Amazon Web Services account ID of the Amazon Inspector delegated administrator.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"clientToken"
: The idempotency token for the request.
Main.Inspector2.get_cis_scan_report
— Methodget_cis_scan_report(scan_arn)
get_cis_scan_report(scan_arn, params::Dict{String,<:Any})
Retrieves a CIS scan report.
Arguments
scan_arn
: The scan ARN.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"reportFormat"
: The format of the report. Valid values are PDF and CSV. If no value is specified, the report format defaults to PDF."targetAccounts"
: The target accounts.
Main.Inspector2.get_cis_scan_result_details
— Methodget_cis_scan_result_details(account_id, scan_arn, target_resource_id)
get_cis_scan_result_details(account_id, scan_arn, target_resource_id, params::Dict{String,<:Any})
Retrieves CIS scan result details.
Arguments
account_id
: The account ID.scan_arn
: The scan ARN.target_resource_id
: The target resource ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filterCriteria"
: The filter criteria."maxResults"
: The maximum number of CIS scan result details to be returned in a single page of results."nextToken"
: The pagination token from a previous request that's used to retrieve the next page of results."sortBy"
: The sort by order."sortOrder"
: The sort order.
Main.Inspector2.get_configuration
— Methodget_configuration()
get_configuration(params::Dict{String,<:Any})
Retrieves setting configurations for Inspector scans.
Main.Inspector2.get_delegated_admin_account
— Methodget_delegated_admin_account()
get_delegated_admin_account(params::Dict{String,<:Any})
Retrieves information about the Amazon Inspector delegated administrator for your organization.
Main.Inspector2.get_ec2_deep_inspection_configuration
— Methodget_ec2_deep_inspection_configuration()
get_ec2_deep_inspection_configuration(params::Dict{String,<:Any})
Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.
Main.Inspector2.get_encryption_key
— Methodget_encryption_key(resource_type, scan_type)
get_encryption_key(resource_type, scan_type, params::Dict{String,<:Any})
Gets an encryption key.
Arguments
resource_type
: The resource type the key encrypts.scan_type
: The scan type the key encrypts.
Main.Inspector2.get_findings_report_status
— Methodget_findings_report_status()
get_findings_report_status(params::Dict{String,<:Any})
Gets the status of a findings report.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"reportId"
: The ID of the report to retrieve the status of.
Main.Inspector2.get_member
— Methodget_member(account_id)
get_member(account_id, params::Dict{String,<:Any})
Gets member information for your organization.
Arguments
account_id
: The Amazon Web Services account ID of the member account to retrieve information on.
Main.Inspector2.get_sbom_export
— Methodget_sbom_export(report_id)
get_sbom_export(report_id, params::Dict{String,<:Any})
Gets details of a software bill of materials (SBOM) report.
Arguments
report_id
: The report ID of the SBOM export to get details for.
Main.Inspector2.list_account_permissions
— Methodlist_account_permissions()
list_account_permissions(params::Dict{String,<:Any})
Lists the permissions an account has to configure Amazon Inspector.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results."nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page."service"
: The service scan type to check permissions for.
Main.Inspector2.list_cis_scan_configurations
— Methodlist_cis_scan_configurations()
list_cis_scan_configurations(params::Dict{String,<:Any})
Lists CIS scan configurations.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filterCriteria"
: The CIS scan configuration filter criteria."maxResults"
: The maximum number of CIS scan configurations to be returned in a single page of results."nextToken"
: The pagination token from a previous request that's used to retrieve the next page of results."sortBy"
: The CIS scan configuration sort by order."sortOrder"
: The CIS scan configuration sort order order.
Main.Inspector2.list_cis_scan_results_aggregated_by_checks
— Methodlist_cis_scan_results_aggregated_by_checks(scan_arn)
list_cis_scan_results_aggregated_by_checks(scan_arn, params::Dict{String,<:Any})
Lists scan results aggregated by checks.
Arguments
scan_arn
: The scan ARN.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filterCriteria"
: The filter criteria."maxResults"
: The maximum number of scan results aggregated by checks to be returned in a single page of results."nextToken"
: The pagination token from a previous request that's used to retrieve the next page of results."sortBy"
: The sort by order."sortOrder"
: The sort order.
Main.Inspector2.list_cis_scan_results_aggregated_by_target_resource
— Methodlist_cis_scan_results_aggregated_by_target_resource(scan_arn)
list_cis_scan_results_aggregated_by_target_resource(scan_arn, params::Dict{String,<:Any})
Lists scan results aggregated by a target resource.
Arguments
scan_arn
: The scan ARN.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filterCriteria"
: The filter criteria."maxResults"
: The maximum number of scan results aggregated by a target resource to be returned in a single page of results."nextToken"
: The pagination token from a previous request that's used to retrieve the next page of results."sortBy"
: The sort by order."sortOrder"
: The sort order.
Main.Inspector2.list_cis_scans
— Methodlist_cis_scans()
list_cis_scans(params::Dict{String,<:Any})
Returns a CIS scan list.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"detailLevel"
: The detail applied to the CIS scan."filterCriteria"
: The CIS scan filter criteria."maxResults"
: The maximum number of results to be returned."nextToken"
: The pagination token from a previous request that's used to retrieve the next page of results."sortBy"
: The CIS scans sort by order."sortOrder"
: The CIS scans sort order.
Main.Inspector2.list_coverage
— Methodlist_coverage()
list_coverage(params::Dict{String,<:Any})
Lists coverage details for you environment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filterCriteria"
: An object that contains details on the filters to apply to the coverage data for your environment."maxResults"
: The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results."nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
Main.Inspector2.list_coverage_statistics
— Methodlist_coverage_statistics()
list_coverage_statistics(params::Dict{String,<:Any})
Lists Amazon Inspector coverage statistics for your environment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filterCriteria"
: An object that contains details on the filters to apply to the coverage data for your environment."groupBy"
: The value to group the results by."nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
Main.Inspector2.list_delegated_admin_accounts
— Methodlist_delegated_admin_accounts()
list_delegated_admin_accounts(params::Dict{String,<:Any})
Lists information about the Amazon Inspector delegated administrator of your organization.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results."nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
Main.Inspector2.list_filters
— Methodlist_filters()
list_filters(params::Dict{String,<:Any})
Lists the filters associated with your account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"action"
: The action the filter applies to matched findings."arns"
: The Amazon resource number (ARN) of the filter."maxResults"
: The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results."nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
Main.Inspector2.list_finding_aggregations
— Methodlist_finding_aggregations(aggregation_type)
list_finding_aggregations(aggregation_type, params::Dict{String,<:Any})
Lists aggregated finding data for your environment based on specific criteria.
Arguments
aggregation_type
: The type of the aggregation request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"accountIds"
: The Amazon Web Services account IDs to retrieve finding aggregation data for."aggregationRequest"
: Details of the aggregation request that is used to filter your aggregation results."maxResults"
: The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results."nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
Main.Inspector2.list_findings
— Methodlist_findings()
list_findings(params::Dict{String,<:Any})
Lists findings for your environment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filterCriteria"
: Details on the filters to apply to your finding results."maxResults"
: The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results."nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page."sortCriteria"
: Details on the sort criteria to apply to your finding results.
Main.Inspector2.list_members
— Methodlist_members()
list_members(params::Dict{String,<:Any})
List members associated with the Amazon Inspector delegated administrator for your organization.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results."nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page."onlyAssociated"
: Specifies whether to list only currently associated members if True or to list all members within the organization if False.
Main.Inspector2.list_tags_for_resource
— Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists all tags attached to a given resource.
Arguments
resource_arn
: The Amazon resource number (ARN) of the resource to list tags of.
Main.Inspector2.list_usage_totals
— Methodlist_usage_totals()
list_usage_totals(params::Dict{String,<:Any})
Lists the Amazon Inspector usage totals over the last 30 days.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"accountIds"
: The Amazon Web Services account IDs to retrieve usage totals for."maxResults"
: The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results."nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
Main.Inspector2.reset_encryption_key
— Methodreset_encryption_key(resource_type, scan_type)
reset_encryption_key(resource_type, scan_type, params::Dict{String,<:Any})
Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key.
Arguments
resource_type
: The resource type the key encrypts.scan_type
: The scan type the key encrypts.
Main.Inspector2.search_vulnerabilities
— Methodsearch_vulnerabilities(filter_criteria)
search_vulnerabilities(filter_criteria, params::Dict{String,<:Any})
Lists Amazon Inspector coverage details for a specific vulnerability.
Arguments
filter_criteria
: The criteria used to filter the results of a vulnerability search.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"nextToken"
: A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
Main.Inspector2.send_cis_session_health
— Methodsend_cis_session_health(scan_job_id, session_token)
send_cis_session_health(scan_job_id, session_token, params::Dict{String,<:Any})
Sends a CIS session health. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
Arguments
scan_job_id
: A unique identifier for the scan job.session_token
: The unique token that identifies the CIS session.
Main.Inspector2.send_cis_session_telemetry
— Methodsend_cis_session_telemetry(messages, scan_job_id, session_token)
send_cis_session_telemetry(messages, scan_job_id, session_token, params::Dict{String,<:Any})
Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
Arguments
messages
: The CIS session telemetry messages.scan_job_id
: A unique identifier for the scan job.session_token
: The unique token that identifies the CIS session.
Main.Inspector2.start_cis_session
— Methodstart_cis_session(message, scan_job_id)
start_cis_session(message, scan_job_id, params::Dict{String,<:Any})
Starts a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
Arguments
message
: The start CIS session message.scan_job_id
: A unique identifier for the scan job.
Main.Inspector2.stop_cis_session
— Methodstop_cis_session(message, scan_job_id, session_token)
stop_cis_session(message, scan_job_id, session_token, params::Dict{String,<:Any})
Stops a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
Arguments
message
: The stop CIS session message.scan_job_id
: A unique identifier for the scan job.session_token
: The unique token that identifies the CIS session.
Main.Inspector2.tag_resource
— Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds tags to a resource.
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource to apply a tag to.tags
: The tags to be added to a resource.
Main.Inspector2.untag_resource
— Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a resource.
Arguments
resource_arn
: The Amazon Resource Name (ARN) for the resource to remove tags from.tag_keys
: The tag keys to remove from the resource.
Main.Inspector2.update_cis_scan_configuration
— Methodupdate_cis_scan_configuration(scan_configuration_arn)
update_cis_scan_configuration(scan_configuration_arn, params::Dict{String,<:Any})
Updates a CIS scan configuration.
Arguments
scan_configuration_arn
: The CIS scan configuration ARN.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"scanName"
: The scan name for the CIS scan configuration."schedule"
: The schedule for the CIS scan configuration."securityLevel"
: The security level for the CIS scan configuration. Security level refers to the Benchmark levels that CIS assigns to a profile."targets"
: The targets for the CIS scan configuration.
Main.Inspector2.update_configuration
— Methodupdate_configuration()
update_configuration(params::Dict{String,<:Any})
Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ec2Configuration"
: Specifies how the Amazon EC2 automated scan will be updated for your environment."ecrConfiguration"
: Specifies how the ECR automated re-scan will be updated for your environment.
Main.Inspector2.update_ec2_deep_inspection_configuration
— Methodupdate_ec2_deep_inspection_configuration()
update_ec2_deep_inspection_configuration(params::Dict{String,<:Any})
Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"activateDeepInspection"
: Specify TRUE to activate Amazon Inspector deep inspection in your account, or FALSE to deactivate. Member accounts in an organization cannot deactivate deep inspection, instead the delegated administrator for the organization can deactivate a member account using BatchUpdateMemberEc2DeepInspectionStatus."packagePaths"
: The Amazon Inspector deep inspection custom paths you are adding for your account.
Main.Inspector2.update_encryption_key
— Methodupdate_encryption_key(kms_key_id, resource_type, scan_type)
update_encryption_key(kms_key_id, resource_type, scan_type, params::Dict{String,<:Any})
Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.
Arguments
kms_key_id
: A KMS key ID for the encryption key.resource_type
: The resource type for the encryption key.scan_type
: The scan type for the encryption key.
Main.Inspector2.update_filter
— Methodupdate_filter(filter_arn)
update_filter(filter_arn, params::Dict{String,<:Any})
Specifies the action that is to be applied to the findings that match the filter.
Arguments
filter_arn
: The Amazon Resource Number (ARN) of the filter to update.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"action"
: Specifies the action that is to be applied to the findings that match the filter."description"
: A description of the filter."filterCriteria"
: Defines the criteria to be update in the filter."name"
: The name of the filter."reason"
: The reason the filter was updated.
Main.Inspector2.update_org_ec2_deep_inspection_configuration
— Methodupdate_org_ec2_deep_inspection_configuration(org_package_paths)
update_org_ec2_deep_inspection_configuration(org_package_paths, params::Dict{String,<:Any})
Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.
Arguments
org_package_paths
: The Amazon Inspector deep inspection custom paths you are adding for your organization.
Main.Inspector2.update_organization_configuration
— Methodupdate_organization_configuration(auto_enable)
update_organization_configuration(auto_enable, params::Dict{String,<:Any})
Updates the configurations for your Amazon Inspector organization.
Arguments
auto_enable
: Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.