baiji v0.6.7 Baiji.Inspector

Amazon Inspector

Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide.

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

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

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. 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

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target

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

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

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

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

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

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

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

Describes the IAM role that enables Amazon Inspector to access your AWS account

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

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

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

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

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

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

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

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

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

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

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

Lists all available Amazon Inspector rules packages

Lists all tags associated with an assessment template

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

Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action

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

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

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

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

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

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

Updates the assessment target that is specified by the ARN of the assessment target

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function add_attributes_to_findings(input \\ %{}, options \\ [])

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

Link to this function create_assessment_target(input \\ %{}, options \\ [])

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. 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.

Link to this function create_assessment_template(input \\ %{}, options \\ [])

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.

Link to this function create_resource_group(input \\ %{}, options \\ [])

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.

Link to this function delete_assessment_run(input \\ %{}, options \\ [])

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

Link to this function delete_assessment_target(input \\ %{}, options \\ [])

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

Link to this function delete_assessment_template(input \\ %{}, options \\ [])

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

Link to this function describe_assessment_runs(input \\ %{}, options \\ [])

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

Link to this function describe_assessment_targets(input \\ %{}, options \\ [])

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

Link to this function describe_assessment_templates(input \\ %{}, options \\ [])

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

Link to this function describe_cross_account_access_role(input \\ %{}, options \\ [])

Describes the IAM role that enables Amazon Inspector to access your AWS account.

Link to this function describe_findings(input \\ %{}, options \\ [])

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

Link to this function describe_resource_groups(input \\ %{}, options \\ [])

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

Link to this function describe_rules_packages(input \\ %{}, options \\ [])

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

Link to this function get_assessment_report(input \\ %{}, options \\ [])

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

Link to this function get_telemetry_metadata(input \\ %{}, options \\ [])

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

Link to this function list_assessment_run_agents(input \\ %{}, options \\ [])

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

Link to this function list_assessment_runs(input \\ %{}, options \\ [])

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

Link to this function list_assessment_targets(input \\ %{}, options \\ [])

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

Link to this function list_assessment_templates(input \\ %{}, options \\ [])

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

Link to this function list_event_subscriptions(input \\ %{}, options \\ [])

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.

Link to this function list_findings(input \\ %{}, options \\ [])

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

Link to this function list_rules_packages(input \\ %{}, options \\ [])

Lists all available Amazon Inspector rules packages.

Link to this function list_tags_for_resource(input \\ %{}, options \\ [])

Lists all tags associated with an assessment template.

Link to this function preview_agents(input \\ %{}, options \\ [])

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

Link to this function register_cross_account_access_role(input \\ %{}, options \\ [])

Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.

Link to this function remove_attributes_from_findings(input \\ %{}, options \\ [])

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.

Link to this function set_tags_for_resource(input \\ %{}, options \\ [])

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

Link to this function start_assessment_run(input \\ %{}, options \\ [])

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.

Link to this function stop_assessment_run(input \\ %{}, options \\ [])

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

Link to this function subscribe_to_event(input \\ %{}, options \\ [])

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

Link to this function unsubscribe_from_event(input \\ %{}, options \\ [])

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

Link to this function update_assessment_target(input \\ %{}, options \\ [])

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