STARTCLUSTERHEALTHCHECK()`¶

About StartClusterHealthCheck¶

Start deep health checks for a SageMaker HyperPod cluster. You can use DescribeClusterNode API to track progress of the deep health checks. The unhealthy nodes will be automatically rebooted or replaced. Please see Resilience-related Kubernetes labels by SageMaker HyperPod for details.

Method Signature¶

METHODS /AWS1/IF_SGM~STARTCLUSTERHEALTHCHECK
  IMPORTING
    !IV_CLUSTERNAME TYPE /AWS1/SGMCLUSTERNAMEORARN OPTIONAL
    !IT_DEEPHEALTHCHECKCONFS TYPE /AWS1/CL_SGMINSTGRPHLTHCHKCONF=>TT_DEEPHEALTHCHECKCONFS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmstrtclsthlthchkrsp
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_clustername` `TYPE /AWS1/SGMCLUSTERNAMEORARN` `/AWS1/SGMCLUSTERNAMEORARN`¶

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

`it_deephealthcheckconfs` `TYPE /AWS1/CL_SGMINSTGRPHLTHCHKCONF=>TT_DEEPHEALTHCHECKCONFS` `TT_DEEPHEALTHCHECKCONFS`¶

A list of configurations containing instance group names, EC2 instance IDs, and deep health checks to perform.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgmstrtclsthlthchkrsp` `/AWS1/CL_SGMSTRTCLSTHLTHCHKRSP`¶

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->startclusterhealthcheck(
  it_deephealthcheckconfs = VALUE /aws1/cl_sgminstgrphlthchkconf=>tt_deephealthcheckconfs(
    (
      new /aws1/cl_sgminstgrphlthchkconf(
        it_deephealthchecks = VALUE /aws1/cl_sgmdeephealthchecks_w=>tt_deephealthchecks(
          ( new /aws1/cl_sgmdeephealthchecks_w( |string| ) )
        )
        it_instanceids = VALUE /aws1/cl_sgminstanceids_w=>tt_instanceids(
          ( new /aws1/cl_sgminstanceids_w( |string| ) )
        )
        iv_instancegroupname = |string|
      )
    )
  )
  iv_clustername = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_clusterarn = lo_result->get_clusterarn( ).
ENDIF.

/AWS1/IF_SGM=>STARTCLUSTERHEALTHCHECK()¶