2026/11/20 - AWS WAFV2 - 5 new8 updated api methods
Changes This release adds AI Security AMR configuration and five read-only APIs for AWS WAF API Security events. Use ListEvents and ListEventsByWebACL to list events, GetEvent to get event details including the timeline, and ListEventActors and GetEventActor to view the clients attributed to events
Retrieves a paginated list of the event actors in your account that are associated with events in the specified time window. An event actor is a client that is associated with one or more events. The operation returns up to the top 100 event actors by event count. Results are paginated. Use the NextMarker value from the response to retrieve the next batch of results. Currently, this operation supports API Security Amazon Web Services Managed Rules.
See also: AWS API Documentation
Request Syntax
client.list_event_actors(
Scope='CLOUDFRONT'|'REGIONAL',
TimeWindow={
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
SortBy='EVENT_COUNT',
Limit=123,
NextMarker='string'
)
string
[REQUIRED]
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
dict
[REQUIRED]
The time range for the event actors to return. The time window can't be longer than one year.
StartTime (datetime) -- [REQUIRED]
The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.
EndTime (datetime) -- [REQUIRED]
The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.
string
The field to sort event actors by. The only supported value is EVENT_COUNT.
integer
The maximum number of event actors that you want WAF to return for this request. Valid values are 1 to 100. If more event actors are available, WAF returns a NextMarker value in the response that you can use in a subsequent call to get the next batch of event actors.
string
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
dict
Response Syntax
{
'EventActors': [
{
'EventActorId': 'string',
'ClientIp': 'string',
'TlsFingerprint': 'string',
'Asn': 'string',
'AsnOrganization': 'string',
'Country': 'string',
'AuthFingerprint': 'string',
'CreatedAt': datetime(2015, 1, 1),
'EventCount': 123
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
EventActors (list) --
The list of event actor summaries.
(dict) --
High-level information about an event actor, returned by ListEventActors.
EventActorId (string) --
The unique identifier of the event actor. You provide this to GetEventActor to retrieve the details of the event actor.
ClientIp (string) --
The client IP address of the event actor.
TlsFingerprint (string) --
The TLS fingerprint of the event actor, such as a JA3 or JA4 fingerprint.
Asn (string) --
The autonomous system number (ASN) that is associated with the client IP address of the event actor.
AsnOrganization (string) --
The name of the organization that owns the ASN. For example, AMAZON-02.
Country (string) --
The country of the client IP address of the event actor.
AuthFingerprint (string) --
A hash of the authentication credentials that the client of the event actor provides in the request. These can include a JSON Web Token (JWT), a JSON Web Encryption (JWE) token, an Amazon Web Services Signature Version 4 (SigV4) signature, or basic authentication credentials. You can use the fingerprint to match the same client across events and in your WAF logs.
CreatedAt (datetime) --
The time when WAF first observed the event actor.
EventCount (integer) --
The number of API security events that the event actor is associated with in the requested time window.
NextMarker (string) --
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Retrieves a paginated list of event summaries for your account. Use this operation to monitor and investigate potential threats to the resources that your web ACLs protect. Results are paginated. Use the NextMarker value from the response to retrieve the next batch of results. Currently, this operation supports API Security Amazon Web Services Managed Rules.
You can filter the results by time window, event category, resource, and API pattern, and sort them by start time, end time, or confidence.
To retrieve the events for a single web ACL, use ListEventsByWebACL. To retrieve the full details of a single event, use GetEvent.
See also: AWS API Documentation
Request Syntax
client.list_events(
Scope='CLOUDFRONT'|'REGIONAL',
TimeWindow={
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
Filters=[
{
'Name': 'EVENT_CATEGORY'|'RESOURCE_ARN',
'Values': [
'string',
]
},
],
ApiPatternFilters=[
{
'Method': 'string',
'PathPattern': 'string',
'Port': 123,
'Domains': [
'string',
]
},
],
Limit=123,
NextMarker='string',
SortOrder='ASC'|'DESC',
SortBy='START_TIME'|'END_TIME'|'CONFIDENCE',
Include=[
'TIMELINE',
]
)
string
[REQUIRED]
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
dict
The time range for the events to return. If you don't specify a time window, WAF returns events from the past year. The time window can't be longer than one year.
StartTime (datetime) -- [REQUIRED]
The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.
EndTime (datetime) -- [REQUIRED]
The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.
list
Filters that narrow the results by event category or by the Amazon Resource Name (ARN) of the protected resource. You can specify up to 8 filters.
(dict) --
A filter to narrow the events that are returned by ListEvents and ListEventsByWebACL.
Name (string) -- [REQUIRED]
The name of the field to filter on. Valid values:
EVENT_CATEGORY - Filter by event category. The only supported filter value is API_SECURITY.
RESOURCE_ARN - Filter by protected resource. The filter values are the Amazon Resource Name (ARN)s of the protected resources.
Values (list) -- [REQUIRED]
The values to filter on. You can specify up to 10 values.
(string) --
list
Filters that narrow the results to events that involve the specified API patterns. If you specify more than one API pattern filter, WAF returns the events that match any of the filters. You can specify up to 20 API pattern filters.
(dict) --
An API pattern to filter events by, used in ListEvents and ListEventsByWebACL.
Method (string) --
The HTTP method that you want the filter to match. For example, GET or POST.
PathPattern (string) --
The normalized URI path that you want the filter to match. For example, /api/v1/accounts/{id}.
Port (integer) --
The port that you want the filter to match. For example, 443.
Domains (list) --
The domains that you want the filter to match. You can specify up to 10 domains.
(string) --
integer
The maximum number of events that you want WAF to return for this request. Valid values are 1 to 20. If more events are available, WAF returns a NextMarker value in the response that you can use in a subsequent call to get the next batch of events.
string
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The marker is valid only for a request with the same TimeWindow, Filters, SortBy, and SortOrder settings as the request that returned it.
string
The order in which WAF sorts the events. Valid values:
ASC - Sort in ascending order.
DESC - Sort in descending order. This is the default.
string
The field that WAF sorts the events by. Valid values:
CONFIDENCE - Sort by the confidence level of the event detection.
END_TIME - Sort by the time that the event ended.
START_TIME - Sort by the time that the event started.
list
Additional fields to return with each event summary. By default, the response includes only the default summary fields.
Specify TIMELINE to return the timeline of each event in ApiSecurityEventDetail$Timeline.
(string) --
dict
Response Syntax
{
'Events': [
{
'EventId': 'string',
'EventStatus': 'EVENT_STARTED'|'EVENT_IN_PROGRESS'|'EVENT_COMPLETED'|'EVENT_ENDED',
'EventCategory': 'API_SECURITY',
'StartTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ResourceArn': 'string',
'WebAclArn': 'string',
'ApiSecurityEventDetail': {
'Label': 'string',
'Category': 'string',
'Confidence': 'LOW'|'MEDIUM'|'HIGH',
'ApiPatterns': [
{
'Method': 'string',
'PathPattern': 'string',
'Port': 123,
'Domains': [
'string',
]
},
],
'EventActors': [
{
'EventActorId': 'string',
'EventActorValue': 'string'
},
],
'Timeline': [
{
'ChangeTime': datetime(2015, 1, 1),
'Label': 'string',
'Confidence': 'LOW'|'MEDIUM'|'HIGH',
'ApiPatterns': [
{
'Method': 'string',
'PathPattern': 'string',
'Port': 123,
'Domains': [
'string',
]
},
]
},
]
}
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Events (list) --
The list of event summaries.
(dict) --
Information about an API security event, returned by ListEvents, ListEventsByWebACL, and GetEvent.
EventId (string) --
The unique identifier of the event. You provide this to GetEvent to retrieve the details of the event.
EventStatus (string) --
The current status of the event.
EventCategory (string) --
The category of the event. The only supported value is API_SECURITY.
StartTime (datetime) --
The time when the event started.
LastUpdatedTime (datetime) --
The time when the event was last updated.
EndTime (datetime) --
The time when the event ended. This is not populated while the event is ongoing.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the protected resource that the event is associated with.
WebAclArn (string) --
The Amazon Resource Name (ARN) of the web ACL that the event is associated with.
ApiSecurityEventDetail (dict) --
The API security details of the event, such as the label, category, confidence, API patterns, and event actors.
Label (string) --
The fully qualified name of the label that WAF assigned to the event. For example, awswaf:managed:aws:api-security:credential-stuffing-high.
Category (string) --
The API security threat category of the event. For example, API2:2023.
Confidence (string) --
The confidence level of the event detection: LOW, MEDIUM, or HIGH.
ApiPatterns (list) --
The API patterns that the event involves. The list contains up to 20 API patterns.
(dict) --
An API endpoint pattern that an API security event involves.
Method (string) --
The HTTP method of the API pattern. For example, GET or POST.
PathPattern (string) --
The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id}.
Port (integer) --
The port of the API pattern. For example, 443.
Domains (list) --
The domains that the API pattern was observed on. For example, api.example.com.
(string) --
EventActors (list) --
The event actors that are associated with the event. The list contains up to 20 event actors. To retrieve the details of an event actor, provide its EventActorId to GetEventActor.
(dict) --
A reference to an event actor that is associated with an API security event.
EventActorId (string) --
The unique identifier of the event actor. You provide this to GetEventActor to retrieve the details of the event actor.
EventActorValue (string) --
The observed identifier of the event actor. For example, a client IP address or an authentication fingerprint.
Timeline (list) --
The changes to the event's label, confidence, and API patterns over time, ordered from oldest to newest. The list contains up to 32 entries.
For ListEvents and ListEventsByWebACL, this is returned only if you specify TIMELINE in the request Include setting.
(dict) --
A change to the label, confidence, or API patterns of an API security event.
ChangeTime (datetime) --
The time of the change.
Label (string) --
The fully qualified name of the label that was assigned to the event at the time of the change.
Confidence (string) --
The confidence level of the event detection at the time of the change: LOW, MEDIUM, or HIGH.
ApiPatterns (list) --
The API patterns that the event involved at the time of the change.
(dict) --
An API endpoint pattern that an API security event involves.
Method (string) --
The HTTP method of the API pattern. For example, GET or POST.
PathPattern (string) --
The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id}.
Port (integer) --
The port of the API pattern. For example, 443.
Domains (list) --
The domains that the API pattern was observed on. For example, api.example.com.
(string) --
NextMarker (string) --
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Retrieves a paginated list of event summaries for the specified web ACL. Use this operation to monitor and investigate potential threats to the resources that the web ACL protects. Results are paginated. Use the NextMarker value from the response to retrieve the next batch of results. Currently, this operation supports API Security Amazon Web Services Managed Rules.
You can filter the results by time window, event category, resource, and API pattern, and sort them by start time, end time, or confidence.
To retrieve the events for all of the web ACLs in your account, use ListEvents. To retrieve the full details of a single event, use GetEvent.
See also: AWS API Documentation
Request Syntax
client.list_events_by_web_acl(
Scope='CLOUDFRONT'|'REGIONAL',
WebAclArn='string',
TimeWindow={
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
Filters=[
{
'Name': 'EVENT_CATEGORY'|'RESOURCE_ARN',
'Values': [
'string',
]
},
],
ApiPatternFilters=[
{
'Method': 'string',
'PathPattern': 'string',
'Port': 123,
'Domains': [
'string',
]
},
],
Limit=123,
NextMarker='string',
SortOrder='ASC'|'DESC',
SortBy='START_TIME'|'END_TIME'|'CONFIDENCE',
Include=[
'TIMELINE',
]
)
string
[REQUIRED]
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the web ACL whose events you want to retrieve.
dict
The time range for the events to return. If you don't specify a time window, WAF returns events from the past year. The time window can't be longer than one year.
StartTime (datetime) -- [REQUIRED]
The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.
EndTime (datetime) -- [REQUIRED]
The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.
list
Filters that narrow the results by event category or by the Amazon Resource Name (ARN) of the protected resource. You can specify up to 8 filters.
(dict) --
A filter to narrow the events that are returned by ListEvents and ListEventsByWebACL.
Name (string) -- [REQUIRED]
The name of the field to filter on. Valid values:
EVENT_CATEGORY - Filter by event category. The only supported filter value is API_SECURITY.
RESOURCE_ARN - Filter by protected resource. The filter values are the Amazon Resource Name (ARN)s of the protected resources.
Values (list) -- [REQUIRED]
The values to filter on. You can specify up to 10 values.
(string) --
list
Filters that narrow the results to events that involve the specified API patterns. If you specify more than one API pattern filter, WAF returns the events that match any of the filters. You can specify up to 20 API pattern filters.
(dict) --
An API pattern to filter events by, used in ListEvents and ListEventsByWebACL.
Method (string) --
The HTTP method that you want the filter to match. For example, GET or POST.
PathPattern (string) --
The normalized URI path that you want the filter to match. For example, /api/v1/accounts/{id}.
Port (integer) --
The port that you want the filter to match. For example, 443.
Domains (list) --
The domains that you want the filter to match. You can specify up to 10 domains.
(string) --
integer
The maximum number of events that you want WAF to return for this request. Valid values are 1 to 20. If more events are available, WAF returns a NextMarker value in the response that you can use in a subsequent call to get the next batch of events.
string
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The marker is valid only for a request with the same WebAclArn, TimeWindow, Filters, SortBy, and SortOrder settings as the request that returned it.
string
The order in which WAF sorts the events. Valid values:
ASC - Sort in ascending order.
DESC - Sort in descending order. This is the default.
string
The field that WAF sorts the events by. Valid values:
CONFIDENCE - Sort by the confidence level of the event detection.
END_TIME - Sort by the time that the event ended.
START_TIME - Sort by the time that the event started.
list
Additional fields to return with each event summary. By default, the response includes only the default summary fields.
Specify TIMELINE to return the timeline of each event in ApiSecurityEventDetail$Timeline.
(string) --
dict
Response Syntax
{
'Events': [
{
'EventId': 'string',
'EventStatus': 'EVENT_STARTED'|'EVENT_IN_PROGRESS'|'EVENT_COMPLETED'|'EVENT_ENDED',
'EventCategory': 'API_SECURITY',
'StartTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ResourceArn': 'string',
'WebAclArn': 'string',
'ApiSecurityEventDetail': {
'Label': 'string',
'Category': 'string',
'Confidence': 'LOW'|'MEDIUM'|'HIGH',
'ApiPatterns': [
{
'Method': 'string',
'PathPattern': 'string',
'Port': 123,
'Domains': [
'string',
]
},
],
'EventActors': [
{
'EventActorId': 'string',
'EventActorValue': 'string'
},
],
'Timeline': [
{
'ChangeTime': datetime(2015, 1, 1),
'Label': 'string',
'Confidence': 'LOW'|'MEDIUM'|'HIGH',
'ApiPatterns': [
{
'Method': 'string',
'PathPattern': 'string',
'Port': 123,
'Domains': [
'string',
]
},
]
},
]
}
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Events (list) --
The list of event summaries.
(dict) --
Information about an API security event, returned by ListEvents, ListEventsByWebACL, and GetEvent.
EventId (string) --
The unique identifier of the event. You provide this to GetEvent to retrieve the details of the event.
EventStatus (string) --
The current status of the event.
EventCategory (string) --
The category of the event. The only supported value is API_SECURITY.
StartTime (datetime) --
The time when the event started.
LastUpdatedTime (datetime) --
The time when the event was last updated.
EndTime (datetime) --
The time when the event ended. This is not populated while the event is ongoing.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the protected resource that the event is associated with.
WebAclArn (string) --
The Amazon Resource Name (ARN) of the web ACL that the event is associated with.
ApiSecurityEventDetail (dict) --
The API security details of the event, such as the label, category, confidence, API patterns, and event actors.
Label (string) --
The fully qualified name of the label that WAF assigned to the event. For example, awswaf:managed:aws:api-security:credential-stuffing-high.
Category (string) --
The API security threat category of the event. For example, API2:2023.
Confidence (string) --
The confidence level of the event detection: LOW, MEDIUM, or HIGH.
ApiPatterns (list) --
The API patterns that the event involves. The list contains up to 20 API patterns.
(dict) --
An API endpoint pattern that an API security event involves.
Method (string) --
The HTTP method of the API pattern. For example, GET or POST.
PathPattern (string) --
The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id}.
Port (integer) --
The port of the API pattern. For example, 443.
Domains (list) --
The domains that the API pattern was observed on. For example, api.example.com.
(string) --
EventActors (list) --
The event actors that are associated with the event. The list contains up to 20 event actors. To retrieve the details of an event actor, provide its EventActorId to GetEventActor.
(dict) --
A reference to an event actor that is associated with an API security event.
EventActorId (string) --
The unique identifier of the event actor. You provide this to GetEventActor to retrieve the details of the event actor.
EventActorValue (string) --
The observed identifier of the event actor. For example, a client IP address or an authentication fingerprint.
Timeline (list) --
The changes to the event's label, confidence, and API patterns over time, ordered from oldest to newest. The list contains up to 32 entries.
For ListEvents and ListEventsByWebACL, this is returned only if you specify TIMELINE in the request Include setting.
(dict) --
A change to the label, confidence, or API patterns of an API security event.
ChangeTime (datetime) --
The time of the change.
Label (string) --
The fully qualified name of the label that was assigned to the event at the time of the change.
Confidence (string) --
The confidence level of the event detection at the time of the change: LOW, MEDIUM, or HIGH.
ApiPatterns (list) --
The API patterns that the event involved at the time of the change.
(dict) --
An API endpoint pattern that an API security event involves.
Method (string) --
The HTTP method of the API pattern. For example, GET or POST.
PathPattern (string) --
The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id}.
Port (integer) --
The port of the API pattern. For example, 443.
Domains (list) --
The domains that the API pattern was observed on. For example, api.example.com.
(string) --
NextMarker (string) --
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Retrieves the details of the specified event for the specified web ACL, including the event actors that are associated with the event and the event timeline. Currently, this operation supports API Security Amazon Web Services Managed Rules.
See also: AWS API Documentation
Request Syntax
client.get_event(
Scope='CLOUDFRONT'|'REGIONAL',
EventId='string',
WebAclArn='string'
)
string
[REQUIRED]
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
string
[REQUIRED]
The unique identifier of the event. WAF returns the event ID in the responses to ListEvents and ListEventsByWebACL.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the web ACL that the event is associated with.
dict
Response Syntax
{
'Event': {
'EventId': 'string',
'EventStatus': 'EVENT_STARTED'|'EVENT_IN_PROGRESS'|'EVENT_COMPLETED'|'EVENT_ENDED',
'EventCategory': 'API_SECURITY',
'StartTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ResourceArn': 'string',
'WebAclArn': 'string',
'ApiSecurityEventDetail': {
'Label': 'string',
'Category': 'string',
'Confidence': 'LOW'|'MEDIUM'|'HIGH',
'ApiPatterns': [
{
'Method': 'string',
'PathPattern': 'string',
'Port': 123,
'Domains': [
'string',
]
},
],
'EventActors': [
{
'EventActorId': 'string',
'EventActorValue': 'string'
},
],
'Timeline': [
{
'ChangeTime': datetime(2015, 1, 1),
'Label': 'string',
'Confidence': 'LOW'|'MEDIUM'|'HIGH',
'ApiPatterns': [
{
'Method': 'string',
'PathPattern': 'string',
'Port': 123,
'Domains': [
'string',
]
},
]
},
]
}
}
}
Response Structure
(dict) --
Event (dict) --
The details of the event.
EventId (string) --
The unique identifier of the event. You provide this to GetEvent to retrieve the details of the event.
EventStatus (string) --
The current status of the event.
EventCategory (string) --
The category of the event. The only supported value is API_SECURITY.
StartTime (datetime) --
The time when the event started.
LastUpdatedTime (datetime) --
The time when the event was last updated.
EndTime (datetime) --
The time when the event ended. This is not populated while the event is ongoing.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the protected resource that the event is associated with.
WebAclArn (string) --
The Amazon Resource Name (ARN) of the web ACL that the event is associated with.
ApiSecurityEventDetail (dict) --
The API security details of the event, such as the label, category, confidence, API patterns, and event actors.
Label (string) --
The fully qualified name of the label that WAF assigned to the event. For example, awswaf:managed:aws:api-security:credential-stuffing-high.
Category (string) --
The API security threat category of the event. For example, API2:2023.
Confidence (string) --
The confidence level of the event detection: LOW, MEDIUM, or HIGH.
ApiPatterns (list) --
The API patterns that the event involves. The list contains up to 20 API patterns.
(dict) --
An API endpoint pattern that an API security event involves.
Method (string) --
The HTTP method of the API pattern. For example, GET or POST.
PathPattern (string) --
The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id}.
Port (integer) --
The port of the API pattern. For example, 443.
Domains (list) --
The domains that the API pattern was observed on. For example, api.example.com.
(string) --
EventActors (list) --
The event actors that are associated with the event. The list contains up to 20 event actors. To retrieve the details of an event actor, provide its EventActorId to GetEventActor.
(dict) --
A reference to an event actor that is associated with an API security event.
EventActorId (string) --
The unique identifier of the event actor. You provide this to GetEventActor to retrieve the details of the event actor.
EventActorValue (string) --
The observed identifier of the event actor. For example, a client IP address or an authentication fingerprint.
Timeline (list) --
The changes to the event's label, confidence, and API patterns over time, ordered from oldest to newest. The list contains up to 32 entries.
For ListEvents and ListEventsByWebACL, this is returned only if you specify TIMELINE in the request Include setting.
(dict) --
A change to the label, confidence, or API patterns of an API security event.
ChangeTime (datetime) --
The time of the change.
Label (string) --
The fully qualified name of the label that was assigned to the event at the time of the change.
Confidence (string) --
The confidence level of the event detection at the time of the change: LOW, MEDIUM, or HIGH.
ApiPatterns (list) --
The API patterns that the event involved at the time of the change.
(dict) --
An API endpoint pattern that an API security event involves.
Method (string) --
The HTTP method of the API pattern. For example, GET or POST.
PathPattern (string) --
The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id}.
Port (integer) --
The port of the API pattern. For example, 443.
Domains (list) --
The domains that the API pattern was observed on. For example, api.example.com.
(string) --
Retrieves the details of the specified event actor. An event actor is a client that is associated with one or more events. The details include the latest observed attributes of the event actor, the events that it's associated with, and the history of changes to its attributes. Currently, this operation supports API Security Amazon Web Services Managed Rules.
See also: AWS API Documentation
Request Syntax
client.get_event_actor(
Scope='CLOUDFRONT'|'REGIONAL',
EventActorId='string'
)
string
[REQUIRED]
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
string
[REQUIRED]
The unique identifier of the event actor. WAF returns the event actor ID in the event details of ListEvents, ListEventsByWebACL, and GetEvent, and in the response to ListEventActors.
dict
Response Syntax
{
'EventActor': {
'Summary': {
'EventActorId': 'string',
'ClientIp': 'string',
'TlsFingerprint': 'string',
'Asn': 'string',
'AsnOrganization': 'string',
'Country': 'string',
'AuthFingerprint': 'string',
'CreatedAt': datetime(2015, 1, 1)
},
'Events': [
{
'EventId': 'string',
'StartTime': datetime(2015, 1, 1),
'Label': 'string',
'Category': 'string',
'Confidence': 'LOW'|'MEDIUM'|'HIGH',
'ApiPatterns': [
{
'Method': 'string',
'PathPattern': 'string',
'Port': 123,
'Domains': [
'string',
]
},
]
},
],
'Changes': [
{
'ChangeTime': datetime(2015, 1, 1),
'ClientIp': 'string',
'TlsFingerprint': 'string',
'Asn': 'string',
'AsnOrganization': 'string',
'Country': 'string'
},
]
}
}
Response Structure
(dict) --
EventActor (dict) --
The details of the event actor.
Summary (dict) --
The latest observed attributes of the event actor.
EventActorId (string) --
The unique identifier of the event actor.
ClientIp (string) --
The client IP address of the event actor.
TlsFingerprint (string) --
The TLS fingerprint of the event actor, such as a JA3 or JA4 fingerprint.
Asn (string) --
The autonomous system number (ASN) that is associated with the client IP address of the event actor.
AsnOrganization (string) --
The name of the organization that owns the ASN. For example, AMAZON-02.
Country (string) --
The country of the client IP address of the event actor.
AuthFingerprint (string) --
A hash of the authentication credentials that the client of the event actor provides in the request. These can include a JSON Web Token (JWT), a JSON Web Encryption (JWE) token, an Amazon Web Services Signature Version 4 (SigV4) signature, or basic authentication credentials. You can use the fingerprint to match the same client across events and in your WAF logs.
CreatedAt (datetime) --
The time when WAF first observed the event actor.
Events (list) --
The API security events that the event actor is associated with. The list contains up to 20 events.
(dict) --
An API security event that an event actor is associated with.
EventId (string) --
The unique identifier of the event. You provide this to GetEvent to retrieve the details of the event.
StartTime (datetime) --
The time when the event started.
Label (string) --
The fully qualified name of the label that WAF assigned to the event.
Category (string) --
The API security threat category of the event. For example, API2:2023.
Confidence (string) --
The confidence level of the event detection: LOW, MEDIUM, or HIGH.
ApiPatterns (list) --
The API patterns that the event involves.
(dict) --
An API endpoint pattern that an API security event involves.
Method (string) --
The HTTP method of the API pattern. For example, GET or POST.
PathPattern (string) --
The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id}.
Port (integer) --
The port of the API pattern. For example, 443.
Domains (list) --
The domains that the API pattern was observed on. For example, api.example.com.
(string) --
Changes (list) --
The history of changes to the network attributes of the event actor, ordered from oldest to newest. The list contains up to 20 entries.
(dict) --
A change to the network attributes of an event actor.
ChangeTime (datetime) --
The time of the change.
ClientIp (string) --
The client IP address of the event actor after the change.
TlsFingerprint (string) --
The TLS fingerprint of the event actor after the change, such as a JA3 or JA4 fingerprint.
Asn (string) --
The autonomous system number (ASN) that is associated with the client IP address after the change.
AsnOrganization (string) --
The name of the organization that owns the ASN after the change.
Country (string) --
The country of the client IP address after the change.
{'Rules': {'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}}}
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
See also: AWS API Documentation
Request Syntax
client.check_capacity(
Scope='CLOUDFRONT'|'REGIONAL',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'SensitivityLevel': 'LOW'|'HIGH'
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string',
'IPSetForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH',
'Position': 'FIRST'|'LAST'|'ANY'
}
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'EvaluationWindowSec': 123,
'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT',
'ScopeDownStatement': {'... recursive ...'},
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'CustomKeys': [
{
'Header': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'Cookie': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryArgument': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryString': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'HTTPMethod': {}
,
'ForwardedIP': {}
,
'IP': {}
,
'LabelNamespace': {
'Namespace': 'string'
},
'UriPath': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'ASN': {}
},
]
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'Version': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'ScopeDownStatement': {'... recursive ...'},
'ManagedRuleGroupConfigs': [
{
'LoginPath': 'string',
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'AWSManagedRulesBotControlRuleSet': {
'InspectionLevel': 'COMMON'|'TARGETED',
'EnableMachineLearning': True|False
},
'AWSManagedRulesATPRuleSet': {
'LoginPath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
}
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesACFPRuleSet': {
'CreationPath': 'string',
'RegistrationPagePath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'EmailField': {
'Identifier': 'string'
},
'PhoneNumberFields': [
{
'Identifier': 'string'
},
],
'AddressFields': [
{
'Identifier': 'string'
},
]
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesAntiDDoSRuleSet': {
'ClientSideActionConfig': {
'Challenge': {
'UsageOfAction': 'ENABLED'|'DISABLED',
'Sensitivity': 'LOW'|'MEDIUM'|'HIGH',
'ExemptUriRegularExpressions': [
{
'RegexString': 'string'
},
]
}
},
'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH'
},
'AWSManagedRulesAISecurityRuleSet': {
'BedrockGuardrails': {
'Disable': {}
,
'ProtectRequestOnly': {
'RoleArn': 'string'
},
'ProtectRequestAndResponse': {
'RoleArn': 'string'
}
}
}
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'LabelMatchStatement': {
'Scope': 'LABEL'|'NAMESPACE',
'Key': 'string'
},
'RegexMatchStatement': {
'RegexString': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'AsnMatchStatement': {
'AsnList': [
123,
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
}
},
'Action': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
},
'OverrideAction': {
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'None': {}
},
'RuleLabels': [
{
'Name': 'string'
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
'CaptchaConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
'ChallengeConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
}
},
]
)
**Parameters**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CheckCapacity>`_
dict
Response Syntax
{
'Capacity': 123
}
Response Structure
(dict) --
Capacity (integer) --
The capacity required by the rules and scope.
{'Rules': {'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}}}
Creates a RuleGroup per the specifications provided.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
See also: AWS API Documentation
Request Syntax
client.create_rule_group(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Capacity=123,
Description='string',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'SensitivityLevel': 'LOW'|'HIGH'
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string',
'IPSetForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH',
'Position': 'FIRST'|'LAST'|'ANY'
}
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'EvaluationWindowSec': 123,
'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT',
'ScopeDownStatement': {'... recursive ...'},
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'CustomKeys': [
{
'Header': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'Cookie': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryArgument': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryString': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'HTTPMethod': {}
,
'ForwardedIP': {}
,
'IP': {}
,
'LabelNamespace': {
'Namespace': 'string'
},
'UriPath': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'ASN': {}
},
]
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'Version': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'ScopeDownStatement': {'... recursive ...'},
'ManagedRuleGroupConfigs': [
{
'LoginPath': 'string',
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'AWSManagedRulesBotControlRuleSet': {
'InspectionLevel': 'COMMON'|'TARGETED',
'EnableMachineLearning': True|False
},
'AWSManagedRulesATPRuleSet': {
'LoginPath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
}
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesACFPRuleSet': {
'CreationPath': 'string',
'RegistrationPagePath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'EmailField': {
'Identifier': 'string'
},
'PhoneNumberFields': [
{
'Identifier': 'string'
},
],
'AddressFields': [
{
'Identifier': 'string'
},
]
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesAntiDDoSRuleSet': {
'ClientSideActionConfig': {
'Challenge': {
'UsageOfAction': 'ENABLED'|'DISABLED',
'Sensitivity': 'LOW'|'MEDIUM'|'HIGH',
'ExemptUriRegularExpressions': [
{
'RegexString': 'string'
},
]
}
},
'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH'
},
'AWSManagedRulesAISecurityRuleSet': {
'BedrockGuardrails': {
'Disable': {}
,
'ProtectRequestOnly': {
'RoleArn': 'string'
},
'ProtectRequestAndResponse': {
'RoleArn': 'string'
}
}
}
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'LabelMatchStatement': {
'Scope': 'LABEL'|'NAMESPACE',
'Key': 'string'
},
'RegexMatchStatement': {
'RegexString': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'AsnMatchStatement': {
'AsnList': [
123,
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
}
},
'Action': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
},
'OverrideAction': {
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'None': {}
},
'RuleLabels': [
{
'Name': 'string'
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
'CaptchaConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
'ChallengeConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
}
},
],
VisibilityConfig={
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
CustomResponseBodies={
'string': {
'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON',
'Content': 'string'
}
},
MonetizationConfig={
'CryptoConfig': {
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA'|'BASE_SEPOLIA'|'SOLANA_DEVNET',
'WalletAddress': 'string',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
'ConnectedAccountConfigs': [
{
'ConnectedAccountArn': 'string',
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
],
'CurrencyMode': 'REAL'|'TEST'
}
)
**Parameters**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CreateRuleGroup>`_
dict
Response Syntax
{
'Summary': {
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
Summary (dict) --
High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.
Name (string) --
The name of the data type instance. You cannot change the name after you create the instance.
Id (string) --
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
Description (string) --
A description of the rule group that helps with identification.
LockToken (string) --
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
{'AssociationConfig': {'RequestBody': {'DefaultSizeInspectionLimit': {'KB_8'}}},
'Rules': {'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}}}
Creates a WebACL per the specifications provided.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, Amazon Web Services Verified Access instance, and Amazon Bedrock AgentCore Gateway.
See also: AWS API Documentation
Request Syntax
client.create_web_acl(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
DefaultAction={
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
}
},
Description='string',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'SensitivityLevel': 'LOW'|'HIGH'
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string',
'IPSetForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH',
'Position': 'FIRST'|'LAST'|'ANY'
}
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'EvaluationWindowSec': 123,
'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT',
'ScopeDownStatement': {'... recursive ...'},
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'CustomKeys': [
{
'Header': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'Cookie': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryArgument': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryString': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'HTTPMethod': {}
,
'ForwardedIP': {}
,
'IP': {}
,
'LabelNamespace': {
'Namespace': 'string'
},
'UriPath': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'ASN': {}
},
]
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'Version': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'ScopeDownStatement': {'... recursive ...'},
'ManagedRuleGroupConfigs': [
{
'LoginPath': 'string',
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'AWSManagedRulesBotControlRuleSet': {
'InspectionLevel': 'COMMON'|'TARGETED',
'EnableMachineLearning': True|False
},
'AWSManagedRulesATPRuleSet': {
'LoginPath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
}
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesACFPRuleSet': {
'CreationPath': 'string',
'RegistrationPagePath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'EmailField': {
'Identifier': 'string'
},
'PhoneNumberFields': [
{
'Identifier': 'string'
},
],
'AddressFields': [
{
'Identifier': 'string'
},
]
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesAntiDDoSRuleSet': {
'ClientSideActionConfig': {
'Challenge': {
'UsageOfAction': 'ENABLED'|'DISABLED',
'Sensitivity': 'LOW'|'MEDIUM'|'HIGH',
'ExemptUriRegularExpressions': [
{
'RegexString': 'string'
},
]
}
},
'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH'
},
'AWSManagedRulesAISecurityRuleSet': {
'BedrockGuardrails': {
'Disable': {}
,
'ProtectRequestOnly': {
'RoleArn': 'string'
},
'ProtectRequestAndResponse': {
'RoleArn': 'string'
}
}
}
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'LabelMatchStatement': {
'Scope': 'LABEL'|'NAMESPACE',
'Key': 'string'
},
'RegexMatchStatement': {
'RegexString': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'AsnMatchStatement': {
'AsnList': [
123,
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
}
},
'Action': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
},
'OverrideAction': {
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'None': {}
},
'RuleLabels': [
{
'Name': 'string'
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
'CaptchaConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
'ChallengeConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
}
},
],
VisibilityConfig={
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
DataProtectionConfig={
'DataProtections': [
{
'Field': {
'FieldType': 'SINGLE_HEADER'|'SINGLE_COOKIE'|'SINGLE_QUERY_ARGUMENT'|'QUERY_STRING'|'BODY',
'FieldKeys': [
'string',
]
},
'Action': 'SUBSTITUTION'|'HASH',
'ExcludeRuleMatchDetails': True|False,
'ExcludeRateBasedDetails': True|False
},
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
CustomResponseBodies={
'string': {
'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON',
'Content': 'string'
}
},
CaptchaConfig={
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
ChallengeConfig={
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
TokenDomains=[
'string',
],
AssociationConfig={
'RequestBody': {
'string': {
'DefaultSizeInspectionLimit': 'KB_8'|'KB_16'|'KB_32'|'KB_48'|'KB_64'
}
},
'ChallengeJavascriptSdkInjection': {
'string': {}
}
},
OnSourceDDoSProtectionConfig={
'ALBLowReputationMode': 'ACTIVE_UNDER_DDOS'|'ALWAYS_ON'
},
ApplicationConfig={
'Attributes': [
{
'Name': 'string',
'Values': [
'string',
]
},
]
},
MonetizationConfig={
'CryptoConfig': {
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA'|'BASE_SEPOLIA'|'SOLANA_DEVNET',
'WalletAddress': 'string',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
'ConnectedAccountConfigs': [
{
'ConnectedAccountArn': 'string',
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
],
'CurrencyMode': 'REAL'|'TEST'
},
AnalyticsConfig={
'Mode': 'CROSS_REGION'|'DISABLED'
}
)
**Parameters**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CreateWebACL>`_
dict
Response Syntax
{
'Summary': {
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
Summary (dict) --
High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.
Name (string) --
The name of the web ACL. You cannot change the name of a web ACL after you create it.
Id (string) --
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
Description (string) --
A description of the web ACL that helps with identification.
LockToken (string) --
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
{'RuleGroup': {'Rules': {'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}}}}
Retrieves the specified RuleGroup.
See also: AWS API Documentation
Request Syntax
client.get_rule_group(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
ARN='string'
)
string
The name of the rule group. You cannot change the name of a rule group after you create it.
string
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
string
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
string
The Amazon Resource Name (ARN) of the entity.
dict
Response Syntax
{
'RuleGroup': {
'Name': 'string',
'Id': 'string',
'Capacity': 123,
'ARN': 'string',
'Description': 'string',
'Rules': [
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {},
'JsonBody': {
'MatchPattern': {
'All': {},
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {},
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {},
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {},
'JsonBody': {
'MatchPattern': {
'All': {},
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {},
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {},
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'SensitivityLevel': 'LOW'|'HIGH'
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {},
'JsonBody': {
'MatchPattern': {
'All': {},
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {},
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {},
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {},
'JsonBody': {
'MatchPattern': {
'All': {},
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {},
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {},
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string',
'IPSetForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH',
'Position': 'FIRST'|'LAST'|'ANY'
}
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {},
'JsonBody': {
'MatchPattern': {
'All': {},
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {},
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {},
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'EvaluationWindowSec': 123,
'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT',
'ScopeDownStatement': {'... recursive ...'},
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'CustomKeys': [
{
'Header': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'Cookie': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryArgument': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryString': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'HTTPMethod': {},
'ForwardedIP': {},
'IP': {},
'LabelNamespace': {
'Namespace': 'string'
},
'UriPath': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'ASN': {}
},
]
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'Version': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'ScopeDownStatement': {'... recursive ...'},
'ManagedRuleGroupConfigs': [
{
'LoginPath': 'string',
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'AWSManagedRulesBotControlRuleSet': {
'InspectionLevel': 'COMMON'|'TARGETED',
'EnableMachineLearning': True|False
},
'AWSManagedRulesATPRuleSet': {
'LoginPath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
}
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesACFPRuleSet': {
'CreationPath': 'string',
'RegistrationPagePath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'EmailField': {
'Identifier': 'string'
},
'PhoneNumberFields': [
{
'Identifier': 'string'
},
],
'AddressFields': [
{
'Identifier': 'string'
},
]
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesAntiDDoSRuleSet': {
'ClientSideActionConfig': {
'Challenge': {
'UsageOfAction': 'ENABLED'|'DISABLED',
'Sensitivity': 'LOW'|'MEDIUM'|'HIGH',
'ExemptUriRegularExpressions': [
{
'RegexString': 'string'
},
]
}
},
'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH'
},
'AWSManagedRulesAISecurityRuleSet': {
'BedrockGuardrails': {
'Disable': {},
'ProtectRequestOnly': {
'RoleArn': 'string'
},
'ProtectRequestAndResponse': {
'RoleArn': 'string'
}
}
}
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'LabelMatchStatement': {
'Scope': 'LABEL'|'NAMESPACE',
'Key': 'string'
},
'RegexMatchStatement': {
'RegexString': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {},
'JsonBody': {
'MatchPattern': {
'All': {},
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {},
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {},
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'AsnMatchStatement': {
'AsnList': [
123,
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
}
},
'Action': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
},
'OverrideAction': {
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'None': {}
},
'RuleLabels': [
{
'Name': 'string'
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
'CaptchaConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
'ChallengeConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
}
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
'LabelNamespace': 'string',
'CustomResponseBodies': {
'string': {
'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON',
'Content': 'string'
}
},
'AvailableLabels': [
{
'Name': 'string'
},
],
'ConsumedLabels': [
{
'Name': 'string'
},
],
'MonetizationConfig': {
'CryptoConfig': {
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA'|'BASE_SEPOLIA'|'SOLANA_DEVNET',
'WalletAddress': 'string',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
'ConnectedAccountConfigs': [
{
'ConnectedAccountArn': 'string',
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
],
'CurrencyMode': 'REAL'|'TEST'
}
},
'LockToken': 'string'
}
**Response Structure**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/GetRuleGroup>`_
{'WebACL': {'AssociationConfig': {'RequestBody': {'DefaultSizeInspectionLimit': {'KB_8'}}},
'PostProcessFirewallManagerRuleGroups': {'FirewallManagerStatement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}},
'PreProcessFirewallManagerRuleGroups': {'FirewallManagerStatement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}},
'Rules': {'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}}}}
Retrieves the specified WebACL.
See also: AWS API Documentation
Request Syntax
client.get_web_acl(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
ARN='string'
)
string
The name of the web ACL. You cannot change the name of a web ACL after you create it.
string
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
string
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
string
The Amazon Resource Name (ARN) of the web ACL that you want to retrieve.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'WebACL': {'AssociationConfig': {'RequestBody': {'DefaultSizeInspectionLimit': {'KB_8'}}},
'PostProcessFirewallManagerRuleGroups': {'FirewallManagerStatement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}},
'PreProcessFirewallManagerRuleGroups': {'FirewallManagerStatement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}},
'Rules': {'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}}}}
Retrieves the WebACL for the specified resource.
This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn't authorized to perform wafv2:GetWebACL on the resource, that error won't be included in your CloudTrail event history.
For Amazon CloudFront, don't use this call. Instead, call the CloudFront action GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.
See also: AWS API Documentation
Request Syntax
client.get_web_acl_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
The ARN must be in one of the following formats:
For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway REST API: arn:partition:apigateway:region::/restapis/api-id/stages/stage-name
For an AppSync GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId
For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
For an App Runner service: arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id
For an Amazon Web Services Verified Access instance: arn:partition:ec2:region:account-id:verified-access-instance/instance-id
For an Amplify application: arn:partition:amplify:region:account-id:apps/app-id
For an Amazon Bedrock AgentCore Gateway: arn:partition:bedrock-agentcore:region:account-id:gateway/gateway-id
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Rules': {'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}}}
Updates the specified RuleGroup.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
After you change a rule action setting, you might see the old action in some places and the new action in others.
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
See also: AWS API Documentation
Request Syntax
client.update_rule_group(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
Description='string',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'SensitivityLevel': 'LOW'|'HIGH'
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string',
'IPSetForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH',
'Position': 'FIRST'|'LAST'|'ANY'
}
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'EvaluationWindowSec': 123,
'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT',
'ScopeDownStatement': {'... recursive ...'},
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'CustomKeys': [
{
'Header': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'Cookie': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryArgument': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryString': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'HTTPMethod': {}
,
'ForwardedIP': {}
,
'IP': {}
,
'LabelNamespace': {
'Namespace': 'string'
},
'UriPath': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'ASN': {}
},
]
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'Version': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'ScopeDownStatement': {'... recursive ...'},
'ManagedRuleGroupConfigs': [
{
'LoginPath': 'string',
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'AWSManagedRulesBotControlRuleSet': {
'InspectionLevel': 'COMMON'|'TARGETED',
'EnableMachineLearning': True|False
},
'AWSManagedRulesATPRuleSet': {
'LoginPath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
}
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesACFPRuleSet': {
'CreationPath': 'string',
'RegistrationPagePath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'EmailField': {
'Identifier': 'string'
},
'PhoneNumberFields': [
{
'Identifier': 'string'
},
],
'AddressFields': [
{
'Identifier': 'string'
},
]
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesAntiDDoSRuleSet': {
'ClientSideActionConfig': {
'Challenge': {
'UsageOfAction': 'ENABLED'|'DISABLED',
'Sensitivity': 'LOW'|'MEDIUM'|'HIGH',
'ExemptUriRegularExpressions': [
{
'RegexString': 'string'
},
]
}
},
'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH'
},
'AWSManagedRulesAISecurityRuleSet': {
'BedrockGuardrails': {
'Disable': {}
,
'ProtectRequestOnly': {
'RoleArn': 'string'
},
'ProtectRequestAndResponse': {
'RoleArn': 'string'
}
}
}
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'LabelMatchStatement': {
'Scope': 'LABEL'|'NAMESPACE',
'Key': 'string'
},
'RegexMatchStatement': {
'RegexString': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'AsnMatchStatement': {
'AsnList': [
123,
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
}
},
'Action': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
},
'OverrideAction': {
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'None': {}
},
'RuleLabels': [
{
'Name': 'string'
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
'CaptchaConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
'ChallengeConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
}
},
],
VisibilityConfig={
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
LockToken='string',
CustomResponseBodies={
'string': {
'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON',
'Content': 'string'
}
},
MonetizationConfig={
'CryptoConfig': {
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA'|'BASE_SEPOLIA'|'SOLANA_DEVNET',
'WalletAddress': 'string',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
'ConnectedAccountConfigs': [
{
'ConnectedAccountArn': 'string',
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
],
'CurrencyMode': 'REAL'|'TEST'
}
)
**Parameters**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/UpdateRuleGroup>`_
dict
Response Syntax
{
'NextLockToken': 'string'
}
Response Structure
(dict) --
NextLockToken (string) --
A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
{'AssociationConfig': {'RequestBody': {'DefaultSizeInspectionLimit': {'KB_8'}}},
'Rules': {'Statement': {'ManagedRuleGroupStatement': {'ManagedRuleGroupConfigs': {'AWSManagedRulesAISecurityRuleSet': {'BedrockGuardrails': {'Disable': {},
'ProtectRequestAndResponse': {'RoleArn': 'string'},
'ProtectRequestOnly': {'RoleArn': 'string'}}}}}}}}
Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, Amazon Web Services Verified Access instance, and Amazon Bedrock AgentCore Gateway.
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
After you change a rule action setting, you might see the old action in some places and the new action in others.
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
See also: AWS API Documentation
Request Syntax
client.update_web_acl(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
DefaultAction={
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
}
},
Description='string',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
],
'SensitivityLevel': 'LOW'|'HIGH'
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK',
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string',
'IPSetForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH',
'Position': 'FIRST'|'LAST'|'ANY'
}
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'EvaluationWindowSec': 123,
'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT',
'ScopeDownStatement': {'... recursive ...'},
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'CustomKeys': [
{
'Header': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'Cookie': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryArgument': {
'Name': 'string',
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'QueryString': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'HTTPMethod': {}
,
'ForwardedIP': {}
,
'IP': {}
,
'LabelNamespace': {
'Namespace': 'string'
},
'UriPath': {
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
]
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'ASN': {}
},
]
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'Version': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
],
'ScopeDownStatement': {'... recursive ...'},
'ManagedRuleGroupConfigs': [
{
'LoginPath': 'string',
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'AWSManagedRulesBotControlRuleSet': {
'InspectionLevel': 'COMMON'|'TARGETED',
'EnableMachineLearning': True|False
},
'AWSManagedRulesATPRuleSet': {
'LoginPath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
}
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesACFPRuleSet': {
'CreationPath': 'string',
'RegistrationPagePath': 'string',
'RequestInspection': {
'PayloadType': 'JSON'|'FORM_ENCODED',
'UsernameField': {
'Identifier': 'string'
},
'PasswordField': {
'Identifier': 'string'
},
'EmailField': {
'Identifier': 'string'
},
'PhoneNumberFields': [
{
'Identifier': 'string'
},
],
'AddressFields': [
{
'Identifier': 'string'
},
]
},
'ResponseInspection': {
'StatusCode': {
'SuccessCodes': [
123,
],
'FailureCodes': [
123,
]
},
'Header': {
'Name': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
},
'BodyContains': {
'SuccessStrings': [
'string',
],
'FailureStrings': [
'string',
]
},
'Json': {
'Identifier': 'string',
'SuccessValues': [
'string',
],
'FailureValues': [
'string',
]
}
},
'EnableRegexInPath': True|False
},
'AWSManagedRulesAntiDDoSRuleSet': {
'ClientSideActionConfig': {
'Challenge': {
'UsageOfAction': 'ENABLED'|'DISABLED',
'Sensitivity': 'LOW'|'MEDIUM'|'HIGH',
'ExemptUriRegularExpressions': [
{
'RegexString': 'string'
},
]
}
},
'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH'
},
'AWSManagedRulesAISecurityRuleSet': {
'BedrockGuardrails': {
'Disable': {}
,
'ProtectRequestOnly': {
'RoleArn': 'string'
},
'ProtectRequestAndResponse': {
'RoleArn': 'string'
}
}
}
},
],
'RuleActionOverrides': [
{
'Name': 'string',
'ActionToUse': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
}
},
]
},
'LabelMatchStatement': {
'Scope': 'LABEL'|'NAMESPACE',
'Key': 'string'
},
'RegexMatchStatement': {
'RegexString': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Method': {}
,
'JsonBody': {
'MatchPattern': {
'All': {}
,
'IncludedPaths': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Headers': {
'MatchPattern': {
'All': {}
,
'IncludedHeaders': [
'string',
],
'ExcludedHeaders': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'Cookies': {
'MatchPattern': {
'All': {}
,
'IncludedCookies': [
'string',
],
'ExcludedCookies': [
'string',
]
},
'MatchScope': 'ALL'|'KEY'|'VALUE',
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'HeaderOrder': {
'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH'
},
'JA3Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'JA4Fingerprint': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
},
'UriFragment': {
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE'|'REMOVE_WHITESPACE'|'TRIM'|'TRIM_LEFT'|'TRIM_RIGHT'|'REMOVE_COMMENTS_CHAR'|'UPPERCASE'|'CMD_LINE_WIN'|'CMD_LINE_UNIX'|'JS_DECODE_EXT'|'SHA256'
},
],
'PreParseTextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'URL_DECODE'|'URL_DECODE_UNI'|'COMBINE_DUPLICATE_QUERY_ARGS_BY_COMMA'|'REPLACE_SEMICOLONS_WITH_AMPERSANDS'
},
]
},
'AsnMatchStatement': {
'AsnList': [
123,
],
'ForwardedIPConfig': {
'HeaderName': 'string',
'FallbackBehavior': 'MATCH'|'NO_MATCH'
}
}
},
'Action': {
'Block': {
'CustomResponse': {
'ResponseCode': 123,
'CustomResponseBodyKey': 'string',
'ResponseHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Allow': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Captcha': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Challenge': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Monetize': {
'PriceMultiplier': 'string'
}
},
'OverrideAction': {
'Count': {
'CustomRequestHandling': {
'InsertHeaders': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'None': {}
},
'RuleLabels': [
{
'Name': 'string'
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
'CaptchaConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
'ChallengeConfig': {
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
}
},
],
VisibilityConfig={
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
DataProtectionConfig={
'DataProtections': [
{
'Field': {
'FieldType': 'SINGLE_HEADER'|'SINGLE_COOKIE'|'SINGLE_QUERY_ARGUMENT'|'QUERY_STRING'|'BODY',
'FieldKeys': [
'string',
]
},
'Action': 'SUBSTITUTION'|'HASH',
'ExcludeRuleMatchDetails': True|False,
'ExcludeRateBasedDetails': True|False
},
]
},
LockToken='string',
CustomResponseBodies={
'string': {
'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON',
'Content': 'string'
}
},
CaptchaConfig={
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
ChallengeConfig={
'ImmunityTimeProperty': {
'ImmunityTime': 123
}
},
TokenDomains=[
'string',
],
AssociationConfig={
'RequestBody': {
'string': {
'DefaultSizeInspectionLimit': 'KB_8'|'KB_16'|'KB_32'|'KB_48'|'KB_64'
}
},
'ChallengeJavascriptSdkInjection': {
'string': {}
}
},
OnSourceDDoSProtectionConfig={
'ALBLowReputationMode': 'ACTIVE_UNDER_DDOS'|'ALWAYS_ON'
},
ApplicationConfig={
'Attributes': [
{
'Name': 'string',
'Values': [
'string',
]
},
]
},
MonetizationConfig={
'CryptoConfig': {
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA'|'BASE_SEPOLIA'|'SOLANA_DEVNET',
'WalletAddress': 'string',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
'ConnectedAccountConfigs': [
{
'ConnectedAccountArn': 'string',
'PaymentNetworks': [
{
'Chain': 'BASE'|'SOLANA',
'Prices': [
{
'Amount': 'string',
'Currency': 'USDC'
},
]
},
]
},
],
'CurrencyMode': 'REAL'|'TEST'
},
AnalyticsConfig={
'Mode': 'CROSS_REGION'|'DISABLED'
}
)
**Parameters**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/UpdateWebACL>`_
dict
Response Syntax
{
'NextLockToken': 'string'
}
Response Structure
(dict) --
NextLockToken (string) --
A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.