DESCRIBEUPDATE()`¶

About DescribeUpdate¶

Describes an update to an Amazon EKS resource.

When the status of the update is Successful, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

Method Signature¶

METHODS /AWS1/IF_EKS~DESCRIBEUPDATE
  IMPORTING
    !IV_NAME TYPE /AWS1/EKSSTRING OPTIONAL
    !IV_UPDATEID TYPE /AWS1/EKSSTRING OPTIONAL
    !IV_NODEGROUPNAME TYPE /AWS1/EKSSTRING OPTIONAL
    !IV_ADDONNAME TYPE /AWS1/EKSSTRING OPTIONAL
    !IV_CAPABILITYNAME TYPE /AWS1/EKSSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_eksdescrupdatersp
  RAISING
    /AWS1/CX_EKSCLIENTEXCEPTION
    /AWS1/CX_EKSINVALIDPARAMETEREX
    /AWS1/CX_EKSRESOURCENOTFOUNDEX
    /AWS1/CX_EKSSERVEREXCEPTION
    /AWS1/CX_EKSCLIENTEXC
    /AWS1/CX_EKSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/EKSSTRING` `/AWS1/EKSSTRING`¶

The name of the Amazon EKS cluster associated with the update.

`iv_updateid` `TYPE /AWS1/EKSSTRING` `/AWS1/EKSSTRING`¶

The ID of the update to describe.

Optional arguments:¶

`iv_nodegroupname` `TYPE /AWS1/EKSSTRING` `/AWS1/EKSSTRING`¶

The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.

`iv_addonname` `TYPE /AWS1/EKSSTRING` `/AWS1/EKSSTRING`¶

The name of the add-on. The name must match one of the names returned by ListAddons . This parameter is required if the update is an add-on update.

`iv_capabilityname` `TYPE /AWS1/EKSSTRING` `/AWS1/EKSSTRING`¶

The name of the capability for which you want to describe updates.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_eksdescrupdatersp` `/AWS1/CL_EKSDESCRUPDATERSP`¶

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->describeupdate(
  iv_addonname = |string|
  iv_capabilityname = |string|
  iv_name = |string|
  iv_nodegroupname = |string|
  iv_updateid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_update = lo_result->get_update( ).
  IF lo_update IS NOT INITIAL.
    lv_string = lo_update->get_id( ).
    lv_updatestatus = lo_update->get_status( ).
    lv_updatetype = lo_update->get_type( ).
    LOOP AT lo_update->get_params( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_updateparamtype = lo_row_1->get_type( ).
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_timestamp = lo_update->get_createdat( ).
    LOOP AT lo_update->get_errors( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_errorcode = lo_row_3->get_errorcode( ).
        lv_string = lo_row_3->get_errormessage( ).
        LOOP AT lo_row_3->get_resourceids( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_string = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_EKS=>DESCRIBEUPDATE()¶