View a markdown version of this page

DescribeClusterOperation - Amazon SageMaker
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

DescribeClusterOperation

Retrieves detailed information about a specific operation for a given HyperPod cluster, such as a scaling operation or a deep health check. Use the OperationId returned by the ListClusterOperations operation to identify the operation to describe.

Request Syntax

{
   "ClusterName": "string",
   "OperationId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClusterName

The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the operation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ((arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}))

Required: Yes

OperationId

The unique identifier (UUID) of the operation to describe. This ID can be obtained from the ListClusterOperations operation.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Response Syntax

{
   "ClusterArn": "string",
   "CreationTime": number,
   "DeepHealthCheckDetails": [ 
      { 
         "DeepHealthChecks": [ "string" ],
         "InstanceGroupName": "string",
         "InstanceIds": [ "string" ]
      }
   ],
   "OperationId": "string",
   "ScalingDetails": [ 
      { 
         "Desired": { 
            "CurrentCount": number,
            "MinCount": number,
            "TargetCount": number
         },
         "InstanceGroupName": "string",
         "Original": { 
            "CurrentCount": number,
            "MinCount": number,
            "TargetCount": number
         },
         "Status": "string"
      }
   ],
   "Status": "string",
   "Type": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ClusterArn

The Amazon Resource Name (ARN) of the HyperPod cluster associated with the operation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}

CreationTime

The timestamp when the operation was created.

Type: Timestamp

DeepHealthCheckDetails

The deep health check details for the operation. This field is populated when the operation Type is DeepHealthCheck.

Type: Array of InstanceGroupHealthCheckConfiguration objects

Array Members: Minimum number of 1 item. Maximum number of 99 items.

OperationId

The unique identifier (UUID) of the operation.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

ScalingDetails

The per-instance-group scaling details for the operation. This field is populated when the operation Type is Scaling.

Type: Array of ClusterOperationScalingDetails objects

Status

The current status of the operation. Valid values are InProgress, Superseded, or Done.

Type: String

Valid Values: InProgress | Superseded | Done

Type

The type of the operation. Valid values are Scaling or DeepHealthCheck.

Type: String

Valid Values: Scaling | DeepHealthCheck

Errors

For information about the errors that are common to all actions, see Common Error Types.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: