Skip to content

/AWS1/CL_RDS=>DESCRIBEBLUEGREENDEPLOYMENTS()

About DescribeBlueGreenDeployments

Describes one or more blue/green deployments.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Method Signature

IMPORTING

Optional arguments:

iv_bluegreendeploymentid TYPE /AWS1/RDSBLUEGREENDEPLOYMENTID /AWS1/RDSBLUEGREENDEPLOYMENTID

The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn't case-sensitive.

Constraints:

  • Must match an existing blue/green deployment identifier.

it_filters TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

A filter that specifies one or more blue/green deployments to describe.

Valid Values:

  • blue-green-deployment-identifier - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.

  • blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.

  • source - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.

  • target - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.

iv_marker TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

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

iv_maxrecords TYPE /AWS1/RDSMAXRECORDS /AWS1/RDSMAXRECORDS

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 you can retrieve the remaining results.

Default: 100

Constraints:

  • Must be a minimum of 20.

  • Can't exceed 100.

RETURNING

oo_output TYPE REF TO /aws1/cl_rdsdscbluegreendepl01 /AWS1/CL_RDSDSCBLUEGREENDEPL01

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_rds~describebluegreendeployments(
  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_bluegreendeploymentid = |string|
  iv_marker = |string|
  iv_maxrecords = 123
).

This is an example of reading all possible response values

LOOP AT lo_result->get_bluegreendeployments( ) into lo_row.
  lv_bluegreendeploymentiden = lo_row_1->get_bluegreendeploymentid( ).
  lv_bluegreendeploymentname = lo_row_1->get_bluegreendeploymentname( ).
  lv_databasearn = lo_row_1->get_source( ).
  lv_databasearn = lo_row_1->get_target( ).
  LOOP AT lo_row_1->get_switchoverdetails( ) into lo_row_2.
    lv_databasearn = lo_row_3->get_sourcemember( ).
    lv_databasearn = lo_row_3->get_targetmember( ).
    lv_switchoverdetailstatus = lo_row_3->get_status( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_tasks( ) into lo_row_4.
    lv_bluegreendeploymenttask = lo_row_5->get_name( ).
    lv_bluegreendeploymenttask_1 = lo_row_5->get_status( ).
  ENDLOOP.
  lv_bluegreendeploymentstat = lo_row_1->get_status( ).
  lv_bluegreendeploymentstat_1 = lo_row_1->get_statusdetails( ).
  lv_tstamp = lo_row_1->get_createtime( ).
  lv_tstamp = lo_row_1->get_deletetime( ).
  LOOP AT lo_row_1->get_taglist( ) into lo_row_6.
    lv_string = lo_row_7->get_key( ).
    lv_string = lo_row_7->get_value( ).
  ENDLOOP.
ENDLOOP.
lv_string = lo_result->get_marker( ).