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

list-monitoring-schedules

Description

Returns list of all monitoring schedules.

See also: AWS API Documentation

list-monitoring-schedules is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: MonitoringScheduleSummaries

Synopsis

  list-monitoring-schedules
[--endpoint-name <value>]
[--sort-by <value>]
[--sort-order <value>]
[--name-contains <value>]
[--creation-time-before <value>]
[--creation-time-after <value>]
[--last-modified-time-before <value>]
[--last-modified-time-after <value>]
[--status-equals <value>]
[--monitoring-job-definition-name <value>]
[--monitoring-type-equals <value>]
[--cli-input-json <value>]
[--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>]

Options

--endpoint-name (string)

Name of a specific endpoint to fetch schedules for.

--sort-by (string)

Whether to sort the results by the Status , CreationTime , or ScheduledTime field. The default is CreationTime .

Possible values:

  • Name
  • CreationTime
  • Status

--sort-order (string)

Whether to sort the results in Ascending or Descending order. The default is Descending .

Possible values:

  • Ascending
  • Descending

--name-contains (string)

Filter for monitoring schedules whose name contains a specified string.

--creation-time-before (timestamp)

A filter that returns only monitoring schedules created before a specified time.

--creation-time-after (timestamp)

A filter that returns only monitoring schedules created after a specified time.

--last-modified-time-before (timestamp)

A filter that returns only monitoring schedules modified before a specified time.

--last-modified-time-after (timestamp)

A filter that returns only monitoring schedules modified after a specified time.

--status-equals (string)

A filter that returns only monitoring schedules modified before a specified time.

Possible values:

  • Pending
  • Failed
  • Scheduled
  • Stopped

--monitoring-job-definition-name (string)

Gets a list of the monitoring schedules for the specified monitoring job definition.

--monitoring-type-equals (string)

A filter that returns only the monitoring schedules for the specified monitoring type.

Possible values:

  • DataQuality
  • ModelQuality
  • ModelBias
  • ModelExplainability

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

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

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

MonitoringScheduleSummaries -> (list)

A JSON array in which each element is a summary for a monitoring schedule.

(structure)

Summarizes the monitoring schedule.

MonitoringScheduleName -> (string)

The name of the monitoring schedule.

MonitoringScheduleArn -> (string)

The Amazon Resource Name (ARN) of the monitoring schedule.

CreationTime -> (timestamp)

The creation time of the monitoring schedule.

LastModifiedTime -> (timestamp)

The last time the monitoring schedule was modified.

MonitoringScheduleStatus -> (string)

The status of the monitoring schedule.

EndpointName -> (string)

The name of the endpoint using the monitoring schedule.

MonitoringJobDefinitionName -> (string)

The name of the monitoring job definition that the schedule is for.

MonitoringType -> (string)

The type of the monitoring job definition that the schedule is for.

NextToken -> (string)

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.