List Clusters
sagemaker_list_clusters | R Documentation |
Retrieves the list of SageMaker HyperPod clusters¶
Description¶
Retrieves the list of SageMaker HyperPod clusters.
Usage¶
sagemaker_list_clusters(CreationTimeAfter, CreationTimeBefore,
MaxResults, NameContains, NextToken, SortBy, SortOrder)
Arguments¶
CreationTimeAfter
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.
CreationTimeBefore
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.MaxResults
Set the maximum number of SageMaker HyperPod clusters to list.
NameContains
Set the maximum number of instances to print in the list.
NextToken
Set the next token to retrieve the list of SageMaker HyperPod clusters.
SortBy
The field by which to sort results. The default value is
CREATION_TIME
.SortOrder
The sort order for results. The default value is
Ascending
.
Value¶
A list with the following syntax:
list(
NextToken = "string",
ClusterSummaries = list(
list(
ClusterArn = "string",
ClusterName = "string",
CreationTime = as.POSIXct(
"2015-01-01"
),
ClusterStatus = "Creating"|"Deleting"|"Failed"|"InService"|"RollingBack"|"SystemUpdating"|"Updating"
)
)
)