list-training-plans¶

Description¶

Retrieves a list of training plans for the current account.

Synopsis¶

  list-training-plans
[--start-time-after <value>]
[--start-time-before <value>]
[--sort-by <value>]
[--sort-order <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--start-time-after (timestamp)

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

--start-time-before (timestamp)

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

--sort-by (string)

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

Possible values:

TrainingPlanName

StartTime

Status

--sort-order (string)

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

Possible values:

Ascending

Descending

--filters (list)

Additional filters to apply to the list of training plans.

(structure)

A filter to apply when listing or searching for training plans.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see `` CreateTrainingPlan `` .

Name -> (string)

The name of the filter field (e.g., Status, InstanceType).

Value -> (string)

The value to filter by for the specified field.

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

[
  {
    "Name": "Status",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

NextToken -> (string)

A token to continue pagination if more results are available.

TrainingPlanSummaries -> (list)

A list of summary information for the training plans.

(structure)

Details of the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see `` CreateTrainingPlan `` .

TrainingPlanArn -> (string)

The Amazon Resource Name (ARN); of the training plan.

TrainingPlanName -> (string)

The name of the training plan.

Status -> (string)

The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the `` TrainingPlanSummary `` object.

StatusMessage -> (string)

A message providing additional information about the current status of the training plan.

DurationHours -> (long)

The number of whole hours in the total duration for this training plan.

DurationMinutes -> (long)

The additional minutes beyond whole hours in the total duration for this training plan.

StartTime -> (timestamp)

The start time of the training plan.

EndTime -> (timestamp)

The end time of the training plan.

UpfrontFee -> (string)

The upfront fee for the training plan.

CurrencyCode -> (string)

The currency code for the upfront fee (e.g., USD).

TotalInstanceCount -> (integer)

The total number of instances reserved in this training plan.

AvailableInstanceCount -> (integer)

The number of instances currently available for use in this training plan.

InUseInstanceCount -> (integer)

The number of instances currently in use from this training plan.

TargetResources -> (list)

The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.

Training plans are specific to their target resource.

A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster’s instance group.

(string)

ReservedCapacitySummaries -> (list)

A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.

(structure)

Details of a reserved capacity for the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see `` CreateTrainingPlan `` .

ReservedCapacityArn -> (string)

The Amazon Resource Name (ARN); of the reserved capacity.

InstanceType -> (string)

The instance type for the reserved capacity.

TotalInstanceCount -> (integer)

The total number of instances in the reserved capacity.

Status -> (string)

The current status of the reserved capacity.

AvailabilityZone -> (string)

The availability zone for the reserved capacity.

DurationHours -> (long)

The number of whole hours in the total duration for this reserved capacity.

DurationMinutes -> (long)

The additional minutes beyond whole hours in the total duration for this reserved capacity.

StartTime -> (timestamp)

The start time of the reserved capacity.

EndTime -> (timestamp)

The end time of the reserved capacity.

Table of Contents

Feedback

User Guide