AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lookoutequipment ]

list-retraining-schedulers

Description

Lists all retraining schedulers in your account, filtering by model name prefix and status.

See also: AWS API Documentation

Synopsis

  list-retraining-schedulers
[--model-name-begins-with <value>]
[--status <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <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>]

Options

--model-name-begins-with (string)

Specify this field to only list retraining schedulers whose machine learning models begin with the value you specify.

--status (string)

Specify this field to only list retraining schedulers whose status matches the value you specify.

Possible values:

  • PENDING
  • RUNNING
  • STOPPING
  • STOPPED

--next-token (string)

If the number of results exceeds the maximum, a pagination token is returned. Use the token in the request to show the next page of retraining schedulers.

--max-results (integer)

Specifies the maximum number of retraining schedulers to list.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Output

RetrainingSchedulerSummaries -> (list)

Provides information on the specified retraining scheduler, including the model name, model ARN, status, and start date.

(structure)

Provides information about the specified retraining scheduler, including model name, status, start date, frequency, and lookback window.

ModelName -> (string)

The name of the model that the retraining scheduler is attached to.

ModelArn -> (string)

The ARN of the model that the retraining scheduler is attached to.

Status -> (string)

The status of the retraining scheduler.

RetrainingStartDate -> (timestamp)

The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.

RetrainingFrequency -> (string)

The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.

LookbackWindow -> (string)

The number of past days of data used for retraining.

NextToken -> (string)

If the number of results exceeds the maximum, this pagination token is returned. Use this token in the request to show the next page of retraining schedulers.