protection_status

Creates, updates, deletes, gets or lists a protection_status resource.

Overview

Name	protection_status
Type	Resource
Id	aws.fms.protection_status

Fields

The following fields are returned by SELECT queries:

get_protection_status

Name	Datatype	Description
admin_account_id	string	The ID of the Firewall Manager administrator account for this policy. (pattern: <code>^[0-9]+$</code>)
data	string	Details about the attack, including the following: Attack type Account ID ARN of the resource attacked Start time of the attack End time of the attack (ongoing attacks will not have an end time) The details are in JSON format.
next_token	string	If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request. Amazon Web Services SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus. You must submit subsequent requests with NextToken using your own processes. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>)
service_type	string	The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED. (WAF, WAFV2, SHIELD_ADVANCED, SECURITY_GROUPS_COMMON, SECURITY_GROUPS_CONTENT_AUDIT, SECURITY_GROUPS_USAGE_AUDIT, NETWORK_FIREWALL, DNS_FIREWALL, THIRD_PARTY_FIREWALL, IMPORT_NETWORK_FIREWALL, NETWORK_ACL_COMMON)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_protection_status	select	region		If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_protection_status

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.

SELECT
admin_account_id,
data,
next_token,
service_type
FROM aws.fms.protection_status
WHERE region = '{{ region }}' -- required
;