DESCRIBETABLERESTORESTATUS()`¶

About DescribeTableRestoreStatus¶

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.

Method Signature¶

METHODS /AWS1/IF_RSH~DESCRIBETABLERESTORESTATUS
  IMPORTING
    !IV_CLUSTERIDENTIFIER TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_TABLERESTOREREQUESTID TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/RSHINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/RSHSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rshtblrestorestatmsg
  RAISING
    /AWS1/CX_RSHCLUSTNOTFOUNDFAULT
    /AWS1/CX_RSHTBLRESTORENOTFND00
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_clusteridentifier` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The Amazon Redshift cluster that the table is being restored to.

`iv_tablerestorerequestid` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

`iv_maxrecords` `TYPE /AWS1/RSHINTEGEROPTIONAL` `/AWS1/RSHINTEGEROPTIONAL`¶

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

`iv_marker` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rshtblrestorestatmsg` `/AWS1/CL_RSHTBLRESTORESTATMSG`¶

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->describetablerestorestatus(
  iv_clusteridentifier = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_tablerestorerequestid = |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_tablerestorestatusdets( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_tablerestorerequestid( ).
      lv_tablerestorestatustype = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_message( ).
      lv_tstamp = lo_row_1->get_requesttime( ).
      lv_longoptional = lo_row_1->get_progressinmegabytes( ).
      lv_longoptional = lo_row_1->get_totaldatainmegabytes( ).
      lv_string = lo_row_1->get_clusteridentifier( ).
      lv_string = lo_row_1->get_snapshotidentifier( ).
      lv_string = lo_row_1->get_sourcedatabasename( ).
      lv_string = lo_row_1->get_sourceschemaname( ).
      lv_string = lo_row_1->get_sourcetablename( ).
      lv_string = lo_row_1->get_targetdatabasename( ).
      lv_string = lo_row_1->get_targetschemaname( ).
      lv_string = lo_row_1->get_newtablename( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.

/AWS1/IF_RSH=>DESCRIBETABLERESTORESTATUS()¶