DESCRIBECONFRECORDERSTATUS()`¶

About DescribeConfigurationRecorderStatus¶

Returns the current status of the configuration recorder you specify as well as the status of the last recording event for the configuration recorders.

For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.

If a configuration recorder is not specified, this operation returns the status for the customer managed configuration recorder configured for the account, if applicable.

When making a request to this operation, you can only specify one configuration recorder.

Method Signature¶

METHODS /AWS1/IF_CFS~DESCRIBECONFRECORDERSTATUS
  IMPORTING
    !IT_CONFRECORDERNAMES TYPE /AWS1/CL_CFSCONFRECERNAMELST_W=>TT_CONFRECORDERNAMELIST OPTIONAL
    !IV_SERVICEPRINCIPAL TYPE /AWS1/CFSSERVICEPRINCIPAL OPTIONAL
    !IV_ARN TYPE /AWS1/CFSAMAZONRESOURCENAME OPTIONAL
  PREFERRED PARAMETER it_confrecordernames
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cfsdscconfrcerstatrsp
  RAISING
    /AWS1/CX_CFSNOSUCHCONFRECEREX
    /AWS1/CX_CFSVALIDATIONEX
    /AWS1/CX_CFSCLIENTEXC
    /AWS1/CX_CFSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_confrecordernames` `TYPE /AWS1/CL_CFSCONFRECERNAMELST_W=>TT_CONFRECORDERNAMELIST` `TT_CONFRECORDERNAMELIST`¶

The name of the configuration recorder. If the name is not specified, the operation returns the status for the customer managed configuration recorder configured for the account, if applicable.

When making a request to this operation, you can only specify one configuration recorder.

`iv_serviceprincipal` `TYPE /AWS1/CFSSERVICEPRINCIPAL` `/AWS1/CFSSERVICEPRINCIPAL`¶

For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder.

`iv_arn` `TYPE /AWS1/CFSAMAZONRESOURCENAME` `/AWS1/CFSAMAZONRESOURCENAME`¶

The Amazon Resource Name (ARN) of the configuration recorder that you want to specify.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cfsdscconfrcerstatrsp` `/AWS1/CL_CFSDSCCONFRCERSTATRSP`¶

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->describeconfrecorderstatus(
  it_confrecordernames = VALUE /aws1/cl_cfsconfrecernamelst_w=>tt_confrecordernamelist(
    ( new /aws1/cl_cfsconfrecernamelst_w( |string| ) )
  )
  iv_arn = |string|
  iv_serviceprincipal = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_confrecordersstatus( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_amazonresourcename = lo_row_1->get_arn( ).
      lv_string = lo_row_1->get_name( ).
      lv_date = lo_row_1->get_laststarttime( ).
      lv_date = lo_row_1->get_laststoptime( ).
      lv_boolean = lo_row_1->get_recording( ).
      lv_recorderstatus = lo_row_1->get_laststatus( ).
      lv_string = lo_row_1->get_lasterrorcode( ).
      lv_string = lo_row_1->get_lasterrormessage( ).
      lv_date = lo_row_1->get_laststatuschangetime( ).
      lv_serviceprincipal = lo_row_1->get_serviceprincipal( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_CFS=>DESCRIBECONFRECORDERSTATUS()¶