Smaws_Client_Shield.Typestype nonrec validation_exception_field = {message : string_;The message describing why the parameter failed validation.
*)name : string_;The name of the parameter that failed validation.
*)}Provides information about a particular parameter passed inside a request that resulted in an exception.
type nonrec validation_exception_field_list = validation_exception_field listtype nonrec update_subscription_request = {auto_renew : auto_renew option;When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
}type nonrec resource_not_found_exception = {resource_type : string_ option;Type of resource.
*)message : error_message option;}Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.
type nonrec invalid_parameter_exception = {fields : validation_exception_field_list option;Fields that caused the exception.
*)reason : validation_exception_reason option;Additional information about the exception.
*)message : error_message option;}Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
type nonrec protection_group_members = resource_arn listtype nonrec update_protection_group_request = {members : protection_group_members option;The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
resource_type : protected_resource_type option;The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
pattern : protection_group_pattern;The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
*)aggregation : protection_group_aggregation;Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
protection_group_id : protection_group_id;The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
*)}type nonrec emergency_contact = {contact_notes : contact_notes option;Additional notes regarding the contact.
*)phone_number : phone_number option;The phone number for the contact.
*)email_address : email_address;The email address for the contact.
*)}Contact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
type nonrec emergency_contact_list = emergency_contact listtype nonrec update_emergency_contact_settings_request = {emergency_contact_list : emergency_contact_list option;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.
If you have proactive engagement enabled, the contact list must include at least one phone number.
*)}type nonrec response_action = {count : count_action option;Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
You must specify exactly one action, either Block or Count.
block : block_action option;Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
You must specify exactly one action, either Block or Count.
}Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
type nonrec update_application_layer_automatic_response_request = {action : response_action;Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
*)resource_arn : resource_arn;The ARN (Amazon Resource Name) of the resource.
*)}Exception that indicates that the operation would not cause any change to occur.
type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;The tag key for each tag that you want to remove from the resource.
*)resource_ar_n : resource_arn;The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
*)}Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.
type nonrec contributor = {value : long option;The contribution of this contributor expressed in Protection units. For example 10,000.
name : string_ option;The name of the contributor. The type of name that you'll find here depends on the AttackPropertyIdentifier setting in the AttackProperty where this contributor is defined. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.
}A contributor to the attack and their contribution.
type nonrec top_contributors = contributor listtype nonrec time_range = {to_exclusive : timestamp option;The end time, in Unix time in seconds.
*)from_inclusive : timestamp option;The start time, in Unix time in seconds.
*)}The time range.
type nonrec tag = {value : tag_value option;Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
*)key : tag_key option;Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
*)}A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
type nonrec tag_list = tag listtype nonrec tag_resource_request = {resource_ar_n : resource_arn;The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
*)}type nonrec summarized_counter = {unit_ : string_ option;The unit of the counters.
*)n : integer option;The number of counters for a specified time period.
*)sum : double option;The total of counter values for a specified time period.
*)average : double option;The average value of the counter for a specified time period.
*)max : double option;The maximum value of the counter for a specified time period.
*)name : string_ option;The counter name.
*)}The counter that describes a DDoS attack.
type nonrec summarized_counter_list = summarized_counter listtype nonrec summarized_attack_vector = {vector_counters : summarized_counter_list option;The list of counters that describe the details of the attack.
*)vector_type : string_;The attack type, for example, SNMP reflection or SYN flood.
*)}A summary of information about the attack.
type nonrec summarized_attack_vector_list = summarized_attack_vector listtype nonrec limit = {max : long option;The maximum number of protections that can be created for the specified Type.
type_ : string_ option;The type of protection.
*)}Specifies how many protections of a given type you can create.
type nonrec limits = limit listtype nonrec protection_limits = {protected_resource_type_limits : limits;The maximum number of resource types that you can specify in a protection.
*)}Limits settings on protections for your subscription.
type nonrec protection_group_arbitrary_pattern_limits = {max_members : long;The maximum number of resources you can specify for a single arbitrary pattern in a protection group.
*)}Limits settings on protection groups with arbitrary pattern type.
type nonrec protection_group_pattern_type_limits = {arbitrary_pattern_limits : protection_group_arbitrary_pattern_limits;Limits settings on protection groups with arbitrary pattern type.
*)}Limits settings by pattern type in the protection groups for your subscription.
type nonrec protection_group_limits = {pattern_type_limits : protection_group_pattern_type_limits;Limits settings by pattern type in the protection groups for your subscription.
*)max_protection_groups : long;The maximum number of protection groups that you can have at one time.
*)}Limits settings on protection groups for your subscription.
type nonrec subscription_limits = {protection_group_limits : protection_group_limits;Limits settings on protection groups for your subscription.
*)protection_limits : protection_limits;Limits settings on protections for your subscription.
*)}Limits settings for your subscription.
type nonrec subscription = {subscription_arn : resource_arn option;The ARN (Amazon Resource Name) of the subscription.
*)subscription_limits : subscription_limits;Limits settings for your subscription.
*)proactive_engagement_status : proactive_engagement_status option;If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
limits : limits option;Specifies how many protections of a given type you can create.
*)auto_renew : auto_renew option;If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
time_commitment_in_seconds : duration_in_seconds option;The length, in seconds, of the Shield Advanced subscription for the account.
*)end_time : timestamp option;The date and time your subscription will end.
*)start_time : timestamp option;The start time of the subscription, in Unix time in seconds.
*)}Information about the Shield Advanced subscription for an account.
type nonrec sub_resource_summary = {counters : summarized_counter_list option;The counters that describe the details of the attack.
*)attack_vectors : summarized_attack_vector_list option;The list of attack types and associated counters.
*)id : string_ option;The unique identifier (ID) of the SubResource.
type_ : sub_resource_type option;The SubResource type.
}The attack information for the specified SubResource.
type nonrec sub_resource_summary_list = sub_resource_summary listtype nonrec resource_arn_list = resource_arn listtype nonrec resource_arn_filters = resource_arn listtype nonrec resource_arn_filter_list = resource_arn listtype nonrec resource_already_exists_exception = {resource_type : string_ option;The type of resource that already exists.
*)message : error_message option;}Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.
type nonrec health_check_ids = health_check_id listtype nonrec application_layer_automatic_response_configuration = {action : response_action;Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
*)status : application_layer_automatic_response_status;Indicates whether automatic application layer DDoS mitigation is enabled for the protection.
*)}The automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
type nonrec protection = {application_layer_automatic_response_configuration : application_layer_automatic_response_configuration
option;The automatic application layer DDoS mitigation settings for the protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
*)protection_arn : resource_arn option;The ARN (Amazon Resource Name) of the protection.
*)health_check_ids : health_check_ids option;The unique identifier (ID) for the Route 53 health check that's associated with the protection.
*)resource_arn : resource_arn option;The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
*)name : protection_name option;The name of the protection. For example, My CloudFront distributions.
id : protection_id option;The unique identifier (ID) of the protection.
*)}An object that represents a resource that is under DDoS protection.
type nonrec protections = protection listtype nonrec protection_name_filters = protection_name listtype nonrec protection_group = {protection_group_arn : resource_arn option;The ARN (Amazon Resource Name) of the protection group.
*)members : protection_group_members;The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
resource_type : protected_resource_type option;The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
pattern : protection_group_pattern;The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.
*)aggregation : protection_group_aggregation;Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
protection_group_id : protection_group_id;The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
*)}A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
type nonrec protection_groups = protection_group listtype nonrec protection_group_pattern_filters = protection_group_pattern listtype nonrec protection_group_id_filters = protection_group_id listtype nonrec protection_group_aggregation_filters =
protection_group_aggregation listtype nonrec protected_resource_type_filters = protected_resource_type listThe ARN of the role that you specified does not exist.
type nonrec mitigation = {mitigation_name : string_ option;The name of the mitigation taken for this attack.
*)}The mitigation applied to a DDoS attack.
type nonrec mitigation_list = mitigation listtype nonrec log_bucket_list = log_bucket listtype nonrec list_resources_in_protection_group_response = {next_token : token option;When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
resource_arns : resource_arn_list;The Amazon Resource Names (ARNs) of the resources that are included in the protection group.
*)}type nonrec list_resources_in_protection_group_request = {max_results : max_results option;The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
*)next_token : token option;When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
*)protection_group_id : protection_group_id;The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
*)}Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the prior response.
type nonrec list_protections_response = {next_token : token option;When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
protections : protections option;The array of enabled Protection objects.
}type nonrec inclusion_protection_filters = {resource_types : protected_resource_type_filters option;The type of protected resource whose protections you want to retrieve.
*)protection_names : protection_name_filters option;The name of the protection that you want to retrieve.
*)resource_arns : resource_arn_filters option;The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve.
*)}Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.
type nonrec list_protections_request = {inclusion_filters : inclusion_protection_filters option;Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.
*)max_results : max_results option;The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
*)next_token : token option;When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
*)}type nonrec list_protection_groups_response = {next_token : token option;When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
protection_groups : protection_groups;}type nonrec inclusion_protection_group_filters = {aggregations : protection_group_aggregation_filters option;The aggregation setting of the protection groups that you want to retrieve.
*)resource_types : protected_resource_type_filters option;The resource type configuration of the protection groups that you want to retrieve. In the protection group configuration, you specify the resource type when you set the group's Pattern to BY_RESOURCE_TYPE.
patterns : protection_group_pattern_filters option;The pattern specification of the protection groups that you want to retrieve.
*)protection_group_ids : protection_group_id_filters option;The ID of the protection group that you want to retrieve.
*)}Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with a specific pattern, aggregation, or resource type. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.
type nonrec list_protection_groups_request = {inclusion_filters : inclusion_protection_group_filters option;Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.
*)max_results : max_results option;The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
*)next_token : token option;When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
*)}type nonrec attack_vector_description = {vector_type : string_;The attack type. Valid values:
}Describes the attack.
type nonrec attack_vector_description_list = attack_vector_description listtype nonrec attack_summary = {attack_vectors : attack_vector_description_list option;The list of attacks for a specified time period.
*)end_time : attack_timestamp option;The end time of the attack, in Unix time in seconds.
*)start_time : attack_timestamp option;The start time of the attack, in Unix time in seconds.
*)resource_arn : string_ option;The ARN (Amazon Resource Name) of the resource that was attacked.
*)attack_id : string_ option;The unique identifier (ID) of the attack.
*)}Summarizes all DDoS attacks for a specified time period.
type nonrec attack_summaries = attack_summary listtype nonrec list_attacks_response = {next_token : token option;When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
attack_summaries : attack_summaries option;The attack information for the specified time range.
*)}type nonrec list_attacks_request = {max_results : max_results option;The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
*)next_token : token option;When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
*)end_time : time_range option;The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.
start_time : time_range option;The start of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.
resource_arns : resource_arn_filter_list option;The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this blank, all applicable resources for this account will be included.
*)}type nonrec limits_exceeded_exception = {limit : limit_number option;The threshold that would be exceeded.
*)type_ : limit_type option;The type of limit that would be exceeded.
*)message : error_message option;}Exception that indicates that the operation would exceed a limit.
type nonrec get_subscription_state_response = {subscription_state : subscription_state;The status of the subscription.
*)}type nonrec enable_application_layer_automatic_response_request = {action : response_action;Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
*)resource_arn : resource_arn;The ARN (Amazon Resource Name) of the protected resource.
*)}type nonrec disassociate_health_check_request = {health_check_arn : health_check_arn;The Amazon Resource Name (ARN) of the health check that is associated with the protection.
*)protection_id : protection_id;The unique identifier (ID) for the Protection object to remove the health check association from.
}type nonrec disassociate_drt_log_bucket_request = {log_bucket : log_bucket;The Amazon S3 bucket that contains the logs that you want to share.
*)}In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an Amazon Web Services Service.
type nonrec disable_application_layer_automatic_response_request = {resource_arn : resource_arn;The ARN (Amazon Resource Name) of the protected resource.
*)}type nonrec describe_subscription_response = {subscription : subscription option;The Shield Advanced subscription details for an account.
*)}type nonrec describe_protection_response = {protection : protection option;The Protection that you requested.
}type nonrec describe_protection_request = {resource_arn : resource_arn option;The ARN (Amazon Resource Name) of the protected Amazon Web Services resource. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.
protection_id : protection_id option;The unique identifier (ID) for the Protection object to describe. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.
}type nonrec describe_protection_group_response = {protection_group : protection_group;A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
*)}type nonrec describe_protection_group_request = {protection_group_id : protection_group_id;The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
*)}type nonrec describe_emergency_contact_settings_response = {emergency_contact_list : emergency_contact_list option;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.
*)}type nonrec describe_drt_access_response = {log_bucket_list : log_bucket_list option;The list of Amazon S3 buckets accessed by the SRT.
*)role_arn : role_arn option;The Amazon Resource Name (ARN) of the role the SRT used to access your Amazon Web Services account.
*)}type nonrec attack_volume_statistics = {max : double;The maximum attack volume observed for the given unit.
*)}Statistics objects for the various data types in AttackVolume.
type nonrec attack_volume = {requests_per_second : attack_volume_statistics option;A statistics object that uses requests per second as the unit. This is included for application level attacks, and is only available for accounts that are subscribed to Shield Advanced.
*)packets_per_second : attack_volume_statistics option;A statistics object that uses packets per second as the unit. This is included for network level attacks.
*)bits_per_second : attack_volume_statistics option;A statistics object that uses bits per second as the unit. This is included for network level attacks.
*)}Information about the volume of attacks during the time period, included in an AttackStatisticsDataItem. If the accompanying AttackCount in the statistics object is zero, this setting might be empty.
type nonrec attack_statistics_data_item = {attack_count : long;The number of attacks detected during the time period. This is always present, but might be zero.
*)attack_volume : attack_volume option;Information about the volume of attacks during the time period. If the accompanying AttackCount is zero, this setting might be empty.
}A single attack statistics data record. This is returned by DescribeAttackStatistics along with a time range indicating the time period that the attack statistics apply to.
type nonrec attack_statistics_data_list = attack_statistics_data_item listtype nonrec describe_attack_statistics_response = {data_items : attack_statistics_data_list;The data that describes the attacks detected during the time period.
*)time_range : time_range;The time range of the attack.
*)}type nonrec attack_property = {total : long option;The total contributions made to this Shield event by all contributors.
*)unit_ : unit_ option;The unit used for the Contributor Value property.
top_contributors : top_contributors option;Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that Shield Advanced identifies as responsible for some or all of an event.
*)attack_property_identifier : attack_property_identifier option;Defines the Shield event property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective pingback events.
attack_layer : attack_layer option;The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.
For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.
*)}Details of a Shield event. This is provided as part of an AttackDetail.
type nonrec attack_properties = attack_property listtype nonrec attack_detail = {mitigations : mitigation_list option;List of mitigation actions taken for the attack.
*)attack_properties : attack_properties option;The array of objects that provide details of the Shield event.
For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.
*)attack_counters : summarized_counter_list option;List of counters that describe the attack for the specified time period.
*)end_time : attack_timestamp option;The time the attack ended, in Unix time in seconds.
*)start_time : attack_timestamp option;The time the attack started, in Unix time in seconds.
*)sub_resources : sub_resource_summary_list option;If applicable, additional detail about the resource being attacked, for example, IP address or URL.
*)resource_arn : resource_arn option;The ARN (Amazon Resource Name) of the resource that was attacked.
*)attack_id : attack_id option;The unique identifier (ID) of the attack.
*)}The details of a DDoS attack.
type nonrec describe_attack_response = {attack : attack_detail option;The attack that you requested.
*)}type nonrec describe_attack_request = {attack_id : attack_id;The unique identifier (ID) for the attack.
*)}Exception that indicates the specified AttackId does not exist, or the requester does not have the appropriate permissions to access the AttackId.
type nonrec delete_protection_request = {protection_id : protection_id;The unique identifier (ID) for the Protection object to be deleted.
}type nonrec delete_protection_group_request = {protection_group_id : protection_group_id;The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
*)}type nonrec create_protection_response = {protection_id : protection_id option;The unique identifier (ID) for the Protection object that is created.
}type nonrec create_protection_request = {resource_arn : resource_arn;The ARN (Amazon Resource Name) of the resource to be protected.
The ARN should be in one of the following formats:
For an Application Load Balancer:
arn:aws:elasticloadbalancing:{i region}:{i account-id}:loadbalancer/app/{i load-balancer-name}/{i load-balancer-id} For an Elastic Load Balancer (Classic Load Balancer):
arn:aws:elasticloadbalancing:{i region}:{i account-id}:loadbalancer/{i load-balancer-name} For an Amazon CloudFront distribution:
arn:aws:cloudfront::{i account-id}:distribution/{i distribution-id} For an Global Accelerator standard accelerator:
arn:aws:globalaccelerator::{i account-id}:accelerator/{i accelerator-id} For Amazon Route 53:
arn:aws:route53:::hostedzone/{i hosted-zone-id} For an Elastic IP address:
arn:aws:ec2:{i region}:{i account-id}:eip-allocation/{i allocation-id} name : protection_name;Friendly name for the Protection you are creating.
}type nonrec create_protection_group_request = {members : protection_group_members option;The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
resource_type : protected_resource_type option;The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
pattern : protection_group_pattern;The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
*)aggregation : protection_group_aggregation;Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
protection_group_id : protection_group_id;The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
*)}type nonrec associate_proactive_engagement_details_request = {emergency_contact_list : emergency_contact_list;A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.
To enable proactive engagement, the contact list must include at least one phone number.
The contacts that you provide here replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it here.
}type nonrec associate_health_check_request = {health_check_arn : health_check_arn;The Amazon Resource Name (ARN) of the health check to associate with the protection.
*)protection_id : protection_id;The unique identifier (ID) for the Protection object to add the health check association to.
}type nonrec associate_drt_role_request = {role_arn : role_arn;The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services account.
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.
}type nonrec associate_drt_log_bucket_request = {log_bucket : log_bucket;The Amazon S3 bucket that contains the logs that you want to share.
*)}