Get Protection Status

fms_get_protection_status

R Documentation

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack¶

Description¶

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.

Usage¶

fms_get_protection_status(PolicyId, MemberAccountId, StartTime, EndTime,
  NextToken, MaxResults)

Arguments¶

PolicyId

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

MemberAccountId

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

StartTime

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

EndTime

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

NextToken

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

MaxResults

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 MaxResults, the response includes a NextToken value that you can use to get another batch of objects.

Value¶

A list with the following syntax:

list(
  AdminAccountId = "string",
  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"|"NETWORK_ACL_COMMON",
  Data = "string",
  NextToken = "string"
)

Request syntax¶

svc$get_protection_status(
  PolicyId = "string",
  MemberAccountId = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  NextToken = "string",
  MaxResults = 123
)