Module Smaws_Client_Inspector

Inspector client library built on EIO.

Types

module Types : sig ... end

Builders

val make_attribute : ?value:Types.attribute_value -> key:Types.attribute_key -> unit -> Types.attribute
val make_update_assessment_target_request : ?resource_group_arn:Types.arn -> assessment_target_name:Types.assessment_target_name -> assessment_target_arn:Types.arn -> unit -> Types.update_assessment_target_request
val make_unsubscribe_from_event_request : topic_arn:Types.arn -> event:Types.inspector_event -> resource_arn:Types.arn -> unit -> Types.unsubscribe_from_event_request
val make_timestamp_range : ?end_date:Types.timestamp -> ?begin_date:Types.timestamp -> unit -> Types.timestamp_range
val make_telemetry_metadata : ?data_size:Types.long -> count:Types.long -> message_type:Types.message_type -> unit -> Types.telemetry_metadata
val make_tag : ?value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_event_subscription : subscribed_at:Types.timestamp -> event:Types.inspector_event -> unit -> Types.event_subscription
val make_subscription : event_subscriptions:Types.event_subscription_list -> topic_arn:Types.arn -> resource_arn:Types.arn -> unit -> Types.subscription
val make_subscribe_to_event_request : topic_arn:Types.arn -> event:Types.inspector_event -> resource_arn:Types.arn -> unit -> Types.subscribe_to_event_request
val make_stop_assessment_run_request : ?stop_action:Types.stop_action -> assessment_run_arn:Types.arn -> unit -> Types.stop_assessment_run_request
val make_start_assessment_run_response : assessment_run_arn:Types.arn -> unit -> Types.start_assessment_run_response
val make_start_assessment_run_request : ?assessment_run_name:Types.assessment_run_name -> assessment_template_arn:Types.arn -> unit -> Types.start_assessment_run_request
val make_agent_already_running_assessment : assessment_run_arn:Types.arn -> agent_id:Types.agent_id -> unit -> Types.agent_already_running_assessment
val make_set_tags_for_resource_request : ?tags:Types.tag_list -> resource_arn:Types.arn -> unit -> Types.set_tags_for_resource_request
val make_security_group : ?group_id:Types.text -> ?group_name:Types.text -> unit -> Types.security_group
val make_scope : ?value:Types.scope_value -> ?key:Types.scope_type -> unit -> Types.scope
val make_rules_package : ?description:Types.text -> provider:Types.provider_name -> version:Types.version -> name:Types.rules_package_name -> arn:Types.arn -> unit -> Types.rules_package
val make_resource_group_tag : ?value:Types.tag_value -> key:Types.tag_key -> unit -> Types.resource_group_tag
val make_resource_group : created_at:Types.timestamp -> tags:Types.resource_group_tags -> arn:Types.arn -> unit -> Types.resource_group
val make_failed_item_details : retryable:Types.bool_ -> failure_code:Types.failed_item_error_code -> unit -> Types.failed_item_details
val make_remove_attributes_from_findings_response : failed_items:Types.failed_items -> unit -> Types.remove_attributes_from_findings_response
val make_remove_attributes_from_findings_request : attribute_keys:Types.user_attribute_key_list -> finding_arns:Types.add_remove_attributes_finding_arn_list -> unit -> Types.remove_attributes_from_findings_request
val make_register_cross_account_access_role_request : role_arn:Types.arn -> unit -> Types.register_cross_account_access_role_request
val make_private_ip : ?private_ip_address:Types.text -> ?private_dns_name:Types.text -> unit -> Types.private_ip
val make_agent_preview : ?ipv4_address:Types.ipv4_address -> ?kernel_version:Types.kernel_version -> ?operating_system:Types.operating_system -> ?agent_version:Types.agent_version -> ?agent_health:Types.agent_health -> ?auto_scaling_group:Types.auto_scaling_group -> ?hostname:Types.hostname -> agent_id:Types.agent_id -> unit -> Types.agent_preview
val make_preview_agents_response : ?next_token:Types.pagination_token -> agent_previews:Types.agent_preview_list -> unit -> Types.preview_agents_response
val make_preview_agents_request : ?max_results:Types.preview_agents_max_results -> ?next_token:Types.pagination_token -> preview_agents_arn:Types.arn -> unit -> Types.preview_agents_request
val make_network_interface : ?security_groups:Types.security_groups -> ?ipv6_addresses:Types.ipv6_addresses -> ?public_ip:Types.text -> ?public_dns_name:Types.text -> ?private_ip_addresses:Types.private_ip_addresses -> ?private_ip_address:Types.text -> ?private_dns_name:Types.text -> ?vpc_id:Types.text -> ?subnet_id:Types.text -> ?network_interface_id:Types.text -> unit -> Types.network_interface
val make_list_tags_for_resource_response : tags:Types.tag_list -> unit -> Types.list_tags_for_resource_response
val make_list_tags_for_resource_request : resource_arn:Types.arn -> unit -> Types.list_tags_for_resource_request
val make_list_rules_packages_response : ?next_token:Types.pagination_token -> rules_package_arns:Types.list_returned_arn_list -> unit -> Types.list_rules_packages_response
val make_list_rules_packages_request : ?max_results:Types.list_max_results -> ?next_token:Types.pagination_token -> unit -> Types.list_rules_packages_request
val make_list_findings_response : ?next_token:Types.pagination_token -> finding_arns:Types.list_returned_arn_list -> unit -> Types.list_findings_response
val make_finding_filter : ?creation_time_range:Types.timestamp_range -> ?user_attributes:Types.attribute_list -> ?attributes:Types.attribute_list -> ?rules_package_arns:Types.filter_rules_package_arn_list -> ?severities:Types.severity_list -> ?rule_names:Types.rule_name_list -> ?auto_scaling_groups:Types.auto_scaling_group_list -> ?agent_ids:Types.agent_id_list -> unit -> Types.finding_filter
val make_list_findings_request : ?max_results:Types.list_max_results -> ?next_token:Types.pagination_token -> ?filter:Types.finding_filter -> ?assessment_run_arns:Types.list_parent_arn_list -> unit -> Types.list_findings_request
val make_list_exclusions_response : ?next_token:Types.pagination_token -> exclusion_arns:Types.list_returned_arn_list -> unit -> Types.list_exclusions_response
val make_list_exclusions_request : ?max_results:Types.list_max_results -> ?next_token:Types.pagination_token -> assessment_run_arn:Types.arn -> unit -> Types.list_exclusions_request
val make_list_event_subscriptions_response : ?next_token:Types.pagination_token -> subscriptions:Types.subscription_list -> unit -> Types.list_event_subscriptions_response
val make_list_event_subscriptions_request : ?max_results:Types.list_event_subscriptions_max_results -> ?next_token:Types.pagination_token -> ?resource_arn:Types.arn -> unit -> Types.list_event_subscriptions_request
val make_list_assessment_templates_response : ?next_token:Types.pagination_token -> assessment_template_arns:Types.list_returned_arn_list -> unit -> Types.list_assessment_templates_response
val make_duration_range : ?max_seconds:Types.assessment_run_duration -> ?min_seconds:Types.assessment_run_duration -> unit -> Types.duration_range
val make_assessment_template_filter : ?rules_package_arns:Types.filter_rules_package_arn_list -> ?duration_range:Types.duration_range -> ?name_pattern:Types.name_pattern -> unit -> Types.assessment_template_filter
val make_list_assessment_templates_request : ?max_results:Types.list_max_results -> ?next_token:Types.pagination_token -> ?filter:Types.assessment_template_filter -> ?assessment_target_arns:Types.list_parent_arn_list -> unit -> Types.list_assessment_templates_request
val make_list_assessment_targets_response : ?next_token:Types.pagination_token -> assessment_target_arns:Types.list_returned_arn_list -> unit -> Types.list_assessment_targets_response
val make_assessment_target_filter : ?assessment_target_name_pattern:Types.name_pattern -> unit -> Types.assessment_target_filter
val make_list_assessment_targets_request : ?max_results:Types.list_max_results -> ?next_token:Types.pagination_token -> ?filter:Types.assessment_target_filter -> unit -> Types.list_assessment_targets_request
val make_list_assessment_runs_response : ?next_token:Types.pagination_token -> assessment_run_arns:Types.list_returned_arn_list -> unit -> Types.list_assessment_runs_response
val make_assessment_run_filter : ?state_change_time_range:Types.timestamp_range -> ?completion_time_range:Types.timestamp_range -> ?start_time_range:Types.timestamp_range -> ?rules_package_arns:Types.filter_rules_package_arn_list -> ?duration_range:Types.duration_range -> ?states:Types.assessment_run_state_list -> ?name_pattern:Types.name_pattern -> unit -> Types.assessment_run_filter
val make_list_assessment_runs_request : ?max_results:Types.list_max_results -> ?next_token:Types.pagination_token -> ?filter:Types.assessment_run_filter -> ?assessment_template_arns:Types.list_parent_arn_list -> unit -> Types.list_assessment_runs_request
val make_assessment_run_agent : ?auto_scaling_group:Types.auto_scaling_group -> ?agent_health_details:Types.message -> telemetry_metadata:Types.telemetry_metadata_list -> agent_health_code:Types.agent_health_code -> agent_health:Types.agent_health -> assessment_run_arn:Types.arn -> agent_id:Types.agent_id -> unit -> Types.assessment_run_agent
val make_list_assessment_run_agents_response : ?next_token:Types.pagination_token -> assessment_run_agents:Types.assessment_run_agent_list -> unit -> Types.list_assessment_run_agents_response
val make_agent_filter : agent_health_codes:Types.agent_health_code_list -> agent_healths:Types.agent_health_list -> unit -> Types.agent_filter
val make_list_assessment_run_agents_request : ?max_results:Types.list_max_results -> ?next_token:Types.pagination_token -> ?filter:Types.agent_filter -> assessment_run_arn:Types.arn -> unit -> Types.list_assessment_run_agents_request
val make_inspector_service_attributes : ?rules_package_arn:Types.arn -> ?assessment_run_arn:Types.arn -> schema_version:Types.numeric_version -> unit -> Types.inspector_service_attributes
val make_get_telemetry_metadata_response : telemetry_metadata:Types.telemetry_metadata_list -> unit -> Types.get_telemetry_metadata_response
val make_get_telemetry_metadata_request : assessment_run_arn:Types.arn -> unit -> Types.get_telemetry_metadata_request
val make_exclusion_preview : ?attributes:Types.attribute_list -> scopes:Types.scope_list -> recommendation:Types.text -> description:Types.text -> title:Types.text -> unit -> Types.exclusion_preview
val make_get_exclusions_preview_response : ?next_token:Types.pagination_token -> ?exclusion_previews:Types.exclusion_preview_list -> preview_status:Types.preview_status -> unit -> Types.get_exclusions_preview_response
val make_get_exclusions_preview_request : ?locale:Types.locale -> ?max_results:Types.list_max_results -> ?next_token:Types.pagination_token -> preview_token:Types.uui_d -> assessment_template_arn:Types.arn -> unit -> Types.get_exclusions_preview_request
val make_get_assessment_report_response : ?url:Types.url -> status:Types.report_status -> unit -> Types.get_assessment_report_response
val make_get_assessment_report_request : report_type:Types.report_type -> report_file_format:Types.report_file_format -> assessment_run_arn:Types.arn -> unit -> Types.get_assessment_report_request
val make_describe_rules_packages_response : failed_items:Types.failed_items -> rules_packages:Types.rules_package_list -> unit -> Types.describe_rules_packages_response
val make_describe_rules_packages_request : ?locale:Types.locale -> rules_package_arns:Types.batch_describe_arn_list -> unit -> Types.describe_rules_packages_request
val make_describe_resource_groups_response : failed_items:Types.failed_items -> resource_groups:Types.resource_group_list -> unit -> Types.describe_resource_groups_response
val make_describe_resource_groups_request : resource_group_arns:Types.batch_describe_arn_list -> unit -> Types.describe_resource_groups_request
val make_asset_attributes : ?network_interfaces:Types.network_interfaces -> ?tags:Types.tags -> ?ipv4_addresses:Types.ipv4_address_list -> ?hostname:Types.hostname -> ?ami_id:Types.ami_id -> ?auto_scaling_group:Types.auto_scaling_group -> ?agent_id:Types.agent_id -> schema_version:Types.numeric_version -> unit -> Types.asset_attributes
val make_finding : ?indicator_of_compromise:Types.bool_ -> ?confidence:Types.ioc_confidence -> ?numeric_severity:Types.numeric_severity -> ?severity:Types.severity -> ?recommendation:Types.text -> ?description:Types.text -> ?title:Types.text -> ?id:Types.finding_id -> ?asset_attributes:Types.asset_attributes -> ?asset_type:Types.asset_type -> ?service_attributes:Types.inspector_service_attributes -> ?service:Types.service_name -> ?schema_version:Types.numeric_version -> updated_at:Types.timestamp -> created_at:Types.timestamp -> user_attributes:Types.user_attribute_list -> attributes:Types.attribute_list -> arn:Types.arn -> unit -> Types.finding
val make_describe_findings_response : failed_items:Types.failed_items -> findings:Types.finding_list -> unit -> Types.describe_findings_response
val make_describe_findings_request : ?locale:Types.locale -> finding_arns:Types.batch_describe_arn_list -> unit -> Types.describe_findings_request
val make_exclusion : ?attributes:Types.attribute_list -> scopes:Types.scope_list -> recommendation:Types.text -> description:Types.text -> title:Types.text -> arn:Types.arn -> unit -> Types.exclusion
val make_describe_exclusions_response : failed_items:Types.failed_items -> exclusions:Types.exclusion_map -> unit -> Types.describe_exclusions_response
val make_describe_exclusions_request : ?locale:Types.locale -> exclusion_arns:Types.batch_describe_exclusions_arn_list -> unit -> Types.describe_exclusions_request
val make_describe_cross_account_access_role_response : registered_at:Types.timestamp -> valid:Types.bool_ -> role_arn:Types.arn -> unit -> Types.describe_cross_account_access_role_response
val make_assessment_template : ?last_assessment_run_arn:Types.arn -> created_at:Types.timestamp -> assessment_run_count:Types.arn_count -> user_attributes_for_findings:Types.user_attribute_list -> rules_package_arns:Types.assessment_template_rules_package_arn_list -> duration_in_seconds:Types.assessment_run_duration -> assessment_target_arn:Types.arn -> name:Types.assessment_template_name -> arn:Types.arn -> unit -> Types.assessment_template
val make_describe_assessment_templates_response : failed_items:Types.failed_items -> assessment_templates:Types.assessment_template_list -> unit -> Types.describe_assessment_templates_response
val make_describe_assessment_templates_request : assessment_template_arns:Types.batch_describe_arn_list -> unit -> Types.describe_assessment_templates_request
val make_assessment_target : ?resource_group_arn:Types.arn -> updated_at:Types.timestamp -> created_at:Types.timestamp -> name:Types.assessment_target_name -> arn:Types.arn -> unit -> Types.assessment_target
val make_describe_assessment_targets_response : failed_items:Types.failed_items -> assessment_targets:Types.assessment_target_list -> unit -> Types.describe_assessment_targets_response
val make_describe_assessment_targets_request : assessment_target_arns:Types.batch_describe_arn_list -> unit -> Types.describe_assessment_targets_request
val make_assessment_run_state_change : state:Types.assessment_run_state -> state_changed_at:Types.timestamp -> unit -> Types.assessment_run_state_change
val make_assessment_run_notification : ?sns_publish_status_code:Types.assessment_run_notification_sns_status_code -> ?sns_topic_arn:Types.arn -> ?message:Types.message -> error:Types.bool_ -> event:Types.inspector_event -> date:Types.timestamp -> unit -> Types.assessment_run_notification
val make_assessment_run : ?completed_at:Types.timestamp -> ?started_at:Types.timestamp -> finding_counts:Types.assessment_run_finding_counts -> notifications:Types.assessment_run_notification_list -> state_changes:Types.assessment_run_state_change_list -> data_collected:Types.bool_ -> state_changed_at:Types.timestamp -> created_at:Types.timestamp -> user_attributes_for_findings:Types.user_attribute_list -> rules_package_arns:Types.assessment_rules_package_arn_list -> duration_in_seconds:Types.assessment_run_duration -> state:Types.assessment_run_state -> assessment_template_arn:Types.arn -> name:Types.assessment_run_name -> arn:Types.arn -> unit -> Types.assessment_run
val make_describe_assessment_runs_response : failed_items:Types.failed_items -> assessment_runs:Types.assessment_run_list -> unit -> Types.describe_assessment_runs_response
val make_describe_assessment_runs_request : assessment_run_arns:Types.batch_describe_arn_list -> unit -> Types.describe_assessment_runs_request
val make_delete_assessment_template_request : assessment_template_arn:Types.arn -> unit -> Types.delete_assessment_template_request
val make_delete_assessment_target_request : assessment_target_arn:Types.arn -> unit -> Types.delete_assessment_target_request
val make_delete_assessment_run_request : assessment_run_arn:Types.arn -> unit -> Types.delete_assessment_run_request
val make_create_resource_group_response : resource_group_arn:Types.arn -> unit -> Types.create_resource_group_response
val make_create_resource_group_request : resource_group_tags:Types.resource_group_tags -> unit -> Types.create_resource_group_request
val make_create_exclusions_preview_response : preview_token:Types.uui_d -> unit -> Types.create_exclusions_preview_response
val make_create_exclusions_preview_request : assessment_template_arn:Types.arn -> unit -> Types.create_exclusions_preview_request
val make_create_assessment_template_response : assessment_template_arn:Types.arn -> unit -> Types.create_assessment_template_response
val make_create_assessment_template_request : ?user_attributes_for_findings:Types.user_attribute_list -> rules_package_arns:Types.assessment_template_rules_package_arn_list -> duration_in_seconds:Types.assessment_run_duration -> assessment_template_name:Types.assessment_template_name -> assessment_target_arn:Types.arn -> unit -> Types.create_assessment_template_request
val make_create_assessment_target_response : assessment_target_arn:Types.arn -> unit -> Types.create_assessment_target_response
val make_create_assessment_target_request : ?resource_group_arn:Types.arn -> assessment_target_name:Types.assessment_target_name -> unit -> Types.create_assessment_target_request
val make_add_attributes_to_findings_response : failed_items:Types.failed_items -> unit -> Types.add_attributes_to_findings_response
val make_add_attributes_to_findings_request : attributes:Types.user_attribute_list -> finding_arns:Types.add_remove_attributes_finding_arn_list -> unit -> Types.add_attributes_to_findings_request

Operations

module AddAttributesToFindings : sig ... end

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

module CreateAssessmentTarget : sig ... end

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.

module CreateAssessmentTemplate : sig ... end

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.

module CreateExclusionsPreview : sig ... end

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.

module CreateResourceGroup : sig ... end

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.

module DeleteAssessmentRun : sig ... end

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

module DeleteAssessmentTarget : sig ... end

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

module DeleteAssessmentTemplate : sig ... end

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

module DescribeAssessmentRuns : sig ... end

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

module DescribeAssessmentTargets : sig ... end

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

module DescribeAssessmentTemplates : sig ... end

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

module DescribeCrossAccountAccessRole : sig ... end

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

module DescribeExclusions : sig ... end

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

module DescribeFindings : sig ... end

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

module DescribeResourceGroups : sig ... end

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

module DescribeRulesPackages : sig ... end

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

module GetAssessmentReport : sig ... end

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

module GetExclusionsPreview : sig ... end

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.

module GetTelemetryMetadata : sig ... end

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

module ListAssessmentRunAgents : sig ... end

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

module ListAssessmentRuns : sig ... end

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

module ListAssessmentTargets : sig ... end

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

module ListAssessmentTemplates : sig ... end

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

module ListEventSubscriptions : sig ... end

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.

module ListExclusions : sig ... end

List exclusions that are generated by the assessment run.

module ListFindings : sig ... end

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

module ListRulesPackages : sig ... end

Lists all available Amazon Inspector rules packages.

module ListTagsForResource : sig ... end

Lists all tags associated with an assessment template.

module PreviewAgents : sig ... end

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

module RegisterCrossAccountAccessRole : sig ... end

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

module RemoveAttributesFromFindings : sig ... end

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.

module SetTagsForResource : sig ... end

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

module StartAssessmentRun : sig ... end

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.

module StopAssessmentRun : sig ... end

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

module SubscribeToEvent : sig ... end

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

module UnsubscribeFromEvent : sig ... end

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

module UpdateAssessmentTarget : sig ... end
module Json_serializers : sig ... end
module Json_deserializers : sig ... end