fms_get_protection_status: If you created a Shield Advanced policy, returns policy-level...

Description Usage Arguments Request syntax

View source: R/fms_operations.R

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

1
2
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 AWS 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 AWS 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 AWS 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, AWS Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus 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 AWS 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.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
svc$get_protection_status(
  PolicyId = "string",
  MemberAccountId = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  NextToken = "string",
  MaxResults = 123
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.