/AWS1/IF_RSH=>DESCRIBECLUSTERS()

About DescribeClusters

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.

If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.

Method Signature

IMPORTING

Optional arguments:

iv_clusteridentifier TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

iv_maxrecords TYPE /AWS1/RSHINTEGEROPTIONAL /AWS1/RSHINTEGEROPTIONAL

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

iv_marker TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

it_tagkeys TYPE /AWS1/CL_RSHTAGKEYLIST_W=>TT_TAGKEYLIST TT_TAGKEYLIST

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

it_tagvalues TYPE /AWS1/CL_RSHTAGVALUELIST_W=>TT_TAGVALUELIST TT_TAGVALUELIST

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

RETURNING

oo_output TYPE REF TO /aws1/cl_rshclustersmessage /AWS1/CL_RSHCLUSTERSMESSAGE

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->/aws1/if_rsh~describeclusters(
  it_tagkeys = VALUE /aws1/cl_rshtagkeylist_w=>tt_tagkeylist(
    ( new /aws1/cl_rshtagkeylist_w( |string| ) )
  )
  it_tagvalues = VALUE /aws1/cl_rshtagvaluelist_w=>tt_tagvaluelist(
    ( new /aws1/cl_rshtagvaluelist_w( |string| ) )
  )
  iv_clusteridentifier = |string|
  iv_marker = |string|
  iv_maxrecords = 123
).

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_clusters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_clusteridentifier( ).
      lv_string = lo_row_1->get_nodetype( ).
      lv_string = lo_row_1->get_clusterstatus( ).
      lv_string = lo_row_1->get_clustavailabilitystatus( ).
      lv_string = lo_row_1->get_modifystatus( ).
      lv_string = lo_row_1->get_masterusername( ).
      lv_string = lo_row_1->get_dbname( ).
      lo_endpoint = lo_row_1->get_endpoint( ).
      IF lo_endpoint IS NOT INITIAL.
        lv_string = lo_endpoint->get_address( ).
        lv_integer = lo_endpoint->get_port( ).
        LOOP AT lo_endpoint->get_vpcendpoints( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_string = lo_row_3->get_vpcendpointid( ).
            lv_string = lo_row_3->get_vpcid( ).
            LOOP AT lo_row_3->get_networkinterfaces( ) into lo_row_4.
              lo_row_5 = lo_row_4.
              IF lo_row_5 IS NOT INITIAL.
                lv_string = lo_row_5->get_networkinterfaceid( ).
                lv_string = lo_row_5->get_subnetid( ).
                lv_string = lo_row_5->get_privateipaddress( ).
                lv_string = lo_row_5->get_availabilityzone( ).
                lv_string = lo_row_5->get_ipv6address( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_tstamp = lo_row_1->get_clustercreatetime( ).
      lv_integer = lo_row_1->get_automatedsnapretperiod( ).
      lv_integer = lo_row_1->get_manualsnapshotretperiod( ).
      LOOP AT lo_row_1->get_clustersecuritygroups( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_string = lo_row_7->get_clustersecuritygroupname( ).
          lv_string = lo_row_7->get_status( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_vpcsecuritygroups( ) into lo_row_8.
        lo_row_9 = lo_row_8.
        IF lo_row_9 IS NOT INITIAL.
          lv_string = lo_row_9->get_vpcsecuritygroupid( ).
          lv_string = lo_row_9->get_status( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_clusterparametergroups( ) into lo_row_10.
        lo_row_11 = lo_row_10.
        IF lo_row_11 IS NOT INITIAL.
          lv_string = lo_row_11->get_parametergroupname( ).
          lv_string = lo_row_11->get_parameterapplystatus( ).
          LOOP AT lo_row_11->get_clusterparamstatuslist( ) into lo_row_12.
            lo_row_13 = lo_row_12.
            IF lo_row_13 IS NOT INITIAL.
              lv_string = lo_row_13->get_parametername( ).
              lv_string = lo_row_13->get_parameterapplystatus( ).
              lv_string = lo_row_13->get_parameterapplyerrordesc( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_clustersubnetgroupname( ).
      lv_string = lo_row_1->get_vpcid( ).
      lv_string = lo_row_1->get_availabilityzone( ).
      lv_string = lo_row_1->get_preferredmaintenancewi00( ).
      lo_pendingmodifiedvalues = lo_row_1->get_pendingmodifiedvalues( ).
      IF lo_pendingmodifiedvalues IS NOT INITIAL.
        lv_sensitivestring = lo_pendingmodifiedvalues->get_masteruserpassword( ).
        lv_string = lo_pendingmodifiedvalues->get_nodetype( ).
        lv_integeroptional = lo_pendingmodifiedvalues->get_numberofnodes( ).
        lv_string = lo_pendingmodifiedvalues->get_clustertype( ).
        lv_string = lo_pendingmodifiedvalues->get_clusterversion( ).
        lv_integeroptional = lo_pendingmodifiedvalues->get_automatedsnapretperiod( ).
        lv_string = lo_pendingmodifiedvalues->get_clusteridentifier( ).
        lv_booleanoptional = lo_pendingmodifiedvalues->get_publiclyaccessible( ).
        lv_booleanoptional = lo_pendingmodifiedvalues->get_enhancedvpcrouting( ).
        lv_string = lo_pendingmodifiedvalues->get_maintenancetrackname( ).
        lv_string = lo_pendingmodifiedvalues->get_encryptiontype( ).
      ENDIF.
      lv_string = lo_row_1->get_clusterversion( ).
      lv_boolean = lo_row_1->get_allowversionupgrade( ).
      lv_integer = lo_row_1->get_numberofnodes( ).
      lv_boolean = lo_row_1->get_publiclyaccessible( ).
      lv_boolean = lo_row_1->get_encrypted( ).
      lo_restorestatus = lo_row_1->get_restorestatus( ).
      IF lo_restorestatus IS NOT INITIAL.
        lv_string = lo_restorestatus->get_status( ).
        lv_double = lo_restorestatus->get_currentrestorerateinme00( ).
        lv_long = lo_restorestatus->get_snapshotsizeinmegabytes( ).
        lv_long = lo_restorestatus->get_progressinmegabytes( ).
        lv_long = lo_restorestatus->get_elapsedtimeinseconds( ).
        lv_long = lo_restorestatus->get_estimatedtimetocomplet00( ).
      ENDIF.
      lo_datatransferprogress = lo_row_1->get_datatransferprogress( ).
      IF lo_datatransferprogress IS NOT INITIAL.
        lv_string = lo_datatransferprogress->get_status( ).
        lv_doubleoptional = lo_datatransferprogress->get_currentrateinmegabytes00( ).
        lv_long = lo_datatransferprogress->get_totaldatainmegabytes( ).
        lv_long = lo_datatransferprogress->get_dataxferredinmegabytes( ).
        lv_longoptional = lo_datatransferprogress->get_estimatedtimetocomplet00( ).
        lv_longoptional = lo_datatransferprogress->get_elapsedtimeinseconds( ).
      ENDIF.
      lo_hsmstatus = lo_row_1->get_hsmstatus( ).
      IF lo_hsmstatus IS NOT INITIAL.
        lv_string = lo_hsmstatus->get_hsmclientcertidentifier( ).
        lv_string = lo_hsmstatus->get_hsmconfidentifier( ).
        lv_string = lo_hsmstatus->get_status( ).
      ENDIF.
      lo_clustersnapshotcopystat = lo_row_1->get_clustersnapcopystatus( ).
      IF lo_clustersnapshotcopystat IS NOT INITIAL.
        lv_string = lo_clustersnapshotcopystat->get_destinationregion( ).
        lv_long = lo_clustersnapshotcopystat->get_retentionperiod( ).
        lv_integer = lo_clustersnapshotcopystat->get_manualsnapshotretperiod( ).
        lv_string = lo_clustersnapshotcopystat->get_snapshotcopygrantname( ).
      ENDIF.
      lv_string = lo_row_1->get_clusterpublickey( ).
      LOOP AT lo_row_1->get_clusternodes( ) into lo_row_14.
        lo_row_15 = lo_row_14.
        IF lo_row_15 IS NOT INITIAL.
          lv_string = lo_row_15->get_noderole( ).
          lv_string = lo_row_15->get_privateipaddress( ).
          lv_string = lo_row_15->get_publicipaddress( ).
        ENDIF.
      ENDLOOP.
      lo_elasticipstatus = lo_row_1->get_elasticipstatus( ).
      IF lo_elasticipstatus IS NOT INITIAL.
        lv_string = lo_elasticipstatus->get_elasticip( ).
        lv_string = lo_elasticipstatus->get_status( ).
      ENDIF.
      lv_string = lo_row_1->get_clusterrevisionnumber( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_16.
        lo_row_17 = lo_row_16.
        IF lo_row_17 IS NOT INITIAL.
          lv_string = lo_row_17->get_key( ).
          lv_string = lo_row_17->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_kmskeyid( ).
      lv_boolean = lo_row_1->get_enhancedvpcrouting( ).
      LOOP AT lo_row_1->get_iamroles( ) into lo_row_18.
        lo_row_19 = lo_row_18.
        IF lo_row_19 IS NOT INITIAL.
          lv_string = lo_row_19->get_iamrolearn( ).
          lv_string = lo_row_19->get_applystatus( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_pendingactions( ) into lo_row_20.
        lo_row_21 = lo_row_20.
        IF lo_row_21 IS NOT INITIAL.
          lv_string = lo_row_21->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_maintenancetrackname( ).
      lv_string = lo_row_1->get_elasticresizenumofnode00( ).
      LOOP AT lo_row_1->get_deferredmaintenancewin00( ) into lo_row_22.
        lo_row_23 = lo_row_22.
        IF lo_row_23 IS NOT INITIAL.
          lv_string = lo_row_23->get_defermaintenanceid( ).
          lv_tstamp = lo_row_23->get_defermaintenancestrttime( ).
          lv_tstamp = lo_row_23->get_defermaintenanceendtime( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_snapshotscheduleid( ).
      lv_schedulestate = lo_row_1->get_snapshotschedulestate( ).
      lv_tstamp = lo_row_1->get_expectednextsnapschdtime( ).
      lv_string = lo_row_1->get_expectednextsnapschdti00( ).
      lv_tstamp = lo_row_1->get_nextmaintenancewindows00( ).
      lo_resizeinfo = lo_row_1->get_resizeinfo( ).
      IF lo_resizeinfo IS NOT INITIAL.
        lv_string = lo_resizeinfo->get_resizetype( ).
        lv_boolean = lo_resizeinfo->get_allowcancelresize( ).
      ENDIF.
      lv_string = lo_row_1->get_azrelocationstatus( ).
      lv_string = lo_row_1->get_clusternamespacearn( ).
      lv_longoptional = lo_row_1->get_totalstrgcapinmegabytes( ).
      lo_aquaconfiguration = lo_row_1->get_aquaconfiguration( ).
      IF lo_aquaconfiguration IS NOT INITIAL.
        lv_aquastatus = lo_aquaconfiguration->get_aquastatus( ).
        lv_aquaconfigurationstatus = lo_aquaconfiguration->get_aquaconfigurationstatus( ).
      ENDIF.
      lv_string = lo_row_1->get_defaultiamrolearn( ).
      lo_reservednodeexchangesta = lo_row_1->get_rsvdnodeexchangestatus( ).
      IF lo_reservednodeexchangesta IS NOT INITIAL.
        lv_string = lo_reservednodeexchangesta->get_rsvdnodeexchangereqid( ).
        lv_reservednodeexchangesta_1 = lo_reservednodeexchangesta->get_status( ).
        lv_tstamp = lo_reservednodeexchangesta->get_requesttime( ).
        lv_string = lo_reservednodeexchangesta->get_sourcereservednodeid( ).
        lv_string = lo_reservednodeexchangesta->get_sourcereservednodetype( ).
        lv_integer = lo_reservednodeexchangesta->get_sourcereservednodecount( ).
        lv_string = lo_reservednodeexchangesta->get_targetrsvdnodeofferingid( ).
        lv_string = lo_reservednodeexchangesta->get_targetreservednodetype( ).
        lv_integer = lo_reservednodeexchangesta->get_targetreservednodecount( ).
      ENDIF.
      lv_string = lo_row_1->get_customdomainname( ).
      lv_string = lo_row_1->get_customdomaincertarn( ).
      lv_tstamp = lo_row_1->get_customdomcertexpirydate( ).
      lv_string = lo_row_1->get_masterpasswordsecretarn( ).
      lv_string = lo_row_1->get_masterpasswordsecretkm00( ).
      lv_string = lo_row_1->get_ipaddresstype( ).
      lv_string = lo_row_1->get_multiaz( ).
      lo_secondaryclusterinfo = lo_row_1->get_multiazsecondary( ).
      IF lo_secondaryclusterinfo IS NOT INITIAL.
        lv_string = lo_secondaryclusterinfo->get_availabilityzone( ).
        LOOP AT lo_secondaryclusterinfo->get_clusternodes( ) into lo_row_14.
          lo_row_15 = lo_row_14.
          IF lo_row_15 IS NOT INITIAL.
            lv_string = lo_row_15->get_noderole( ).
            lv_string = lo_row_15->get_privateipaddress( ).
            lv_string = lo_row_15->get_publicipaddress( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.