Describe Training Plan

sagemaker_describe_training_plan

R Documentation

Retrieves detailed information about a specific training plan

Description

Retrieves detailed information about a specific training plan.

Usage

sagemaker_describe_training_plan(TrainingPlanName)

Arguments

TrainingPlanName

[required] The name of the training plan to describe.

Value

A list with the following syntax:

list(
  TrainingPlanArn = "string",
  TrainingPlanName = "string",
  Status = "Pending"|"Active"|"Scheduled"|"Expired"|"Failed",
  StatusMessage = "string",
  DurationHours = 123,
  DurationMinutes = 123,
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  UpfrontFee = "string",
  CurrencyCode = "string",
  TotalInstanceCount = 123,
  AvailableInstanceCount = 123,
  InUseInstanceCount = 123,
  TargetResources = list(
    "training-job"|"hyperpod-cluster"
  ),
  ReservedCapacitySummaries = list(
    list(
      ReservedCapacityArn = "string",
      InstanceType = "ml.p4d.24xlarge"|"ml.p5.48xlarge"|"ml.p5e.48xlarge"|"ml.p5en.48xlarge"|"ml.trn1.32xlarge"|"ml.trn2.48xlarge",
      TotalInstanceCount = 123,
      Status = "Pending"|"Active"|"Scheduled"|"Expired"|"Failed",
      AvailabilityZone = "string",
      DurationHours = 123,
      DurationMinutes = 123,
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$describe_training_plan(
  TrainingPlanName = "string"
)