Skip to content

/AWS1/CL_SGM=>LISTCLUSTERS()

About ListClusters

Retrieves the list of SageMaker HyperPod clusters.

Method Signature

IMPORTING

Optional arguments:

IV_CREATIONTIMEAFTER TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

Set the maximum number of SageMaker HyperPod clusters to list.

IV_NAMECONTAINS TYPE /AWS1/SGMNAMECONTAINS /AWS1/SGMNAMECONTAINS

Set the maximum number of instances to print in the list.

IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

Set the next token to retrieve the list of SageMaker HyperPod clusters.

IV_SORTBY TYPE /AWS1/SGMCLUSTERSORTBY /AWS1/SGMCLUSTERSORTBY

The field by which to sort results. The default value is CREATION_TIME.

IV_SORTORDER TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order for results. The default value is Ascending.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_SGMLISTCLUSTERSRSP /AWS1/CL_SGMLISTCLUSTERSRSP