Skip to content

/AWS1/IF_EKS=>DESCRIBECLUSTERVERSIONS()

About DescribeClusterVersions

Lists available Kubernetes versions for Amazon EKS clusters.

Method Signature

METHODS /AWS1/IF_EKS~DESCRIBECLUSTERVERSIONS
  IMPORTING
    !IV_CLUSTERTYPE TYPE /AWS1/EKSSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EKSDESCRCLUSTVRSMAXRSLTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EKSSTRING OPTIONAL
    !IV_DEFAULTONLY TYPE /AWS1/EKSBOXEDBOOLEAN OPTIONAL
    !IV_INCLUDEALL TYPE /AWS1/EKSBOXEDBOOLEAN OPTIONAL
    !IT_CLUSTERVERSIONS TYPE /AWS1/CL_EKSSTRINGLIST_W=>TT_STRINGLIST OPTIONAL
    !IV_STATUS TYPE /AWS1/EKSCLUSTERVERSIONSTATUS OPTIONAL
    !IV_VERSIONSTATUS TYPE /AWS1/EKSVERSIONSTATUS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_eksdescrclustvrssrsp
  RAISING
    /AWS1/CX_EKSINVALIDPARAMETEREX
    /AWS1/CX_EKSINVALIDREQUESTEX
    /AWS1/CX_EKSSERVEREXCEPTION
    /AWS1/CX_EKSCLIENTEXC
    /AWS1/CX_EKSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_clustertype TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

The type of cluster to filter versions by.

iv_maxresults TYPE /AWS1/EKSDESCRCLUSTVRSMAXRSLTS /AWS1/EKSDESCRCLUSTVRSMAXRSLTS

Maximum number of results to return.

iv_nexttoken TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

Pagination token for the next set of results.

iv_defaultonly TYPE /AWS1/EKSBOXEDBOOLEAN /AWS1/EKSBOXEDBOOLEAN

Filter to show only default versions.

iv_includeall TYPE /AWS1/EKSBOXEDBOOLEAN /AWS1/EKSBOXEDBOOLEAN

Include all available versions in the response.

it_clusterversions TYPE /AWS1/CL_EKSSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

List of specific cluster versions to describe.

iv_status TYPE /AWS1/EKSCLUSTERVERSIONSTATUS /AWS1/EKSCLUSTERVERSIONSTATUS

This field is deprecated. Use versionStatus instead, as that field matches for input and output of this action.

Filter versions by their current status.

iv_versionstatus TYPE /AWS1/EKSVERSIONSTATUS /AWS1/EKSVERSIONSTATUS

Filter versions by their current status.

RETURNING

oo_output TYPE REF TO /aws1/cl_eksdescrclustvrssrsp /AWS1/CL_EKSDESCRCLUSTVRSSRSP

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->describeclusterversions(
  it_clusterversions = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
    ( new /aws1/cl_eksstringlist_w( |string| ) )
  )
  iv_clustertype = |string|
  iv_defaultonly = ABAP_TRUE
  iv_includeall = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_status = |string|
  iv_versionstatus = |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_nexttoken( ).
  LOOP AT lo_result->get_clusterversions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_clusterversion( ).
      lv_string = lo_row_1->get_clustertype( ).
      lv_string = lo_row_1->get_defaultplatformversion( ).
      lv_boolean = lo_row_1->get_defaultversion( ).
      lv_timestamp = lo_row_1->get_releasedate( ).
      lv_timestamp = lo_row_1->get_endofstandardsupportdate( ).
      lv_timestamp = lo_row_1->get_endofextendedsupportdate( ).
      lv_clusterversionstatus = lo_row_1->get_status( ).
      lv_versionstatus = lo_row_1->get_versionstatus( ).
      lv_string = lo_row_1->get_kubernetespatchversion( ).
    ENDIF.
  ENDLOOP.
ENDIF.