Module Smaws_Client_CloudTrail

CloudTrail client library built on EIO.

Types

module Types : sig ... end

Builders

val make_widget : ?view_properties:Types.view_properties_map -> ?query_parameters:Types.query_parameters -> ?query_statement:Types.query_statement -> ?query_alias:Types.query_alias -> unit -> Types.widget
val make_update_trail_response : ?is_organization_trail:Types.boolean_ -> ?kms_key_id:Types.string_ -> ?cloud_watch_logs_role_arn:Types.string_ -> ?cloud_watch_logs_log_group_arn:Types.string_ -> ?log_file_validation_enabled:Types.boolean_ -> ?trail_ar_n:Types.string_ -> ?is_multi_region_trail:Types.boolean_ -> ?include_global_service_events:Types.boolean_ -> ?sns_topic_ar_n:Types.string_ -> ?sns_topic_name:Types.string_ -> ?s3_key_prefix:Types.string_ -> ?s3_bucket_name:Types.string_ -> ?name:Types.string_ -> unit -> Types.update_trail_response
val make_update_trail_request : ?is_organization_trail:Types.boolean_ -> ?kms_key_id:Types.string_ -> ?cloud_watch_logs_role_arn:Types.string_ -> ?cloud_watch_logs_log_group_arn:Types.string_ -> ?enable_log_file_validation:Types.boolean_ -> ?is_multi_region_trail:Types.boolean_ -> ?include_global_service_events:Types.boolean_ -> ?sns_topic_name:Types.string_ -> ?s3_key_prefix:Types.string_ -> ?s3_bucket_name:Types.string_ -> name:Types.string_ -> unit -> Types.update_trail_request
val make_advanced_field_selector : ?not_ends_with:Types.operator -> ?not_starts_with:Types.operator -> ?not_equals:Types.operator -> ?ends_with:Types.operator -> ?starts_with:Types.operator -> ?equals:Types.operator -> field:Types.selector_field -> unit -> Types.advanced_field_selector
val make_advanced_event_selector : ?name:Types.selector_name -> field_selectors:Types.advanced_field_selectors -> unit -> Types.advanced_event_selector
val make_update_event_data_store_response : ?federation_role_arn:Types.federation_role_arn -> ?federation_status:Types.federation_status -> ?billing_mode:Types.billing_mode -> ?kms_key_id:Types.event_data_store_kms_key_id -> ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?termination_protection_enabled:Types.termination_protection_enabled -> ?retention_period:Types.retention_period -> ?organization_enabled:Types.boolean_ -> ?multi_region_enabled:Types.boolean_ -> ?advanced_event_selectors:Types.advanced_event_selectors -> ?status:Types.event_data_store_status -> ?name:Types.event_data_store_name -> ?event_data_store_arn:Types.event_data_store_arn -> unit -> Types.update_event_data_store_response
val make_update_event_data_store_request : ?billing_mode:Types.billing_mode -> ?kms_key_id:Types.event_data_store_kms_key_id -> ?termination_protection_enabled:Types.termination_protection_enabled -> ?retention_period:Types.retention_period -> ?organization_enabled:Types.boolean_ -> ?multi_region_enabled:Types.boolean_ -> ?advanced_event_selectors:Types.advanced_event_selectors -> ?name:Types.event_data_store_name -> event_data_store:Types.event_data_store_arn -> unit -> Types.update_event_data_store_request
val make_refresh_schedule : ?time_of_day:Types.time_of_day -> ?status:Types.refresh_schedule_status -> ?frequency:Types.refresh_schedule_frequency -> unit -> Types.refresh_schedule
val make_update_dashboard_response : ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?termination_protection_enabled:Types.termination_protection_enabled -> ?refresh_schedule:Types.refresh_schedule -> ?widgets:Types.widget_list -> ?type_:Types.dashboard_type -> ?name:Types.dashboard_name -> ?dashboard_arn:Types.dashboard_arn -> unit -> Types.update_dashboard_response
val make_request_widget : ?query_parameters:Types.query_parameters -> view_properties:Types.view_properties_map -> query_statement:Types.query_statement -> unit -> Types.request_widget
val make_update_dashboard_request : ?termination_protection_enabled:Types.termination_protection_enabled -> ?refresh_schedule:Types.refresh_schedule -> ?widgets:Types.request_widget_list -> dashboard_id:Types.dashboard_arn -> unit -> Types.update_dashboard_request
val make_destination : location:Types.location -> type_:Types.destination_type -> unit -> Types.destination
val make_update_channel_response : ?destinations:Types.destinations -> ?source:Types.source -> ?name:Types.channel_name -> ?channel_arn:Types.channel_arn -> unit -> Types.update_channel_response
val make_update_channel_request : ?name:Types.channel_name -> ?destinations:Types.destinations -> channel:Types.channel_arn -> unit -> Types.update_channel_request
val make_trail_info : ?home_region:Types.string_ -> ?name:Types.string_ -> ?trail_ar_n:Types.string_ -> unit -> Types.trail_info
val make_trail : ?is_organization_trail:Types.boolean_ -> ?has_insight_selectors:Types.boolean_ -> ?has_custom_event_selectors:Types.boolean_ -> ?kms_key_id:Types.string_ -> ?cloud_watch_logs_role_arn:Types.string_ -> ?cloud_watch_logs_log_group_arn:Types.string_ -> ?log_file_validation_enabled:Types.boolean_ -> ?trail_ar_n:Types.string_ -> ?home_region:Types.string_ -> ?is_multi_region_trail:Types.boolean_ -> ?include_global_service_events:Types.boolean_ -> ?sns_topic_ar_n:Types.string_ -> ?sns_topic_name:Types.string_ -> ?s3_key_prefix:Types.string_ -> ?s3_bucket_name:Types.string_ -> ?name:Types.string_ -> unit -> Types.trail
val make_tag : ?value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_stop_logging_response : unit -> unit
val make_stop_logging_request : name:Types.string_ -> unit -> Types.stop_logging_request
val make_s3_import_source : s3_bucket_access_role_arn:Types.string_ -> s3_bucket_region:Types.string_ -> s3_location_uri:Types.string_ -> unit -> Types.s3_import_source
val make_import_source : s3:Types.s3_import_source -> unit -> Types.import_source
val make_import_statistics : ?failed_entries:Types.long -> ?events_completed:Types.long -> ?files_completed:Types.long -> ?prefixes_completed:Types.long -> ?prefixes_found:Types.long -> unit -> Types.import_statistics
val make_stop_import_response : ?import_statistics:Types.import_statistics -> ?end_event_time:Types.date -> ?start_event_time:Types.date -> ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?import_status:Types.import_status -> ?destinations:Types.import_destinations -> ?import_source:Types.import_source -> ?import_id:Types.uui_d -> unit -> Types.stop_import_response
val make_stop_import_request : import_id:Types.uui_d -> unit -> Types.stop_import_request
val make_stop_event_data_store_ingestion_response : unit -> unit
val make_stop_event_data_store_ingestion_request : event_data_store:Types.event_data_store_arn -> unit -> Types.stop_event_data_store_ingestion_request
val make_start_query_response : ?event_data_store_owner_account_id:Types.account_id -> ?query_id:Types.uui_d -> unit -> Types.start_query_response
val make_start_query_request : ?event_data_store_owner_account_id:Types.account_id -> ?query_parameters:Types.query_parameters -> ?query_alias:Types.query_alias -> ?delivery_s3_uri:Types.delivery_s3_uri -> ?query_statement:Types.query_statement -> unit -> Types.start_query_request
val make_start_logging_response : unit -> unit
val make_start_logging_request : name:Types.string_ -> unit -> Types.start_logging_request
val make_start_import_response : ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?import_status:Types.import_status -> ?end_event_time:Types.date -> ?start_event_time:Types.date -> ?import_source:Types.import_source -> ?destinations:Types.import_destinations -> ?import_id:Types.uui_d -> unit -> Types.start_import_response
val make_start_import_request : ?import_id:Types.uui_d -> ?end_event_time:Types.date -> ?start_event_time:Types.date -> ?import_source:Types.import_source -> ?destinations:Types.import_destinations -> unit -> Types.start_import_request
val make_start_event_data_store_ingestion_response : unit -> unit
val make_start_event_data_store_ingestion_request : event_data_store:Types.event_data_store_arn -> unit -> Types.start_event_data_store_ingestion_request
val make_start_dashboard_refresh_response : ?refresh_id:Types.refresh_id -> unit -> Types.start_dashboard_refresh_response
val make_start_dashboard_refresh_request : ?query_parameter_values:Types.query_parameter_values -> dashboard_id:Types.dashboard_arn -> unit -> Types.start_dashboard_refresh_request
val make_source_config : ?advanced_event_selectors:Types.advanced_event_selectors -> ?apply_to_all_regions:Types.boolean_ -> unit -> Types.source_config
val make_search_sample_queries_response : ?next_token:Types.pagination_token -> ?search_results:Types.search_sample_queries_search_results -> unit -> Types.search_sample_queries_response
val make_search_sample_queries_request : ?next_token:Types.pagination_token -> ?max_results:Types.search_sample_queries_max_results -> search_phrase:Types.search_sample_queries_search_phrase -> unit -> Types.search_sample_queries_request
val make_restore_event_data_store_response : ?billing_mode:Types.billing_mode -> ?kms_key_id:Types.event_data_store_kms_key_id -> ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?termination_protection_enabled:Types.termination_protection_enabled -> ?retention_period:Types.retention_period -> ?organization_enabled:Types.boolean_ -> ?multi_region_enabled:Types.boolean_ -> ?advanced_event_selectors:Types.advanced_event_selectors -> ?status:Types.event_data_store_status -> ?name:Types.event_data_store_name -> ?event_data_store_arn:Types.event_data_store_arn -> unit -> Types.restore_event_data_store_response
val make_restore_event_data_store_request : event_data_store:Types.event_data_store_arn -> unit -> Types.restore_event_data_store_request
val make_resource_tag : ?tags_list:Types.tags_list -> ?resource_id:Types.string_ -> unit -> Types.resource_tag
val make_resource : ?resource_name:Types.string_ -> ?resource_type:Types.string_ -> unit -> Types.resource
val make_remove_tags_response : unit -> unit
val make_remove_tags_request : tags_list:Types.tags_list -> resource_id:Types.string_ -> unit -> Types.remove_tags_request
val make_register_organization_delegated_admin_response : unit -> unit
val make_register_organization_delegated_admin_request : member_account_id:Types.account_id -> unit -> Types.register_organization_delegated_admin_request
val make_query_statistics_for_describe_query : ?creation_time:Types.date -> ?execution_time_in_millis:Types.integer -> ?bytes_scanned:Types.long -> ?events_scanned:Types.long -> ?events_matched:Types.long -> unit -> Types.query_statistics_for_describe_query
val make_query_statistics : ?bytes_scanned:Types.long -> ?total_results_count:Types.integer -> ?results_count:Types.integer -> unit -> Types.query_statistics
val make_query : ?creation_time:Types.date -> ?query_status:Types.query_status -> ?query_id:Types.uui_d -> unit -> Types.query
val make_put_resource_policy_response : ?delegated_admin_resource_policy:Types.resource_policy -> ?resource_policy:Types.resource_policy -> ?resource_arn:Types.resource_arn -> unit -> Types.put_resource_policy_response
val make_put_resource_policy_request : resource_policy:Types.resource_policy -> resource_arn:Types.resource_arn -> unit -> Types.put_resource_policy_request
val make_insight_selector : ?insight_type:Types.insight_type -> unit -> Types.insight_selector
val make_put_insight_selectors_response : ?insights_destination:Types.event_data_store_arn -> ?event_data_store_arn:Types.event_data_store_arn -> ?insight_selectors:Types.insight_selectors -> ?trail_ar_n:Types.string_ -> unit -> Types.put_insight_selectors_response
val make_put_insight_selectors_request : ?insights_destination:Types.event_data_store_arn -> ?event_data_store:Types.event_data_store_arn -> ?trail_name:Types.string_ -> insight_selectors:Types.insight_selectors -> unit -> Types.put_insight_selectors_request
val make_data_resource : ?values:Types.data_resource_values -> ?type_:Types.string_ -> unit -> Types.data_resource
val make_event_selector : ?exclude_management_event_sources:Types.exclude_management_event_sources -> ?data_resources:Types.data_resources -> ?include_management_events:Types.boolean_ -> ?read_write_type:Types.read_write_type -> unit -> Types.event_selector
val make_put_event_selectors_response : ?advanced_event_selectors:Types.advanced_event_selectors -> ?event_selectors:Types.event_selectors -> ?trail_ar_n:Types.string_ -> unit -> Types.put_event_selectors_response
val make_put_event_selectors_request : ?advanced_event_selectors:Types.advanced_event_selectors -> ?event_selectors:Types.event_selectors -> trail_name:Types.string_ -> unit -> Types.put_event_selectors_request
val make_context_key_selector : equals:Types.operator_target_list -> type_:Types.type_ -> unit -> Types.context_key_selector
val make_put_event_configuration_response : ?context_key_selectors:Types.context_key_selectors -> ?max_event_size:Types.max_event_size -> ?event_data_store_arn:Types.event_data_store_arn -> unit -> Types.put_event_configuration_response
val make_put_event_configuration_request : ?event_data_store:Types.string_ -> context_key_selectors:Types.context_key_selectors -> max_event_size:Types.max_event_size -> unit -> Types.put_event_configuration_request
val make_public_key : ?fingerprint:Types.string_ -> ?validity_end_time:Types.date -> ?validity_start_time:Types.date -> ?value:Types.byte_buffer -> unit -> Types.public_key
val make_partition_key : type_:Types.partition_key_type -> name:Types.partition_key_name -> unit -> Types.partition_key
val make_event : ?cloud_trail_event:Types.string_ -> ?resources:Types.resource_list -> ?username:Types.string_ -> ?event_source:Types.string_ -> ?event_time:Types.date -> ?access_key_id:Types.string_ -> ?read_only:Types.string_ -> ?event_name:Types.string_ -> ?event_id:Types.string_ -> unit -> Types.event
val make_lookup_events_response : ?next_token:Types.next_token -> ?events:Types.events_list -> unit -> Types.lookup_events_response
val make_lookup_attribute : attribute_value:Types.lookup_attribute_value -> attribute_key:Types.lookup_attribute_key -> unit -> Types.lookup_attribute
val make_lookup_events_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> ?event_category:Types.event_category -> ?end_time:Types.date -> ?start_time:Types.date -> ?lookup_attributes:Types.lookup_attributes_list -> unit -> Types.lookup_events_request
val make_list_trails_response : ?next_token:Types.string_ -> ?trails:Types.trails -> unit -> Types.list_trails_response
val make_list_trails_request : ?next_token:Types.string_ -> unit -> Types.list_trails_request
val make_list_tags_response : ?next_token:Types.string_ -> ?resource_tag_list:Types.resource_tag_list -> unit -> Types.list_tags_response
val make_list_tags_request : ?next_token:Types.string_ -> resource_id_list:Types.resource_id_list -> unit -> Types.list_tags_request
val make_list_queries_response : ?next_token:Types.pagination_token -> ?queries:Types.queries -> unit -> Types.list_queries_response
val make_list_queries_request : ?query_status:Types.query_status -> ?end_time:Types.date -> ?start_time:Types.date -> ?max_results:Types.list_queries_max_results_count -> ?next_token:Types.pagination_token -> event_data_store:Types.event_data_store_arn -> unit -> Types.list_queries_request
val make_list_public_keys_response : ?next_token:Types.string_ -> ?public_key_list:Types.public_key_list -> unit -> Types.list_public_keys_response
val make_list_public_keys_request : ?next_token:Types.string_ -> ?end_time:Types.date -> ?start_time:Types.date -> unit -> Types.list_public_keys_request
val make_list_insights_metric_data_response : ?next_token:Types.insights_metric_next_token -> ?values:Types.insights_metric_values -> ?timestamps:Types.timestamps -> ?error_code:Types.error_code -> ?insight_type:Types.insight_type -> ?event_name:Types.event_name -> ?event_source:Types.event_source -> unit -> Types.list_insights_metric_data_response
val make_list_insights_metric_data_request : ?next_token:Types.insights_metric_next_token -> ?max_results:Types.insights_metric_max_results -> ?data_type:Types.insights_metric_data_type -> ?period:Types.insights_metric_period -> ?end_time:Types.date -> ?start_time:Types.date -> ?error_code:Types.error_code -> insight_type:Types.insight_type -> event_name:Types.event_name -> event_source:Types.event_source -> unit -> Types.list_insights_metric_data_request
val make_imports_list_item : ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?destinations:Types.import_destinations -> ?import_status:Types.import_status -> ?import_id:Types.uui_d -> unit -> Types.imports_list_item
val make_list_imports_response : ?next_token:Types.pagination_token -> ?imports:Types.imports_list -> unit -> Types.list_imports_response
val make_list_imports_request : ?next_token:Types.pagination_token -> ?import_status:Types.import_status -> ?destination:Types.event_data_store_arn -> ?max_results:Types.list_imports_max_results_count -> unit -> Types.list_imports_request
val make_import_failure_list_item : ?last_updated_time:Types.date -> ?error_message:Types.string_ -> ?error_type:Types.string_ -> ?status:Types.import_failure_status -> ?location:Types.string_ -> unit -> Types.import_failure_list_item
val make_list_import_failures_response : ?next_token:Types.pagination_token -> ?failures:Types.import_failure_list -> unit -> Types.list_import_failures_response
val make_list_import_failures_request : ?next_token:Types.pagination_token -> ?max_results:Types.list_import_failures_max_results_count -> import_id:Types.uui_d -> unit -> Types.list_import_failures_request
val make_event_data_store : ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?retention_period:Types.retention_period -> ?organization_enabled:Types.boolean_ -> ?multi_region_enabled:Types.boolean_ -> ?advanced_event_selectors:Types.advanced_event_selectors -> ?status:Types.event_data_store_status -> ?termination_protection_enabled:Types.termination_protection_enabled -> ?name:Types.event_data_store_name -> ?event_data_store_arn:Types.event_data_store_arn -> unit -> Types.event_data_store
val make_list_event_data_stores_response : ?next_token:Types.pagination_token -> ?event_data_stores:Types.event_data_stores -> unit -> Types.list_event_data_stores_response
val make_list_event_data_stores_request : ?max_results:Types.list_event_data_stores_max_results_count -> ?next_token:Types.pagination_token -> unit -> Types.list_event_data_stores_request
val make_dashboard_detail : ?type_:Types.dashboard_type -> ?dashboard_arn:Types.dashboard_arn -> unit -> Types.dashboard_detail
val make_list_dashboards_response : ?next_token:Types.pagination_token -> ?dashboards:Types.dashboards -> unit -> Types.list_dashboards_response
val make_list_dashboards_request : ?max_results:Types.list_dashboards_max_results_count -> ?next_token:Types.pagination_token -> ?type_:Types.dashboard_type -> ?name_prefix:Types.dashboard_name -> unit -> Types.list_dashboards_request
val make_channel : ?name:Types.channel_name -> ?channel_arn:Types.channel_arn -> unit -> Types.channel
val make_list_channels_response : ?next_token:Types.pagination_token -> ?channels:Types.channels -> unit -> Types.list_channels_response
val make_list_channels_request : ?next_token:Types.pagination_token -> ?max_results:Types.list_channels_max_results_count -> unit -> Types.list_channels_request
val make_ingestion_status : ?latest_ingestion_attempt_event_i_d:Types.uui_d -> ?latest_ingestion_attempt_time:Types.date -> ?latest_ingestion_error_code:Types.error_message -> ?latest_ingestion_success_event_i_d:Types.uui_d -> ?latest_ingestion_success_time:Types.date -> unit -> Types.ingestion_status
val make_get_trail_status_response : ?time_logging_stopped:Types.string_ -> ?time_logging_started:Types.string_ -> ?latest_delivery_attempt_succeeded:Types.string_ -> ?latest_notification_attempt_succeeded:Types.string_ -> ?latest_notification_attempt_time:Types.string_ -> ?latest_delivery_attempt_time:Types.string_ -> ?latest_digest_delivery_error:Types.string_ -> ?latest_digest_delivery_time:Types.date -> ?latest_cloud_watch_logs_delivery_time:Types.date -> ?latest_cloud_watch_logs_delivery_error:Types.string_ -> ?stop_logging_time:Types.date -> ?start_logging_time:Types.date -> ?latest_notification_time:Types.date -> ?latest_delivery_time:Types.date -> ?latest_notification_error:Types.string_ -> ?latest_delivery_error:Types.string_ -> ?is_logging:Types.boolean_ -> unit -> Types.get_trail_status_response
val make_get_trail_status_request : name:Types.string_ -> unit -> Types.get_trail_status_request
val make_get_trail_response : ?trail:Types.trail -> unit -> Types.get_trail_response
val make_get_trail_request : name:Types.string_ -> unit -> Types.get_trail_request
val make_get_resource_policy_response : ?delegated_admin_resource_policy:Types.resource_policy -> ?resource_policy:Types.resource_policy -> ?resource_arn:Types.resource_arn -> unit -> Types.get_resource_policy_response
val make_get_resource_policy_request : resource_arn:Types.resource_arn -> unit -> Types.get_resource_policy_request
val make_get_query_results_response : ?error_message:Types.error_message -> ?next_token:Types.pagination_token -> ?query_result_rows:Types.query_result_rows -> ?query_statistics:Types.query_statistics -> ?query_status:Types.query_status -> unit -> Types.get_query_results_response
val make_get_query_results_request : ?event_data_store_owner_account_id:Types.account_id -> ?max_query_results:Types.max_query_results -> ?next_token:Types.pagination_token -> ?event_data_store:Types.event_data_store_arn -> query_id:Types.uui_d -> unit -> Types.get_query_results_request
val make_get_insight_selectors_response : ?insights_destination:Types.event_data_store_arn -> ?event_data_store_arn:Types.event_data_store_arn -> ?insight_selectors:Types.insight_selectors -> ?trail_ar_n:Types.string_ -> unit -> Types.get_insight_selectors_response
val make_get_insight_selectors_request : ?event_data_store:Types.event_data_store_arn -> ?trail_name:Types.string_ -> unit -> Types.get_insight_selectors_request
val make_get_import_response : ?import_statistics:Types.import_statistics -> ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?import_status:Types.import_status -> ?end_event_time:Types.date -> ?start_event_time:Types.date -> ?import_source:Types.import_source -> ?destinations:Types.import_destinations -> ?import_id:Types.uui_d -> unit -> Types.get_import_response
val make_get_import_request : import_id:Types.uui_d -> unit -> Types.get_import_request
val make_get_event_selectors_response : ?advanced_event_selectors:Types.advanced_event_selectors -> ?event_selectors:Types.event_selectors -> ?trail_ar_n:Types.string_ -> unit -> Types.get_event_selectors_response
val make_get_event_selectors_request : trail_name:Types.string_ -> unit -> Types.get_event_selectors_request
val make_get_event_data_store_response : ?partition_keys:Types.partition_key_list -> ?federation_role_arn:Types.federation_role_arn -> ?federation_status:Types.federation_status -> ?billing_mode:Types.billing_mode -> ?kms_key_id:Types.event_data_store_kms_key_id -> ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?termination_protection_enabled:Types.termination_protection_enabled -> ?retention_period:Types.retention_period -> ?organization_enabled:Types.boolean_ -> ?multi_region_enabled:Types.boolean_ -> ?advanced_event_selectors:Types.advanced_event_selectors -> ?status:Types.event_data_store_status -> ?name:Types.event_data_store_name -> ?event_data_store_arn:Types.event_data_store_arn -> unit -> Types.get_event_data_store_response
val make_get_event_data_store_request : event_data_store:Types.event_data_store_arn -> unit -> Types.get_event_data_store_request
val make_get_event_configuration_response : ?context_key_selectors:Types.context_key_selectors -> ?max_event_size:Types.max_event_size -> ?event_data_store_arn:Types.event_data_store_arn -> unit -> Types.get_event_configuration_response
val make_get_event_configuration_request : ?event_data_store:Types.string_ -> unit -> Types.get_event_configuration_request
val make_get_dashboard_response : ?termination_protection_enabled:Types.termination_protection_enabled -> ?last_refresh_failure_reason:Types.error_message -> ?last_refresh_id:Types.refresh_id -> ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?refresh_schedule:Types.refresh_schedule -> ?widgets:Types.widget_list -> ?status:Types.dashboard_status -> ?type_:Types.dashboard_type -> ?dashboard_arn:Types.dashboard_arn -> unit -> Types.get_dashboard_response
val make_get_dashboard_request : dashboard_id:Types.dashboard_arn -> unit -> Types.get_dashboard_request
val make_get_channel_response : ?ingestion_status:Types.ingestion_status -> ?destinations:Types.destinations -> ?source_config:Types.source_config -> ?source:Types.source -> ?name:Types.channel_name -> ?channel_arn:Types.channel_arn -> unit -> Types.get_channel_response
val make_get_channel_request : channel:Types.channel_arn -> unit -> Types.get_channel_request
val make_generate_query_response : ?event_data_store_owner_account_id:Types.account_id -> ?query_alias:Types.query_alias -> ?query_statement:Types.query_statement -> unit -> Types.generate_query_response
val make_generate_query_request : prompt:Types.prompt -> event_data_stores:Types.event_data_store_list -> unit -> Types.generate_query_request
val make_enable_federation_response : ?federation_role_arn:Types.federation_role_arn -> ?federation_status:Types.federation_status -> ?event_data_store_arn:Types.event_data_store_arn -> unit -> Types.enable_federation_response
val make_enable_federation_request : federation_role_arn:Types.federation_role_arn -> event_data_store:Types.event_data_store_arn -> unit -> Types.enable_federation_request
val make_disable_federation_response : ?federation_status:Types.federation_status -> ?event_data_store_arn:Types.event_data_store_arn -> unit -> Types.disable_federation_response
val make_disable_federation_request : event_data_store:Types.event_data_store_arn -> unit -> Types.disable_federation_request
val make_describe_trails_response : ?trail_list:Types.trail_list -> unit -> Types.describe_trails_response
val make_describe_trails_request : ?include_shadow_trails:Types.boolean_ -> ?trail_name_list:Types.trail_name_list -> unit -> Types.describe_trails_request
val make_describe_query_response : ?event_data_store_owner_account_id:Types.account_id -> ?prompt:Types.prompt -> ?delivery_status:Types.delivery_status -> ?delivery_s3_uri:Types.delivery_s3_uri -> ?error_message:Types.error_message -> ?query_statistics:Types.query_statistics_for_describe_query -> ?query_status:Types.query_status -> ?query_string:Types.query_statement -> ?query_id:Types.uui_d -> unit -> Types.describe_query_response
val make_describe_query_request : ?event_data_store_owner_account_id:Types.account_id -> ?refresh_id:Types.refresh_id -> ?query_alias:Types.query_alias -> ?query_id:Types.uui_d -> ?event_data_store:Types.event_data_store_arn -> unit -> Types.describe_query_request
val make_deregister_organization_delegated_admin_response : unit -> unit
val make_deregister_organization_delegated_admin_request : delegated_admin_account_id:Types.account_id -> unit -> Types.deregister_organization_delegated_admin_request
val make_delete_trail_response : unit -> unit
val make_delete_trail_request : name:Types.string_ -> unit -> Types.delete_trail_request
val make_delete_resource_policy_response : unit -> unit
val make_delete_resource_policy_request : resource_arn:Types.resource_arn -> unit -> Types.delete_resource_policy_request
val make_delete_event_data_store_response : unit -> unit
val make_delete_event_data_store_request : event_data_store:Types.event_data_store_arn -> unit -> Types.delete_event_data_store_request
val make_delete_dashboard_response : unit -> unit
val make_delete_dashboard_request : dashboard_id:Types.dashboard_arn -> unit -> Types.delete_dashboard_request
val make_delete_channel_response : unit -> unit
val make_delete_channel_request : channel:Types.channel_arn -> unit -> Types.delete_channel_request
val make_create_trail_response : ?is_organization_trail:Types.boolean_ -> ?kms_key_id:Types.string_ -> ?cloud_watch_logs_role_arn:Types.string_ -> ?cloud_watch_logs_log_group_arn:Types.string_ -> ?log_file_validation_enabled:Types.boolean_ -> ?trail_ar_n:Types.string_ -> ?is_multi_region_trail:Types.boolean_ -> ?include_global_service_events:Types.boolean_ -> ?sns_topic_ar_n:Types.string_ -> ?sns_topic_name:Types.string_ -> ?s3_key_prefix:Types.string_ -> ?s3_bucket_name:Types.string_ -> ?name:Types.string_ -> unit -> Types.create_trail_response
val make_create_trail_request : ?tags_list:Types.tags_list -> ?is_organization_trail:Types.boolean_ -> ?kms_key_id:Types.string_ -> ?cloud_watch_logs_role_arn:Types.string_ -> ?cloud_watch_logs_log_group_arn:Types.string_ -> ?enable_log_file_validation:Types.boolean_ -> ?is_multi_region_trail:Types.boolean_ -> ?include_global_service_events:Types.boolean_ -> ?sns_topic_name:Types.string_ -> ?s3_key_prefix:Types.string_ -> s3_bucket_name:Types.string_ -> name:Types.string_ -> unit -> Types.create_trail_request
val make_create_event_data_store_response : ?billing_mode:Types.billing_mode -> ?kms_key_id:Types.event_data_store_kms_key_id -> ?updated_timestamp:Types.date -> ?created_timestamp:Types.date -> ?tags_list:Types.tags_list -> ?termination_protection_enabled:Types.termination_protection_enabled -> ?retention_period:Types.retention_period -> ?organization_enabled:Types.boolean_ -> ?multi_region_enabled:Types.boolean_ -> ?advanced_event_selectors:Types.advanced_event_selectors -> ?status:Types.event_data_store_status -> ?name:Types.event_data_store_name -> ?event_data_store_arn:Types.event_data_store_arn -> unit -> Types.create_event_data_store_response
val make_create_event_data_store_request : ?billing_mode:Types.billing_mode -> ?start_ingestion:Types.boolean_ -> ?kms_key_id:Types.event_data_store_kms_key_id -> ?tags_list:Types.tags_list -> ?termination_protection_enabled:Types.termination_protection_enabled -> ?retention_period:Types.retention_period -> ?organization_enabled:Types.boolean_ -> ?multi_region_enabled:Types.boolean_ -> ?advanced_event_selectors:Types.advanced_event_selectors -> name:Types.event_data_store_name -> unit -> Types.create_event_data_store_request
val make_create_dashboard_response : ?termination_protection_enabled:Types.termination_protection_enabled -> ?refresh_schedule:Types.refresh_schedule -> ?tags_list:Types.tags_list -> ?widgets:Types.widget_list -> ?type_:Types.dashboard_type -> ?name:Types.dashboard_name -> ?dashboard_arn:Types.dashboard_arn -> unit -> Types.create_dashboard_response
val make_create_dashboard_request : ?widgets:Types.request_widget_list -> ?termination_protection_enabled:Types.termination_protection_enabled -> ?tags_list:Types.tags_list -> ?refresh_schedule:Types.refresh_schedule -> name:Types.dashboard_name -> unit -> Types.create_dashboard_request
val make_create_channel_response : ?tags:Types.tags_list -> ?destinations:Types.destinations -> ?source:Types.source -> ?name:Types.channel_name -> ?channel_arn:Types.channel_arn -> unit -> Types.create_channel_response
val make_create_channel_request : ?tags:Types.tags_list -> destinations:Types.destinations -> source:Types.source -> name:Types.channel_name -> unit -> Types.create_channel_request
val make_cancel_query_response : ?event_data_store_owner_account_id:Types.account_id -> query_status:Types.query_status -> query_id:Types.uui_d -> unit -> Types.cancel_query_response
val make_cancel_query_request : ?event_data_store_owner_account_id:Types.account_id -> ?event_data_store:Types.event_data_store_arn -> query_id:Types.uui_d -> unit -> Types.cancel_query_request
val make_add_tags_response : unit -> unit
val make_add_tags_request : tags_list:Types.tags_list -> resource_id:Types.string_ -> unit -> Types.add_tags_request

Operations

module AddTags : sig ... end

Adds one or more tags to a trail, event data store, dashboard, or channel, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home Region).

module CancelQuery : sig ... end

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished.

module CreateChannel : sig ... end

Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.

module CreateDashboard : sig ... end

Creates a custom dashboard or the Highlights dashboard.

module CreateEventDataStore : sig ... end

Creates a new event data store.

module CreateTrail : sig ... end

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

module DeleteChannel : sig ... end

Deletes a channel.

module DeleteDashboard : sig ... end

Deletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.

module DeleteEventDataStore : sig ... end

Disables the event data store specified by EventDataStore, which accepts an event data store ARN. After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store and the FederationStatus must be DISABLED. You cannot delete an event data store if TerminationProtectionEnabled is True or the FederationStatus is ENABLED.

module DeleteResourcePolicy : sig ... end

Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.

module DeleteTrail : sig ... end

Deletes a trail. This operation must be called from the Region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.

Removes CloudTrail delegated administrator permissions from a member account in an organization.

module DescribeQuery : sig ... end

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.

module DescribeTrails : sig ... end

Retrieves settings for one or more trails associated with the current Region for your account.

module DisableFederation : sig ... end

Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena.

module EnableFederation : sig ... end

Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.

module GenerateQuery : sig ... end

Generates a query from a natural language prompt. This operation uses generative artificial intelligence (generative AI) to produce a ready-to-use SQL query from the prompt.

module GetChannel : sig ... end

Returns information about a specific channel.

module GetDashboard : sig ... end

Returns the specified dashboard.

module GetEventConfiguration : sig ... end

Retrieves the current event configuration settings for the specified event data store, including details about maximum event size and context key selectors configured for the event data store.

module GetEventDataStore : sig ... end

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

module GetEventSelectors : sig ... end

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

module GetImport : sig ... end

Returns information about a specific import.

module GetInsightSelectors : sig ... end

Describes the settings for the Insights event selectors that you configured for your trail or event data store. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you run GetInsightSelectors on a trail or event data store that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException

module GetQueryResults : sig ... end

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation.

module GetResourcePolicy : sig ... end

Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.

module GetTrail : sig ... end

Returns settings information for a specified trail.

module GetTrailStatus : sig ... end

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.

module ListChannels : sig ... end

Lists the channels in the current account, and their source names.

module ListDashboards : sig ... end

Returns information about all dashboards in the account, in the current Region.

module ListEventDataStores : sig ... end

Returns information about all event data stores in the account, in the current Region.

module ListImportFailures : sig ... end

Returns a list of failures for the specified import.

module ListImports : sig ... end

Returns information on all imports, or a select set of imports by ImportStatus or Destination.

module ListInsightsMetricData : sig ... end

Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, EventName, and InsightType parameters.

module ListPublicKeys : sig ... end

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

module ListQueries : sig ... end

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

module ListTags : sig ... end

Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region.

module ListTrails : sig ... end

Lists trails that are in the current account.

module LookupEvents : sig ... end

Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days.

module PutEventConfiguration : sig ... end

Updates the event configuration settings for the specified event data store. You can update the maximum event size and context key selectors.

module PutEventSelectors : sig ... end

Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten.

module PutInsightSelectors : sig ... end

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types are ApiErrorRateInsight and ApiCallRateInsight.

module PutResourcePolicy : sig ... end

Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.

Registers an organization’s member account as the CloudTrail delegated administrator.

module RemoveTags : sig ... end

Removes the specified tags from a trail, event data store, dashboard, or channel.

module RestoreEventDataStore : sig ... end

Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.

module SearchSampleQueries : sig ... end

Searches sample queries and returns a list of sample queries that are sorted by relevance. To search for sample queries, provide a natural language SearchPhrase in English.

module StartDashboardRefresh : sig ... end

Starts a refresh of the specified dashboard.

module StartEventDataStoreIngestion : sig ... end

Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.

module StartImport : sig ... end

Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default, CloudTrail only imports events contained in the S3 bucket's CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services services. If you want to import CloudTrail events contained in another prefix, you must include the prefix in the S3LocationUri. For more considerations about importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.

module StartLogging : sig ... end

Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all Regions, this operation must be called from the Region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.

module StartQuery : sig ... end

Starts a CloudTrail Lake query. Use the QueryStatement parameter to provide your SQL query, enclosed in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to an S3 bucket.

module StopEventDataStoreIngestion : sig ... end

Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.

module StopImport : sig ... end

Stops a specified import.

module StopLogging : sig ... end

Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all Regions, this operation must be called from the Region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail enabled in all Regions.

module UpdateChannel : sig ... end

Updates a channel specified by a required channel ARN or UUID.

module UpdateDashboard : sig ... end

Updates the specified dashboard.

module UpdateEventDataStore : sig ... end

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 7 and 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.

module UpdateTrail : sig ... end

Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

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