Skip to content

/AWS1/IF_FMS=>GETPROTECTIONSTATUS()

About GetProtectionStatus

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.

Method Signature

METHODS /AWS1/IF_FMS~GETPROTECTIONSTATUS
  IMPORTING
    !IV_POLICYID TYPE /AWS1/FMSPOLICYID OPTIONAL
    !IV_MEMBERACCOUNTID TYPE /AWS1/FMSAWSACCOUNTID OPTIONAL
    !IV_STARTTIME TYPE /AWS1/FMSTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/FMSTIMESTAMP OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/FMSPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/FMSPAGINATIONMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fmsgetprotectionsta01
  RAISING
    /AWS1/CX_FMSINTERNALERROREX
    /AWS1/CX_FMSINVALIDINPUTEX
    /AWS1/CX_FMSRESOURCENOTFOUNDEX
    /AWS1/CX_FMSCLIENTEXC
    /AWS1/CX_FMSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_policyid TYPE /AWS1/FMSPOLICYID /AWS1/FMSPOLICYID

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

Optional arguments:

iv_memberaccountid TYPE /AWS1/FMSAWSACCOUNTID /AWS1/FMSAWSACCOUNTID

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

iv_starttime TYPE /AWS1/FMSTIMESTAMP /AWS1/FMSTIMESTAMP

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.

iv_endtime TYPE /AWS1/FMSTIMESTAMP /AWS1/FMSTIMESTAMP

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.

iv_nexttoken TYPE /AWS1/FMSPAGINATIONTOKEN /AWS1/FMSPAGINATIONTOKEN

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 GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.

iv_maxresults TYPE /AWS1/FMSPAGINATIONMAXRESULTS /AWS1/FMSPAGINATIONMAXRESULTS

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_fmsgetprotectionsta01 /AWS1/CL_FMSGETPROTECTIONSTA01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getprotectionstatus(
  iv_endtime = '20150101000000.0000000'
  iv_maxresults = 123
  iv_memberaccountid = |string|
  iv_nexttoken = |string|
  iv_policyid = |string|
  iv_starttime = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_awsaccountid = lo_result->get_adminaccountid( ).
  lv_securityservicetype = lo_result->get_servicetype( ).
  lv_protectiondata = lo_result->get_data( ).
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.