List Training Plans

sagemaker_list_training_plans

R Documentation

Retrieves a list of training plans for the current account

Description

Retrieves a list of training plans for the current account.

Usage

sagemaker_list_training_plans(NextToken, MaxResults, StartTimeAfter,
  StartTimeBefore, SortBy, SortOrder, Filters)

Arguments

NextToken

A token to continue pagination if more results are available.

MaxResults

The maximum number of results to return in the response.

StartTimeAfter

Filter to list only training plans with an actual start time after this date.

StartTimeBefore

Filter to list only training plans with an actual start time before this date.

SortBy

The training plan field to sort the results by (e.g., StartTime, Status).

SortOrder

The order to sort the results (Ascending or Descending).

Filters

Additional filters to apply to the list of training plans.

Value

A list with the following syntax:

list(
  NextToken = "string",
  TrainingPlanSummaries = list(
    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$list_training_plans(
  NextToken = "string",
  MaxResults = 123,
  StartTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  StartTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  SortBy = "TrainingPlanName"|"StartTime"|"Status",
  SortOrder = "Ascending"|"Descending",
  Filters = list(
    list(
      Name = "Status",
      Value = "string"
    )
  )
)