package smaws-clients

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type validation_exception_reason =
  1. | OTHER
  2. | FIELD_VALIDATION_FAILED
type validation_exception_field = {
  1. message : string;
  2. name : string;
}
type update_subscription_response = unit
type auto_renew =
  1. | DISABLED
  2. | ENABLED
type update_subscription_request = {
  1. auto_renew : auto_renew option;
}
type resource_not_found_exception = {
  1. resource_type : string option;
  2. message : string option;
}
type optimistic_lock_exception = {
  1. message : string option;
}
type locked_subscription_exception = {
  1. message : string option;
}
type invalid_parameter_exception = {
  1. fields : validation_exception_field list option;
  2. reason : validation_exception_reason option;
  3. message : string option;
}
type internal_error_exception = {
  1. message : string option;
}
type update_protection_group_response = unit
type protection_group_aggregation =
  1. | MAX
  2. | MEAN
  3. | SUM
type protection_group_pattern =
  1. | BY_RESOURCE_TYPE
  2. | ARBITRARY
  3. | ALL
type protected_resource_type =
  1. | GLOBAL_ACCELERATOR
  2. | APPLICATION_LOAD_BALANCER
  3. | CLASSIC_LOAD_BALANCER
  4. | ELASTIC_IP_ALLOCATION
  5. | ROUTE_53_HOSTED_ZONE
  6. | CLOUDFRONT_DISTRIBUTION
type update_protection_group_request = {
  1. members : string list option;
  2. resource_type : protected_resource_type option;
  3. pattern : protection_group_pattern;
  4. aggregation : protection_group_aggregation;
  5. protection_group_id : string;
}
type update_emergency_contact_settings_response = unit
type emergency_contact = {
  1. contact_notes : string option;
  2. phone_number : string option;
  3. email_address : string;
}
type update_emergency_contact_settings_request = {
  1. emergency_contact_list : emergency_contact list option;
}
type update_application_layer_automatic_response_response = unit
type block_action = unit
type count_action = unit
type response_action = {
  1. count : count_action option;
  2. block : block_action option;
}
type update_application_layer_automatic_response_request = {
  1. action : response_action;
  2. resource_arn : string;
}
type invalid_operation_exception = {
  1. message : string option;
}
type untag_resource_response = unit
type untag_resource_request = {
  1. tag_keys : string list;
  2. resource_ar_n : string;
}
type invalid_resource_exception = {
  1. message : string option;
}
type unit_ =
  1. | REQUESTS
  2. | PACKETS
  3. | BYTES
  4. | BITS
type contributor = {
  1. value : int option;
  2. name : string option;
}
type time_range = {
  1. to_exclusive : float option;
  2. from_inclusive : float option;
}
type tag_resource_response = unit
type tag = {
  1. value : string option;
  2. key : string option;
}
type tag_resource_request = {
  1. tags : tag list;
  2. resource_ar_n : string;
}
type summarized_counter = {
  1. unit_ : string option;
  2. n : int option;
  3. sum : float option;
  4. average : float option;
  5. max : float option;
  6. name : string option;
}
type summarized_attack_vector = {
  1. vector_counters : summarized_counter list option;
  2. vector_type : string;
}
type subscription_state =
  1. | INACTIVE
  2. | ACTIVE
type limit = {
  1. max : int option;
  2. type_ : string option;
}
type protection_limits = {
  1. protected_resource_type_limits : limit list;
}
type protection_group_arbitrary_pattern_limits = {
  1. max_members : int;
}
type protection_group_pattern_type_limits = {
  1. arbitrary_pattern_limits : protection_group_arbitrary_pattern_limits;
}
type protection_group_limits = {
  1. pattern_type_limits : protection_group_pattern_type_limits;
  2. max_protection_groups : int;
}
type subscription_limits = {
  1. protection_group_limits : protection_group_limits;
  2. protection_limits : protection_limits;
}
type proactive_engagement_status =
  1. | PENDING
  2. | DISABLED
  3. | ENABLED
type subscription = {
  1. subscription_arn : string option;
  2. subscription_limits : subscription_limits;
  3. proactive_engagement_status : proactive_engagement_status option;
  4. limits : limit list option;
  5. auto_renew : auto_renew option;
  6. time_commitment_in_seconds : int option;
  7. end_time : float option;
  8. start_time : float option;
}
type sub_resource_type =
  1. | URL
  2. | IP
type sub_resource_summary = {
  1. counters : summarized_counter list option;
  2. attack_vectors : summarized_attack_vector list option;
  3. id : string option;
  4. type_ : sub_resource_type option;
}
type resource_already_exists_exception = {
  1. resource_type : string option;
  2. message : string option;
}
type application_layer_automatic_response_status =
  1. | DISABLED
  2. | ENABLED
type application_layer_automatic_response_configuration = {
  1. action : response_action;
  2. status : application_layer_automatic_response_status;
}
type protection = {
  1. application_layer_automatic_response_configuration : application_layer_automatic_response_configuration option;
  2. protection_arn : string option;
  3. health_check_ids : string list option;
  4. resource_arn : string option;
  5. name : string option;
  6. id : string option;
}
type protection_group = {
  1. protection_group_arn : string option;
  2. members : string list;
  3. resource_type : protected_resource_type option;
  4. pattern : protection_group_pattern;
  5. aggregation : protection_group_aggregation;
  6. protection_group_id : string;
}
type no_associated_role_exception = {
  1. message : string option;
}
type mitigation = {
  1. mitigation_name : string option;
}
type list_tags_for_resource_response = {
  1. tags : tag list option;
}
type list_tags_for_resource_request = {
  1. resource_ar_n : string;
}
type list_resources_in_protection_group_response = {
  1. next_token : string option;
  2. resource_arns : string list;
}
type list_resources_in_protection_group_request = {
  1. max_results : int option;
  2. next_token : string option;
  3. protection_group_id : string;
}
type invalid_pagination_token_exception = {
  1. message : string option;
}
type list_protections_response = {
  1. next_token : string option;
  2. protections : protection list option;
}
type inclusion_protection_filters = {
  1. resource_types : protected_resource_type list option;
  2. protection_names : string list option;
  3. resource_arns : string list option;
}
type list_protections_request = {
  1. inclusion_filters : inclusion_protection_filters option;
  2. max_results : int option;
  3. next_token : string option;
}
type list_protection_groups_response = {
  1. next_token : string option;
  2. protection_groups : protection_group list;
}
type inclusion_protection_group_filters = {
  1. aggregations : protection_group_aggregation list option;
  2. resource_types : protected_resource_type list option;
  3. patterns : protection_group_pattern list option;
  4. protection_group_ids : string list option;
}
type list_protection_groups_request = {
  1. inclusion_filters : inclusion_protection_group_filters option;
  2. max_results : int option;
  3. next_token : string option;
}
type attack_vector_description = {
  1. vector_type : string;
}
type attack_summary = {
  1. attack_vectors : attack_vector_description list option;
  2. end_time : float option;
  3. start_time : float option;
  4. resource_arn : string option;
  5. attack_id : string option;
}
type list_attacks_response = {
  1. next_token : string option;
  2. attack_summaries : attack_summary list option;
}
type list_attacks_request = {
  1. max_results : int option;
  2. next_token : string option;
  3. end_time : time_range option;
  4. start_time : time_range option;
  5. resource_arns : string list option;
}
type limits_exceeded_exception = {
  1. limit : int option;
  2. type_ : string option;
  3. message : string option;
}
type get_subscription_state_response = {
  1. subscription_state : subscription_state;
}
type get_subscription_state_request = unit
type enable_proactive_engagement_response = unit
type enable_proactive_engagement_request = unit
type enable_application_layer_automatic_response_response = unit
type enable_application_layer_automatic_response_request = {
  1. action : response_action;
  2. resource_arn : string;
}
type disassociate_health_check_response = unit
type disassociate_health_check_request = {
  1. health_check_arn : string;
  2. protection_id : string;
}
type disassociate_drt_role_response = unit
type disassociate_drt_role_request = unit
type disassociate_drt_log_bucket_response = unit
type disassociate_drt_log_bucket_request = {
  1. log_bucket : string;
}
type access_denied_for_dependency_exception = {
  1. message : string option;
}
type disable_proactive_engagement_response = unit
type disable_proactive_engagement_request = unit
type disable_application_layer_automatic_response_response = unit
type disable_application_layer_automatic_response_request = {
  1. resource_arn : string;
}
type describe_subscription_response = {
  1. subscription : subscription option;
}
type describe_subscription_request = unit
type describe_protection_response = {
  1. protection : protection option;
}
type describe_protection_request = {
  1. resource_arn : string option;
  2. protection_id : string option;
}
type describe_protection_group_response = {
  1. protection_group : protection_group;
}
type describe_protection_group_request = {
  1. protection_group_id : string;
}
type describe_emergency_contact_settings_response = {
  1. emergency_contact_list : emergency_contact list option;
}
type describe_emergency_contact_settings_request = unit
type describe_drt_access_response = {
  1. log_bucket_list : string list option;
  2. role_arn : string option;
}
type describe_drt_access_request = unit
type attack_volume_statistics = {
  1. max : float;
}
type attack_volume = {
  1. requests_per_second : attack_volume_statistics option;
  2. packets_per_second : attack_volume_statistics option;
  3. bits_per_second : attack_volume_statistics option;
}
type attack_statistics_data_item = {
  1. attack_count : int;
  2. attack_volume : attack_volume option;
}
type describe_attack_statistics_response = {
  1. data_items : attack_statistics_data_item list;
  2. time_range : time_range;
}
type describe_attack_statistics_request = unit
type attack_layer =
  1. | APPLICATION
  2. | NETWORK
type attack_property_identifier =
  1. | WORDPRESS_PINGBACK_SOURCE
  2. | WORDPRESS_PINGBACK_REFLECTOR
  3. | SOURCE_USER_AGENT
  4. | SOURCE_IP_ADDRESS
  5. | SOURCE_COUNTRY
  6. | SOURCE_ASN
  7. | REFERRER
  8. | DESTINATION_URL
type attack_property = {
  1. total : int option;
  2. unit_ : unit_ option;
  3. top_contributors : contributor list option;
  4. attack_property_identifier : attack_property_identifier option;
  5. attack_layer : attack_layer option;
}
type attack_detail = {
  1. mitigations : mitigation list option;
  2. attack_properties : attack_property list option;
  3. attack_counters : summarized_counter list option;
  4. end_time : float option;
  5. start_time : float option;
  6. sub_resources : sub_resource_summary list option;
  7. resource_arn : string option;
  8. attack_id : string option;
}
type describe_attack_response = {
  1. attack : attack_detail option;
}
type describe_attack_request = {
  1. attack_id : string;
}
type access_denied_exception = {
  1. message : string option;
}
type delete_subscription_response = unit
type delete_subscription_request = unit
type delete_protection_response = unit
type delete_protection_request = {
  1. protection_id : string;
}
type delete_protection_group_response = unit
type delete_protection_group_request = {
  1. protection_group_id : string;
}
type create_subscription_response = unit
type create_subscription_request = unit
type create_protection_response = {
  1. protection_id : string option;
}
type create_protection_request = {
  1. tags : tag list option;
  2. resource_arn : string;
  3. name : string;
}
type create_protection_group_response = unit
type create_protection_group_request = {
  1. tags : tag list option;
  2. members : string list option;
  3. resource_type : protected_resource_type option;
  4. pattern : protection_group_pattern;
  5. aggregation : protection_group_aggregation;
  6. protection_group_id : string;
}
type associate_proactive_engagement_details_response = unit
type associate_proactive_engagement_details_request = {
  1. emergency_contact_list : emergency_contact list;
}
type associate_health_check_response = unit
type associate_health_check_request = {
  1. health_check_arn : string;
  2. protection_id : string;
}
type associate_drt_role_response = unit
type associate_drt_role_request = {
  1. role_arn : string;
}
type associate_drt_log_bucket_response = unit
type associate_drt_log_bucket_request = {
  1. log_bucket : string;
}
type base_document = Smaws_Lib.Json.t
val make_validation_exception_field : message:string -> name:string -> unit -> validation_exception_field
val make_update_subscription_response : unit -> update_subscription_response
val make_update_subscription_request : ?auto_renew:auto_renew -> unit -> update_subscription_request
val make_update_protection_group_response : unit -> update_protection_group_response
val make_update_protection_group_request : ?members:string list -> ?resource_type:protected_resource_type -> pattern:protection_group_pattern -> aggregation:protection_group_aggregation -> protection_group_id:string -> unit -> update_protection_group_request
val make_update_emergency_contact_settings_response : unit -> update_emergency_contact_settings_response
val make_emergency_contact : ?contact_notes:string -> ?phone_number:string -> email_address:string -> unit -> emergency_contact
val make_update_emergency_contact_settings_request : ?emergency_contact_list:emergency_contact list -> unit -> update_emergency_contact_settings_request
val make_update_application_layer_automatic_response_response : unit -> update_application_layer_automatic_response_response
val make_block_action : unit -> block_action
val make_count_action : unit -> count_action
val make_response_action : ?count:count_action -> ?block:block_action -> unit -> response_action
val make_update_application_layer_automatic_response_request : action:response_action -> resource_arn:string -> unit -> update_application_layer_automatic_response_request
val make_untag_resource_response : unit -> untag_resource_response
val make_untag_resource_request : tag_keys:string list -> resource_ar_n:string -> unit -> untag_resource_request
val make_contributor : ?value:int -> ?name:string -> unit -> contributor
val make_time_range : ?to_exclusive:float -> ?from_inclusive:float -> unit -> time_range
val make_tag_resource_response : unit -> tag_resource_response
val make_tag : ?value:string -> ?key:string -> unit -> tag
val make_tag_resource_request : tags:tag list -> resource_ar_n:string -> unit -> tag_resource_request
val make_summarized_counter : ?unit_:string -> ?n:int -> ?sum:float -> ?average:float -> ?max:float -> ?name:string -> unit -> summarized_counter
val make_summarized_attack_vector : ?vector_counters:summarized_counter list -> vector_type:string -> unit -> summarized_attack_vector
val make_limit : ?max:int -> ?type_:string -> unit -> limit
val make_protection_limits : protected_resource_type_limits:limit list -> unit -> protection_limits
val make_protection_group_arbitrary_pattern_limits : max_members:int -> unit -> protection_group_arbitrary_pattern_limits
val make_protection_group_pattern_type_limits : arbitrary_pattern_limits:protection_group_arbitrary_pattern_limits -> unit -> protection_group_pattern_type_limits
val make_protection_group_limits : pattern_type_limits:protection_group_pattern_type_limits -> max_protection_groups:int -> unit -> protection_group_limits
val make_subscription_limits : protection_group_limits:protection_group_limits -> protection_limits:protection_limits -> unit -> subscription_limits
val make_subscription : ?subscription_arn:string -> ?proactive_engagement_status:proactive_engagement_status -> ?limits:limit list -> ?auto_renew:auto_renew -> ?time_commitment_in_seconds:int -> ?end_time:float -> ?start_time:float -> subscription_limits:subscription_limits -> unit -> subscription
val make_sub_resource_summary : ?counters:summarized_counter list -> ?attack_vectors:summarized_attack_vector list -> ?id:string -> ?type_:sub_resource_type -> unit -> sub_resource_summary
val make_application_layer_automatic_response_configuration : action:response_action -> status:application_layer_automatic_response_status -> unit -> application_layer_automatic_response_configuration
val make_protection : ?application_layer_automatic_response_configuration: application_layer_automatic_response_configuration -> ?protection_arn:string -> ?health_check_ids:string list -> ?resource_arn:string -> ?name:string -> ?id:string -> unit -> protection
val make_protection_group : ?protection_group_arn:string -> ?resource_type:protected_resource_type -> members:string list -> pattern:protection_group_pattern -> aggregation:protection_group_aggregation -> protection_group_id:string -> unit -> protection_group
val make_mitigation : ?mitigation_name:string -> unit -> mitigation
val make_list_tags_for_resource_response : ?tags:tag list -> unit -> list_tags_for_resource_response
val make_list_tags_for_resource_request : resource_ar_n:string -> unit -> list_tags_for_resource_request
val make_list_resources_in_protection_group_response : ?next_token:string -> resource_arns:string list -> unit -> list_resources_in_protection_group_response
val make_list_resources_in_protection_group_request : ?max_results:int -> ?next_token:string -> protection_group_id:string -> unit -> list_resources_in_protection_group_request
val make_list_protections_response : ?next_token:string -> ?protections:protection list -> unit -> list_protections_response
val make_inclusion_protection_filters : ?resource_types:protected_resource_type list -> ?protection_names:string list -> ?resource_arns:string list -> unit -> inclusion_protection_filters
val make_list_protections_request : ?inclusion_filters:inclusion_protection_filters -> ?max_results:int -> ?next_token:string -> unit -> list_protections_request
val make_list_protection_groups_response : ?next_token:string -> protection_groups:protection_group list -> unit -> list_protection_groups_response
val make_inclusion_protection_group_filters : ?aggregations:protection_group_aggregation list -> ?resource_types:protected_resource_type list -> ?patterns:protection_group_pattern list -> ?protection_group_ids:string list -> unit -> inclusion_protection_group_filters
val make_list_protection_groups_request : ?inclusion_filters:inclusion_protection_group_filters -> ?max_results:int -> ?next_token:string -> unit -> list_protection_groups_request
val make_attack_vector_description : vector_type:string -> unit -> attack_vector_description
val make_attack_summary : ?attack_vectors:attack_vector_description list -> ?end_time:float -> ?start_time:float -> ?resource_arn:string -> ?attack_id:string -> unit -> attack_summary
val make_list_attacks_response : ?next_token:string -> ?attack_summaries:attack_summary list -> unit -> list_attacks_response
val make_list_attacks_request : ?max_results:int -> ?next_token:string -> ?end_time:time_range -> ?start_time:time_range -> ?resource_arns:string list -> unit -> list_attacks_request
val make_get_subscription_state_response : subscription_state:subscription_state -> unit -> get_subscription_state_response
val make_get_subscription_state_request : unit -> get_subscription_state_request
val make_enable_proactive_engagement_response : unit -> enable_proactive_engagement_response
val make_enable_proactive_engagement_request : unit -> enable_proactive_engagement_request
val make_enable_application_layer_automatic_response_response : unit -> enable_application_layer_automatic_response_response
val make_enable_application_layer_automatic_response_request : action:response_action -> resource_arn:string -> unit -> enable_application_layer_automatic_response_request
val make_disassociate_health_check_response : unit -> disassociate_health_check_response
val make_disassociate_health_check_request : health_check_arn:string -> protection_id:string -> unit -> disassociate_health_check_request
val make_disassociate_drt_role_response : unit -> disassociate_drt_role_response
val make_disassociate_drt_role_request : unit -> disassociate_drt_role_request
val make_disassociate_drt_log_bucket_response : unit -> disassociate_drt_log_bucket_response
val make_disassociate_drt_log_bucket_request : log_bucket:string -> unit -> disassociate_drt_log_bucket_request
val make_disable_proactive_engagement_response : unit -> disable_proactive_engagement_response
val make_disable_proactive_engagement_request : unit -> disable_proactive_engagement_request
val make_disable_application_layer_automatic_response_response : unit -> disable_application_layer_automatic_response_response
val make_disable_application_layer_automatic_response_request : resource_arn:string -> unit -> disable_application_layer_automatic_response_request
val make_describe_subscription_response : ?subscription:subscription -> unit -> describe_subscription_response
val make_describe_subscription_request : unit -> describe_subscription_request
val make_describe_protection_response : ?protection:protection -> unit -> describe_protection_response
val make_describe_protection_request : ?resource_arn:string -> ?protection_id:string -> unit -> describe_protection_request
val make_describe_protection_group_response : protection_group:protection_group -> unit -> describe_protection_group_response
val make_describe_protection_group_request : protection_group_id:string -> unit -> describe_protection_group_request
val make_describe_emergency_contact_settings_response : ?emergency_contact_list:emergency_contact list -> unit -> describe_emergency_contact_settings_response
val make_describe_emergency_contact_settings_request : unit -> describe_emergency_contact_settings_request
val make_describe_drt_access_response : ?log_bucket_list:string list -> ?role_arn:string -> unit -> describe_drt_access_response
val make_describe_drt_access_request : unit -> describe_drt_access_request
val make_attack_volume_statistics : max:float -> unit -> attack_volume_statistics
val make_attack_volume : ?requests_per_second:attack_volume_statistics -> ?packets_per_second:attack_volume_statistics -> ?bits_per_second:attack_volume_statistics -> unit -> attack_volume
val make_attack_statistics_data_item : ?attack_volume:attack_volume -> attack_count:int -> unit -> attack_statistics_data_item
val make_describe_attack_statistics_response : data_items:attack_statistics_data_item list -> time_range:time_range -> unit -> describe_attack_statistics_response
val make_describe_attack_statistics_request : unit -> describe_attack_statistics_request
val make_attack_property : ?total:int -> ?unit_:unit_ -> ?top_contributors:contributor list -> ?attack_property_identifier:attack_property_identifier -> ?attack_layer:attack_layer -> unit -> attack_property
val make_attack_detail : ?mitigations:mitigation list -> ?attack_properties:attack_property list -> ?attack_counters:summarized_counter list -> ?end_time:float -> ?start_time:float -> ?sub_resources:sub_resource_summary list -> ?resource_arn:string -> ?attack_id:string -> unit -> attack_detail
val make_describe_attack_response : ?attack:attack_detail -> unit -> describe_attack_response
val make_describe_attack_request : attack_id:string -> unit -> describe_attack_request
val make_delete_subscription_response : unit -> delete_subscription_response
val make_delete_subscription_request : unit -> delete_subscription_request
val make_delete_protection_response : unit -> delete_protection_response
val make_delete_protection_request : protection_id:string -> unit -> delete_protection_request
val make_delete_protection_group_response : unit -> delete_protection_group_response
val make_delete_protection_group_request : protection_group_id:string -> unit -> delete_protection_group_request
val make_create_subscription_response : unit -> create_subscription_response
val make_create_subscription_request : unit -> create_subscription_request
val make_create_protection_response : ?protection_id:string -> unit -> create_protection_response
val make_create_protection_request : ?tags:tag list -> resource_arn:string -> name:string -> unit -> create_protection_request
val make_create_protection_group_response : unit -> create_protection_group_response
val make_create_protection_group_request : ?tags:tag list -> ?members:string list -> ?resource_type:protected_resource_type -> pattern:protection_group_pattern -> aggregation:protection_group_aggregation -> protection_group_id:string -> unit -> create_protection_group_request
val make_associate_proactive_engagement_details_response : unit -> associate_proactive_engagement_details_response
val make_associate_proactive_engagement_details_request : emergency_contact_list:emergency_contact list -> unit -> associate_proactive_engagement_details_request
val make_associate_health_check_response : unit -> associate_health_check_response
val make_associate_health_check_request : health_check_arn:string -> protection_id:string -> unit -> associate_health_check_request
val make_associate_drt_role_response : unit -> associate_drt_role_response
val make_associate_drt_role_request : role_arn:string -> unit -> associate_drt_role_request
val make_associate_drt_log_bucket_response : unit -> associate_drt_log_bucket_response
val make_associate_drt_log_bucket_request : log_bucket:string -> unit -> associate_drt_log_bucket_request
module UpdateSubscription : sig ... end
module UpdateProtectionGroup : sig ... end
module UpdateEmergencyContactSettings : sig ... end
module UntagResource : sig ... end
module TagResource : sig ... end
module ListTagsForResource : sig ... end
module ListResourcesInProtectionGroup : sig ... end
module ListProtections : sig ... end
module ListProtectionGroups : sig ... end
module ListAttacks : sig ... end
module GetSubscriptionState : sig ... end
module EnableProactiveEngagement : sig ... end
module DisassociateHealthCheck : sig ... end
module DisassociateDRTRole : sig ... end
module DisassociateDRTLogBucket : sig ... end
module DisableProactiveEngagement : sig ... end
module DescribeSubscription : sig ... end
module DescribeProtectionGroup : sig ... end
module DescribeProtection : sig ... end
module DescribeDRTAccess : sig ... end
module DescribeAttackStatistics : sig ... end
module DescribeAttack : sig ... end
module DeleteSubscription : sig ... end
module DeleteProtectionGroup : sig ... end
module DeleteProtection : sig ... end
module CreateSubscription : sig ... end
module CreateProtectionGroup : sig ... end
module CreateProtection : sig ... end
module AssociateHealthCheck : sig ... end
module AssociateDRTRole : sig ... end
module AssociateDRTLogBucket : sig ... end
OCaml

Innovation. Community. Security.