Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeClusterEvent

Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous.

Request Syntax


{
   "ClusterName": "string",
   "EventId": "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 event.

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

EventId

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

Type: String

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

Required: Yes

Response Syntax


{
   "EventDetails": { 
      "ClusterArn": "string",
      "ClusterName": "string",
      "Description": "string",
      "EventDetails": { 
         "EventMetadata": { ... }
      },
      "EventId": "string",
      "EventTime": number,
      "InstanceGroupName": "string",
      "InstanceId": "string",
      "ResourceType": "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.

EventDetails

Detailed information about the requested cluster event, including event metadata for various resource types such as Cluster, InstanceGroup, Instance, and their associated attributes.

Type: ClusterEventDetail object

Errors

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400