Skip to content

/AWS1/IF_NEP=>DESCRIBEDBCLUSTERSNAPSHOTS()

About DescribeDBClusterSnapshots

Returns information about DB cluster snapshots. This API action supports pagination.

Method Signature

METHODS /AWS1/IF_NEP~DESCRIBEDBCLUSTERSNAPSHOTS
  IMPORTING
    !IV_DBCLUSTERIDENTIFIER TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_DBCLUSTERSNAPSHOTID TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_SNAPSHOTTYPE TYPE /AWS1/NEPSTRING OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_NEPFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/NEPINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_INCLUDESHARED TYPE /AWS1/NEPBOOLEAN OPTIONAL
    !IV_INCLUDEPUBLIC TYPE /AWS1/NEPBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nepdbclustsnapmessage
  RAISING
    /AWS1/CX_NEPDBCLSTSNAPNOTFND00
    /AWS1/CX_NEPCLIENTEXC
    /AWS1/CX_NEPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_dbclusteridentifier TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBCluster.

iv_dbclustersnapshotid TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • If supplied, must match the identifier of an existing DBClusterSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

iv_snapshottype TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The type of DB cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.

  • manual - Return all DB cluster snapshots that have been taken by my Amazon account.

  • shared - Return all manual DB cluster snapshots that have been shared to my Amazon account.

  • public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

it_filters TYPE /AWS1/CL_NEPFILTER=>TT_FILTERLIST TT_FILTERLIST

This parameter is not currently supported.

iv_maxrecords TYPE /AWS1/NEPINTEGEROPTIONAL /AWS1/NEPINTEGEROPTIONAL

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.

Default: 100

Constraints: Minimum 20, maximum 100.

iv_marker TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

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

iv_includeshared TYPE /AWS1/NEPBOOLEAN /AWS1/NEPBOOLEAN

True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.

iv_includepublic TYPE /AWS1/NEPBOOLEAN /AWS1/NEPBOOLEAN

True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is false. The default is false.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

RETURNING

oo_output TYPE REF TO /aws1/cl_nepdbclustsnapmessage /AWS1/CL_NEPDBCLUSTSNAPMESSAGE

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->describedbclustersnapshots(
  it_filters = VALUE /aws1/cl_nepfilter=>tt_filterlist(
    (
      new /aws1/cl_nepfilter(
        it_values = VALUE /aws1/cl_nepfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_nepfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_dbclusteridentifier = |string|
  iv_dbclustersnapshotid = |string|
  iv_includepublic = ABAP_TRUE
  iv_includeshared = ABAP_TRUE
  iv_marker = |string|
  iv_maxrecords = 123
  iv_snapshottype = |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_dbclustersnapshots( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      LOOP AT lo_row_1->get_availabilityzones( ) 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_string = lo_row_1->get_dbclustersnapshotid( ).
      lv_string = lo_row_1->get_dbclusteridentifier( ).
      lv_tstamp = lo_row_1->get_snapshotcreatetime( ).
      lv_string = lo_row_1->get_engine( ).
      lv_integer = lo_row_1->get_allocatedstorage( ).
      lv_string = lo_row_1->get_status( ).
      lv_integer = lo_row_1->get_port( ).
      lv_string = lo_row_1->get_vpcid( ).
      lv_tstamp = lo_row_1->get_clustercreatetime( ).
      lv_string = lo_row_1->get_masterusername( ).
      lv_string = lo_row_1->get_engineversion( ).
      lv_string = lo_row_1->get_licensemodel( ).
      lv_string = lo_row_1->get_snapshottype( ).
      lv_integer = lo_row_1->get_percentprogress( ).
      lv_boolean = lo_row_1->get_storageencrypted( ).
      lv_string = lo_row_1->get_kmskeyid( ).
      lv_string = lo_row_1->get_dbclustersnapshotarn( ).
      lv_string = lo_row_1->get_sourcedbclustersnaparn( ).
      lv_boolean = lo_row_1->get_iamdatabaseauthntctnenbd( ).
      lv_string = lo_row_1->get_storagetype( ).
    ENDIF.
  ENDLOOP.
ENDIF.