v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442269245.1 KB

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.

post/#X-Amz-Target=AWSFMS_20180101.GetProtectionStatus

Headers

X-Amz-Target'AWSFMS_20180101.GetProtectionStatus' required

Request body

PolicyIdstring required

The ID of the policy for which you want to get the attack information.

MemberAccountIdstring

The Amazon Web Services account that is in scope of the policy that you want to get the details for.

StartTimestring date-time

The start of the time period to query for the attacks. This is a <code>timestamp</code> type. The request syntax listing indicates a <code>number</code> type because the default used by Firewall Manager is Unix time in seconds. However, any valid <code>timestamp</code> format is allowed.

EndTimestring date-time

The end of the time period to query for the attacks. This is a <code>timestamp</code> type. The request syntax listing indicates a <code>number</code> type because the default used by Firewall Manager is Unix time in seconds. However, any valid <code>timestamp</code> format is allowed.

NextTokenstring

If you specify a value for <code>MaxResults</code> and you have more objects than the number that you specify for <code>MaxResults</code>, Firewall Manager returns a <code>NextToken</code> value in the response, which you can use to retrieve another group of objects. For the second and subsequent <code>GetProtectionStatus</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of objects.

MaxResultsinteger

Specifies the number of objects that you want Firewall Manager to return for this request. If you have more objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of objects.

Response

Success

AdminAccountIdstring

The ID of the Firewall Manager administrator account for this policy.

ServiceType'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'

The service type that is protected by the policy. Currently, this is always <code>SHIELD_ADVANCED</code>.

Datastring
<p>Details about the attack, including the following:</p> <ul> <li> <p>Attack type</p> </li> <li> <p>Account ID</p> </li> <li> <p>ARN of the resource attacked</p> </li> <li> <p>Start time of the attack</p> </li> <li> <p>End time of the attack (ongoing attacks will not have an end time)</p> </li> </ul> <p>The details are in JSON format. </p>
NextTokenstring
<p>If you have more objects than the number that you specified for <code>MaxResults</code> in the request, the response includes a <code>NextToken</code> value. To list more objects, submit another <code>GetProtectionStatus</code> request, and specify the <code>NextToken</code> value from the response in the <code>NextToken</code> value in the next request.</p> <p>Amazon Web Services SDKs provide auto-pagination that identify <code>NextToken</code> in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by <code>GetProtectionStatus</code>. You must submit subsequent requests with <code>NextToken</code> using your own processes. </p>