Module Smaws_Client_Shield

Shield client library built on EIO.

Types

module Types : sig ... end

Builders

val make_validation_exception_field : message:Types.string_ -> name:Types.string_ -> unit -> Types.validation_exception_field
val make_update_subscription_response : unit -> unit
val make_update_subscription_request : ?auto_renew:Types.auto_renew -> unit -> Types.update_subscription_request
val make_update_protection_group_response : unit -> unit
val make_update_protection_group_request : ?members:Types.protection_group_members -> ?resource_type:Types.protected_resource_type -> pattern:Types.protection_group_pattern -> aggregation:Types.protection_group_aggregation -> protection_group_id:Types.protection_group_id -> unit -> Types.update_protection_group_request
val make_update_emergency_contact_settings_response : unit -> unit
val make_emergency_contact : ?contact_notes:Types.contact_notes -> ?phone_number:Types.phone_number -> email_address:Types.email_address -> unit -> Types.emergency_contact
val make_update_emergency_contact_settings_request : ?emergency_contact_list:Types.emergency_contact_list -> unit -> Types.update_emergency_contact_settings_request
val make_update_application_layer_automatic_response_response : unit -> unit
val make_block_action : unit -> unit
val make_count_action : unit -> unit
val make_response_action : ?count:Types.count_action -> ?block:Types.block_action -> unit -> Types.response_action
val make_update_application_layer_automatic_response_request : action:Types.response_action -> resource_arn:Types.resource_arn -> unit -> Types.update_application_layer_automatic_response_request
val make_untag_resource_response : unit -> unit
val make_untag_resource_request : tag_keys:Types.tag_key_list -> resource_ar_n:Types.resource_arn -> unit -> Types.untag_resource_request
val make_contributor : ?value:Types.long -> ?name:Types.string_ -> unit -> Types.contributor
val make_time_range : ?to_exclusive:Types.timestamp -> ?from_inclusive:Types.timestamp -> unit -> Types.time_range
val make_tag_resource_response : unit -> unit
val make_tag : ?value:Types.tag_value -> ?key:Types.tag_key -> unit -> Types.tag
val make_tag_resource_request : tags:Types.tag_list -> resource_ar_n:Types.resource_arn -> unit -> Types.tag_resource_request
val make_summarized_counter : ?unit_:Types.string_ -> ?n:Types.integer -> ?sum:Types.double -> ?average:Types.double -> ?max:Types.double -> ?name:Types.string_ -> unit -> Types.summarized_counter
val make_summarized_attack_vector : ?vector_counters:Types.summarized_counter_list -> vector_type:Types.string_ -> unit -> Types.summarized_attack_vector
val make_limit : ?max:Types.long -> ?type_:Types.string_ -> unit -> Types.limit
val make_protection_limits : protected_resource_type_limits:Types.limits -> unit -> Types.protection_limits
val make_protection_group_arbitrary_pattern_limits : max_members:Types.long -> unit -> Types.protection_group_arbitrary_pattern_limits
val make_protection_group_pattern_type_limits : arbitrary_pattern_limits:Types.protection_group_arbitrary_pattern_limits -> unit -> Types.protection_group_pattern_type_limits
val make_protection_group_limits : pattern_type_limits:Types.protection_group_pattern_type_limits -> max_protection_groups:Types.long -> unit -> Types.protection_group_limits
val make_subscription_limits : protection_group_limits:Types.protection_group_limits -> protection_limits:Types.protection_limits -> unit -> Types.subscription_limits
val make_subscription : ?subscription_arn:Types.resource_arn -> ?proactive_engagement_status:Types.proactive_engagement_status -> ?limits:Types.limits -> ?auto_renew:Types.auto_renew -> ?time_commitment_in_seconds:Types.duration_in_seconds -> ?end_time:Types.timestamp -> ?start_time:Types.timestamp -> subscription_limits:Types.subscription_limits -> unit -> Types.subscription
val make_sub_resource_summary : ?counters:Types.summarized_counter_list -> ?attack_vectors:Types.summarized_attack_vector_list -> ?id:Types.string_ -> ?type_:Types.sub_resource_type -> unit -> Types.sub_resource_summary
val make_application_layer_automatic_response_configuration : action:Types.response_action -> status:Types.application_layer_automatic_response_status -> unit -> Types.application_layer_automatic_response_configuration
val make_protection : ?application_layer_automatic_response_configuration: Types.application_layer_automatic_response_configuration -> ?protection_arn:Types.resource_arn -> ?health_check_ids:Types.health_check_ids -> ?resource_arn:Types.resource_arn -> ?name:Types.protection_name -> ?id:Types.protection_id -> unit -> Types.protection
val make_protection_group : ?protection_group_arn:Types.resource_arn -> ?resource_type:Types.protected_resource_type -> members:Types.protection_group_members -> pattern:Types.protection_group_pattern -> aggregation:Types.protection_group_aggregation -> protection_group_id:Types.protection_group_id -> unit -> Types.protection_group
val make_mitigation : ?mitigation_name:Types.string_ -> unit -> Types.mitigation
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_ar_n:Types.resource_arn -> unit -> Types.list_tags_for_resource_request
val make_list_resources_in_protection_group_response : ?next_token:Types.token -> resource_arns:Types.resource_arn_list -> unit -> Types.list_resources_in_protection_group_response
val make_list_resources_in_protection_group_request : ?max_results:Types.max_results -> ?next_token:Types.token -> protection_group_id:Types.protection_group_id -> unit -> Types.list_resources_in_protection_group_request
val make_list_protections_response : ?next_token:Types.token -> ?protections:Types.protections -> unit -> Types.list_protections_response
val make_inclusion_protection_filters : ?resource_types:Types.protected_resource_type_filters -> ?protection_names:Types.protection_name_filters -> ?resource_arns:Types.resource_arn_filters -> unit -> Types.inclusion_protection_filters
val make_list_protections_request : ?inclusion_filters:Types.inclusion_protection_filters -> ?max_results:Types.max_results -> ?next_token:Types.token -> unit -> Types.list_protections_request
val make_list_protection_groups_response : ?next_token:Types.token -> protection_groups:Types.protection_groups -> unit -> Types.list_protection_groups_response
val make_inclusion_protection_group_filters : ?aggregations:Types.protection_group_aggregation_filters -> ?resource_types:Types.protected_resource_type_filters -> ?patterns:Types.protection_group_pattern_filters -> ?protection_group_ids:Types.protection_group_id_filters -> unit -> Types.inclusion_protection_group_filters
val make_list_protection_groups_request : ?inclusion_filters:Types.inclusion_protection_group_filters -> ?max_results:Types.max_results -> ?next_token:Types.token -> unit -> Types.list_protection_groups_request
val make_attack_vector_description : vector_type:Types.string_ -> unit -> Types.attack_vector_description
val make_attack_summary : ?attack_vectors:Types.attack_vector_description_list -> ?end_time:Types.attack_timestamp -> ?start_time:Types.attack_timestamp -> ?resource_arn:Types.string_ -> ?attack_id:Types.string_ -> unit -> Types.attack_summary
val make_list_attacks_response : ?next_token:Types.token -> ?attack_summaries:Types.attack_summaries -> unit -> Types.list_attacks_response
val make_list_attacks_request : ?max_results:Types.max_results -> ?next_token:Types.token -> ?end_time:Types.time_range -> ?start_time:Types.time_range -> ?resource_arns:Types.resource_arn_filter_list -> unit -> Types.list_attacks_request
val make_get_subscription_state_response : subscription_state:Types.subscription_state -> unit -> Types.get_subscription_state_response
val make_get_subscription_state_request : unit -> unit
val make_enable_proactive_engagement_response : unit -> unit
val make_enable_proactive_engagement_request : unit -> unit
val make_enable_application_layer_automatic_response_response : unit -> unit
val make_enable_application_layer_automatic_response_request : action:Types.response_action -> resource_arn:Types.resource_arn -> unit -> Types.enable_application_layer_automatic_response_request
val make_disassociate_health_check_response : unit -> unit
val make_disassociate_health_check_request : health_check_arn:Types.health_check_arn -> protection_id:Types.protection_id -> unit -> Types.disassociate_health_check_request
val make_disassociate_drt_role_response : unit -> unit
val make_disassociate_drt_role_request : unit -> unit
val make_disassociate_drt_log_bucket_response : unit -> unit
val make_disassociate_drt_log_bucket_request : log_bucket:Types.log_bucket -> unit -> Types.disassociate_drt_log_bucket_request
val make_disable_proactive_engagement_response : unit -> unit
val make_disable_proactive_engagement_request : unit -> unit
val make_disable_application_layer_automatic_response_response : unit -> unit
val make_disable_application_layer_automatic_response_request : resource_arn:Types.resource_arn -> unit -> Types.disable_application_layer_automatic_response_request
val make_describe_subscription_response : ?subscription:Types.subscription -> unit -> Types.describe_subscription_response
val make_describe_subscription_request : unit -> unit
val make_describe_protection_response : ?protection:Types.protection -> unit -> Types.describe_protection_response
val make_describe_protection_request : ?resource_arn:Types.resource_arn -> ?protection_id:Types.protection_id -> unit -> Types.describe_protection_request
val make_describe_protection_group_response : protection_group:Types.protection_group -> unit -> Types.describe_protection_group_response
val make_describe_protection_group_request : protection_group_id:Types.protection_group_id -> unit -> Types.describe_protection_group_request
val make_describe_emergency_contact_settings_response : ?emergency_contact_list:Types.emergency_contact_list -> unit -> Types.describe_emergency_contact_settings_response
val make_describe_emergency_contact_settings_request : unit -> unit
val make_describe_drt_access_response : ?log_bucket_list:Types.log_bucket_list -> ?role_arn:Types.role_arn -> unit -> Types.describe_drt_access_response
val make_describe_drt_access_request : unit -> unit
val make_attack_volume_statistics : max:Types.double -> unit -> Types.attack_volume_statistics
val make_attack_volume : ?requests_per_second:Types.attack_volume_statistics -> ?packets_per_second:Types.attack_volume_statistics -> ?bits_per_second:Types.attack_volume_statistics -> unit -> Types.attack_volume
val make_attack_statistics_data_item : ?attack_volume:Types.attack_volume -> attack_count:Types.long -> unit -> Types.attack_statistics_data_item
val make_describe_attack_statistics_response : data_items:Types.attack_statistics_data_list -> time_range:Types.time_range -> unit -> Types.describe_attack_statistics_response
val make_describe_attack_statistics_request : unit -> unit
val make_attack_property : ?total:Types.long -> ?unit_:Types.unit_ -> ?top_contributors:Types.top_contributors -> ?attack_property_identifier:Types.attack_property_identifier -> ?attack_layer:Types.attack_layer -> unit -> Types.attack_property
val make_attack_detail : ?mitigations:Types.mitigation_list -> ?attack_properties:Types.attack_properties -> ?attack_counters:Types.summarized_counter_list -> ?end_time:Types.attack_timestamp -> ?start_time:Types.attack_timestamp -> ?sub_resources:Types.sub_resource_summary_list -> ?resource_arn:Types.resource_arn -> ?attack_id:Types.attack_id -> unit -> Types.attack_detail
val make_describe_attack_response : ?attack:Types.attack_detail -> unit -> Types.describe_attack_response
val make_describe_attack_request : attack_id:Types.attack_id -> unit -> Types.describe_attack_request
val make_delete_subscription_response : unit -> unit
val make_delete_subscription_request : unit -> unit
val make_delete_protection_response : unit -> unit
val make_delete_protection_request : protection_id:Types.protection_id -> unit -> Types.delete_protection_request
val make_delete_protection_group_response : unit -> unit
val make_delete_protection_group_request : protection_group_id:Types.protection_group_id -> unit -> Types.delete_protection_group_request
val make_create_subscription_response : unit -> unit
val make_create_subscription_request : unit -> unit
val make_create_protection_response : ?protection_id:Types.protection_id -> unit -> Types.create_protection_response
val make_create_protection_request : ?tags:Types.tag_list -> resource_arn:Types.resource_arn -> name:Types.protection_name -> unit -> Types.create_protection_request
val make_create_protection_group_response : unit -> unit
val make_create_protection_group_request : ?tags:Types.tag_list -> ?members:Types.protection_group_members -> ?resource_type:Types.protected_resource_type -> pattern:Types.protection_group_pattern -> aggregation:Types.protection_group_aggregation -> protection_group_id:Types.protection_group_id -> unit -> Types.create_protection_group_request
val make_associate_proactive_engagement_details_response : unit -> unit
val make_associate_proactive_engagement_details_request : emergency_contact_list:Types.emergency_contact_list -> unit -> Types.associate_proactive_engagement_details_request
val make_associate_health_check_response : unit -> unit
val make_associate_health_check_request : health_check_arn:Types.health_check_arn -> protection_id:Types.protection_id -> unit -> Types.associate_health_check_request
val make_associate_drt_role_response : unit -> unit
val make_associate_drt_role_request : role_arn:Types.role_arn -> unit -> Types.associate_drt_role_request
val make_associate_drt_log_bucket_response : unit -> unit
val make_associate_drt_log_bucket_request : log_bucket:Types.log_bucket -> unit -> Types.associate_drt_log_bucket_request

Operations

module AssociateDRTLogBucket : sig ... end

Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.

module AssociateDRTRole : sig ... end

Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.

module AssociateHealthCheck : sig ... end

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.

module CreateProtection : sig ... end

Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.

module CreateProtectionGroup : sig ... end

Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

module CreateSubscription : sig ... end

Activates Shield Advanced for an account.

module DeleteProtection : sig ... end

Deletes an Shield Advanced Protection.

module DeleteProtectionGroup : sig ... end

Removes the specified protection group.

module DeleteSubscription : sig ... end

Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

module DescribeAttack : sig ... end

Describes the details of a DDoS attack.

module DescribeAttackStatistics : sig ... end

Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.

module DescribeDRTAccess : sig ... end

Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.

A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

module DescribeProtection : sig ... end

Lists the details of a Protection object.

module DescribeProtectionGroup : sig ... end

Returns the specification for the specified protection group.

module DescribeSubscription : sig ... end

Provides details about the Shield Advanced subscription for an account.

Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.

module DisableProactiveEngagement : sig ... end

Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.

module DisassociateDRTLogBucket : sig ... end

Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.

module DisassociateDRTRole : sig ... end

Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.

module DisassociateHealthCheck : sig ... end

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.

module EnableProactiveEngagement : sig ... end

Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

module GetSubscriptionState : sig ... end

Returns the SubscriptionState, either Active or Inactive.

module ListAttacks : sig ... end

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

module ListProtectionGroups : sig ... end

Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.

module ListProtections : sig ... end

Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.

module ListResourcesInProtectionGroup : sig ... end

Retrieves the resources that are included in the protection group.

module ListTagsForResource : sig ... end

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.

module TagResource : sig ... end

Adds or updates tags for a resource in Shield.

module UntagResource : sig ... end

Removes tags from a resource in Shield.

Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.

module UpdateEmergencyContactSettings : sig ... end

Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

module UpdateProtectionGroup : sig ... end

Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

module UpdateSubscription : sig ... end

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

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