aws-elixir

View Source AWS.Inspector2 (aws-elixir v1.0.4)

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2, Amazon ECR, and Amazon Web Services Lambda environments.

Link to this section Summary

Functions

associate_member(client, input, options \\ [])

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.

batch_get_account_status(client, input, options \\ [])

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

batch_get_code_snippet(client, input, options \\ [])

Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.

batch_get_finding_details(client, input, options \\ [])

Gets vulnerability details for findings.

batch_get_free_trial_info(client, input, options \\ [])

Gets free trial status for multiple Amazon Web Services accounts.

batch_get_member_ec2_deep_inspection_status(client, input, options \\ [])

Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization.

batch_update_member_ec2_deep_inspection_status(client, input, options \\ [])

Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization.

cancel_findings_report(client, input, options \\ [])

Cancels the given findings report.

cancel_sbom_export(client, input, options \\ [])

Cancels a software bill of materials (SBOM) report.

create_cis_scan_configuration(client, input, options \\ [])

Creates a CIS scan configuration.

create_filter(client, input, options \\ [])

Creates a filter resource using specified filter criteria.

create_findings_report(client, input, options \\ [])

Creates a finding report.

create_sbom_export(client, input, options \\ [])

Creates a software bill of materials (SBOM) report.

delete_cis_scan_configuration(client, input, options \\ [])

Deletes a CIS scan configuration.

delete_filter(client, input, options \\ [])

Deletes a filter resource.

describe_organization_configuration(client, input, options \\ [])

Describe Amazon Inspector configuration settings for an Amazon Web Services organization.

disable(client, input, options \\ [])

Disables Amazon Inspector scans for one or more Amazon Web Services accounts.

disable_delegated_admin_account(client, input, options \\ [])

Disables the Amazon Inspector delegated administrator for your organization.

disassociate_member(client, input, options \\ [])

Disassociates a member account from an Amazon Inspector delegated administrator.

enable(client, input, options \\ [])

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

enable_delegated_admin_account(client, input, options \\ [])

Enables the Amazon Inspector delegated administrator for your Organizations organization.

get_cis_scan_report(client, input, options \\ [])

Retrieves a CIS scan report.

get_cis_scan_result_details(client, input, options \\ [])

Retrieves CIS scan result details.

get_configuration(client, input, options \\ [])

Retrieves setting configurations for Inspector scans.

get_delegated_admin_account(client, input, options \\ [])

Retrieves information about the Amazon Inspector delegated administrator for your organization.

get_ec2_deep_inspection_configuration(client, input, options \\ [])

Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.

get_encryption_key(client, resource_type, scan_type, options \\ [])

Gets an encryption key.

get_findings_report_status(client, input, options \\ [])

Gets the status of a findings report.

get_member(client, input, options \\ [])

Gets member information for your organization.

get_sbom_export(client, input, options \\ [])

Gets details of a software bill of materials (SBOM) report.

list_account_permissions(client, input, options \\ [])

Lists the permissions an account has to configure Amazon Inspector.

list_cis_scan_configurations(client, input, options \\ [])

Lists CIS scan configurations.

list_cis_scan_results_aggregated_by_checks(client, input, options \\ [])

Lists scan results aggregated by checks.

list_cis_scan_results_aggregated_by_target_resource(client, input, options \\ [])

Lists scan results aggregated by a target resource.

list_cis_scans(client, input, options \\ [])

Returns a CIS scan list.

list_coverage(client, input, options \\ [])

Lists coverage details for your environment.

list_coverage_statistics(client, input, options \\ [])

Lists Amazon Inspector coverage statistics for your environment.

list_delegated_admin_accounts(client, input, options \\ [])

Lists information about the Amazon Inspector delegated administrator of your organization.

list_filters(client, input, options \\ [])

Lists the filters associated with your account.

list_finding_aggregations(client, input, options \\ [])

Lists aggregated finding data for your environment based on specific criteria.

list_findings(client, input, options \\ [])

Lists findings for your environment.

list_members(client, input, options \\ [])

List members associated with the Amazon Inspector delegated administrator for your organization.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists all tags attached to a given resource.

list_usage_totals(client, input, options \\ [])

Lists the Amazon Inspector usage totals over the last 30 days.

metadata()
reset_encryption_key(client, input, options \\ [])

Resets an encryption key.

search_vulnerabilities(client, input, options \\ [])

Lists Amazon Inspector coverage details for a specific vulnerability.

send_cis_session_health(client, input, options \\ [])

Sends a CIS session health.

send_cis_session_telemetry(client, input, options \\ [])

Sends a CIS session telemetry.

start_cis_session(client, input, options \\ [])

Starts a CIS session.

stop_cis_session(client, input, options \\ [])

Stops a CIS session.

tag_resource(client, resource_arn, input, options \\ [])

Adds tags to a resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes tags from a resource.

update_cis_scan_configuration(client, input, options \\ [])

Updates a CIS scan configuration.

update_configuration(client, input, options \\ [])

Updates setting configurations for your Amazon Inspector account.

update_ec2_deep_inspection_configuration(client, input, options \\ [])

Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

update_encryption_key(client, input, options \\ [])

Updates an encryption key.

update_filter(client, input, options \\ [])

Specifies the action that is to be applied to the findings that match the filter.

update_org_ec2_deep_inspection_configuration(client, input, options \\ [])

Updates the Amazon Inspector deep inspection custom paths for your organization.

update_organization_configuration(client, input, options \\ [])

Updates the configurations for your Amazon Inspector organization.

Link to this section Functions

Link to this function

associate_member(client, input, options \\ [])

View Source

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.

An HTTP 200 response indicates the association was started but doesn’t indicate whether it completed. You can check if the association completed using ListMembers for multiple accounts or GetMembers for a single account. An HTTP 402 response indicates the association failed because the organization size exceeded its limit. For information on limits, see Amazon Inspector quotas.

Link to this function

batch_get_account_status(client, input, options \\ [])

View Source

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

Link to this function

batch_get_code_snippet(client, input, options \\ [])

View Source

Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.

Link to this function

batch_get_finding_details(client, input, options \\ [])

View Source

Gets vulnerability details for findings.

Link to this function

batch_get_free_trial_info(client, input, options \\ [])

View Source

Gets free trial status for multiple Amazon Web Services accounts.

Link to this function

batch_get_member_ec2_deep_inspection_status(client, input, options \\ [])

View Source

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.

Link to this function

batch_update_member_ec2_deep_inspection_status(client, input, options \\ [])

View Source

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.

Link to this function

cancel_findings_report(client, input, options \\ [])

View Source

Cancels the given findings report.

Link to this function

cancel_sbom_export(client, input, options \\ [])

View Source

Cancels a software bill of materials (SBOM) report.

Link to this function

create_cis_scan_configuration(client, input, options \\ [])

View Source

Creates a CIS scan configuration.

Link to this function

create_filter(client, input, options \\ [])

View Source

Creates a filter resource using specified filter criteria.

When the filter action is set to SUPPRESS this action creates a suppression rule.

Link to this function

create_findings_report(client, input, options \\ [])

View Source

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.

Link to this function

create_sbom_export(client, input, options \\ [])

View Source

Creates a software bill of materials (SBOM) report.

Link to this function

delete_cis_scan_configuration(client, input, options \\ [])

View Source

Deletes a CIS scan configuration.

Link to this function

delete_filter(client, input, options \\ [])

View Source

Deletes a filter resource.

Link to this function

describe_organization_configuration(client, input, options \\ [])

View Source

Describe Amazon Inspector configuration settings for an Amazon Web Services organization.

Link to this function

disable(client, input, options \\ [])

View Source

Disables Amazon Inspector scans for one or more Amazon Web Services accounts.

Disabling all scan types in an account disables the Amazon Inspector service.

Link to this function

disable_delegated_admin_account(client, input, options \\ [])

View Source

Disables the Amazon Inspector delegated administrator for your organization.

Link to this function

disassociate_member(client, input, options \\ [])

View Source

Disassociates a member account from an Amazon Inspector delegated administrator.

Link to this function

enable(client, input, options \\ [])

View Source

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

Link to this function

enable_delegated_admin_account(client, input, options \\ [])

View Source

Enables the Amazon Inspector delegated administrator for your Organizations organization.

Link to this function

get_cis_scan_report(client, input, options \\ [])

View Source

Retrieves a CIS scan report.

Link to this function

get_cis_scan_result_details(client, input, options \\ [])

View Source

Retrieves CIS scan result details.

Link to this function

get_configuration(client, input, options \\ [])

View Source

Retrieves setting configurations for Inspector scans.

Link to this function

get_delegated_admin_account(client, input, options \\ [])

View Source

Retrieves information about the Amazon Inspector delegated administrator for your organization.

Link to this function

get_ec2_deep_inspection_configuration(client, input, options \\ [])

View Source

Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.

Link to this function

get_encryption_key(client, resource_type, scan_type, options \\ [])

View Source

Gets an encryption key.

Link to this function

get_findings_report_status(client, input, options \\ [])

View Source

Gets the status of a findings report.

Link to this function

get_member(client, input, options \\ [])

View Source

Gets member information for your organization.

Link to this function

get_sbom_export(client, input, options \\ [])

View Source

Gets details of a software bill of materials (SBOM) report.

Link to this function

list_account_permissions(client, input, options \\ [])

View Source

Lists the permissions an account has to configure Amazon Inspector.

Link to this function

list_cis_scan_configurations(client, input, options \\ [])

View Source

Lists CIS scan configurations.

Link to this function

list_cis_scan_results_aggregated_by_checks(client, input, options \\ [])

View Source

Lists scan results aggregated by checks.

Link to this function

list_cis_scan_results_aggregated_by_target_resource(client, input, options \\ [])

View Source

Lists scan results aggregated by a target resource.

Link to this function

list_cis_scans(client, input, options \\ [])

View Source

Returns a CIS scan list.

Link to this function

list_coverage(client, input, options \\ [])

View Source

Lists coverage details for your environment.

Link to this function

list_coverage_statistics(client, input, options \\ [])

View Source

Lists Amazon Inspector coverage statistics for your environment.

Link to this function

list_delegated_admin_accounts(client, input, options \\ [])

View Source

Lists information about the Amazon Inspector delegated administrator of your organization.

Link to this function

list_filters(client, input, options \\ [])

View Source

Lists the filters associated with your account.

Link to this function

list_finding_aggregations(client, input, options \\ [])

View Source

Lists aggregated finding data for your environment based on specific criteria.

Link to this function

list_findings(client, input, options \\ [])

View Source

Lists findings for your environment.

Link to this function

list_members(client, input, options \\ [])

View Source

List members associated with the Amazon Inspector delegated administrator for your organization.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists all tags attached to a given resource.

Link to this function

list_usage_totals(client, input, options \\ [])

View Source

Lists the Amazon Inspector usage totals over the last 30 days.

Link to this function

metadata()

View Source
Link to this function

reset_encryption_key(client, input, options \\ [])

View Source

Resets an encryption key.

After the key is reset your resources will be encrypted by an Amazon Web Services owned key.

Link to this function

search_vulnerabilities(client, input, options \\ [])

View Source

Lists Amazon Inspector coverage details for a specific vulnerability.

Link to this function

send_cis_session_health(client, input, options \\ [])

View Source

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.

Link to this function

send_cis_session_telemetry(client, input, options \\ [])

View Source

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.

Link to this function

start_cis_session(client, input, options \\ [])

View Source

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.

Link to this function

stop_cis_session(client, input, options \\ [])

View Source

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 stop a CIS scan session for the scan ID supplied by the service.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds tags to a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from a resource.

Link to this function

update_cis_scan_configuration(client, input, options \\ [])

View Source

Updates a CIS scan configuration.

Link to this function

update_configuration(client, input, options \\ [])

View Source

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.

Link to this function

update_ec2_deep_inspection_configuration(client, input, options \\ [])

View Source

Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

Link to this function

update_encryption_key(client, input, options \\ [])

View Source

Updates an encryption key.

A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.

Link to this function

update_filter(client, input, options \\ [])

View Source

Specifies the action that is to be applied to the findings that match the filter.

Link to this function

update_org_ec2_deep_inspection_configuration(client, input, options \\ [])

View Source

Updates the Amazon Inspector deep inspection custom paths for your organization.

You must be an Amazon Inspector delegated administrator to use this API.

Link to this function

update_organization_configuration(client, input, options \\ [])

View Source

Updates the configurations for your Amazon Inspector organization.