/AWS1/IF_RDS=>DESCRIBEEXPORTTASKS()

About DescribeExportTasks

Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.

Method Signature

METHODS /AWS1/IF_RDS~DESCRIBEEXPORTTASKS
  IMPORTING
    !IV_EXPORTTASKIDENTIFIER TYPE /AWS1/RDSSTRING OPTIONAL
    !IV_SOURCEARN TYPE /AWS1/RDSSTRING OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MARKER TYPE /AWS1/RDSSTRING OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/RDSMAXRECORDS OPTIONAL
    !IV_SOURCETYPE TYPE /AWS1/RDSEXPORTSOURCETYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rdsexporttasksmessage
  RAISING
    /AWS1/CX_RDSEXPTASKNOTFNDFAULT
    /AWS1/CX_RDSCLIENTEXC
    /AWS1/CX_RDSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_exporttaskidentifier TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The identifier of the snapshot or cluster export task to be described.

iv_sourcearn TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

it_filters TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

• export-task-identifier - An identifier for the snapshot or cluster export task.

• s3-bucket - The Amazon S3 bucket the data is exported to.

• source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

• status - The status of the export task. Must be lowercase. Valid statuses are the following:

  • canceled

  • canceling

  • complete

  • failed

  • in_progress

  • starting

iv_marker TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

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

iv_maxrecords TYPE /AWS1/RDSMAXRECORDS /AWS1/RDSMAXRECORDS

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

iv_sourcetype TYPE /AWS1/RDSEXPORTSOURCETYPE /AWS1/RDSEXPORTSOURCETYPE

The type of source for the export.

RETURNING

oo_output TYPE REF TO /aws1/cl_rdsexporttasksmessage /AWS1/CL_RDSEXPORTTASKSMESSAGE

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->describeexporttasks(
  it_filters = VALUE /aws1/cl_rdsfilter=>tt_filterlist(
    (
      new /aws1/cl_rdsfilter(
        it_values = VALUE /aws1/cl_rdsfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_rdsfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_exporttaskidentifier = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_sourcearn = |string|
  iv_sourcetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_marker( ).
  LOOP AT lo_result->get_exporttasks( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_exporttaskidentifier( ).
      lv_string = lo_row_1->get_sourcearn( ).
      LOOP AT lo_row_1->get_exportonly( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_tstamp = lo_row_1->get_snapshottime( ).
      lv_tstamp = lo_row_1->get_taskstarttime( ).
      lv_tstamp = lo_row_1->get_taskendtime( ).
      lv_string = lo_row_1->get_s3bucket( ).
      lv_string = lo_row_1->get_s3prefix( ).
      lv_string = lo_row_1->get_iamrolearn( ).
      lv_string = lo_row_1->get_kmskeyid( ).
      lv_string = lo_row_1->get_status( ).
      lv_integer = lo_row_1->get_percentprogress( ).
      lv_integer = lo_row_1->get_totalextracteddataingb( ).
      lv_string = lo_row_1->get_failurecause( ).
      lv_string = lo_row_1->get_warningmessage( ).
      lv_exportsourcetype = lo_row_1->get_sourcetype( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To describe snapshot export tasks

The following example returns information about snapshot exports to Amazon S3.

DATA(lo_result) = lo_client->describeexporttasks( ).