Describe Cluster Event

sagemaker_describe_cluster_event

R Documentation

Retrieves detailed information about a specific event for a given HyperPod cluster¶

Description¶

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

Usage¶

sagemaker_describe_cluster_event(EventId, ClusterName)

Arguments¶

EventId

[required] The unique identifier (UUID) of the event to describe. This ID can be obtained from the list_cluster_events operation.

ClusterName

[required] The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

Value¶

A list with the following syntax:

list(
  EventDetails = list(
    EventId = "string",
    ClusterArn = "string",
    ClusterName = "string",
    InstanceGroupName = "string",
    InstanceId = "string",
    ResourceType = "Cluster"|"InstanceGroup"|"Instance",
    EventTime = as.POSIXct(
      "2015-01-01"
    ),
    EventDetails = list(
      EventMetadata = list(
        Cluster = list(
          FailureMessage = "string",
          EksRoleAccessEntries = list(
            "string"
          ),
          SlrAccessEntry = "string"
        ),
        InstanceGroup = list(
          FailureMessage = "string",
          AvailabilityZoneId = "string",
          CapacityReservation = list(
            Arn = "string",
            Type = "ODCR"|"CRG"
          ),
          SubnetId = "string",
          SecurityGroupIds = list(
            "string"
          ),
          AmiOverride = "string"
        ),
        InstanceGroupScaling = list(
          InstanceCount = 123,
          TargetCount = 123,
          MinCount = 123,
          FailureMessage = "string"
        ),
        Instance = list(
          CustomerEni = "string",
          AdditionalEnis = list(
            EfaEnis = list(
              "string"
            )
          ),
          InstanceRequirementsEniConfigurations = list(
            list(
              CustomerEni = "string",
              AdditionalEnis = list(
                EfaEnis = list(
                  "string"
                )
              )
            )
          ),
          CapacityReservation = list(
            Arn = "string",
            Type = "ODCR"|"CRG"
          ),
          FailureMessage = "string",
          LcsExecutionState = "string",
          NodeLogicalId = "string"
        )
      )
    ),
    Description = "string",
    EventLevel = "Info"|"Warn"|"Error"
  )
)

Request syntax¶

svc$describe_cluster_event(
  EventId = "string",
  ClusterName = "string"
)