[ aws . sagemaker ]

list-monitoring-schedules

Description

Returns list of all monitoring schedules.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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 | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--endpoint-name (string)

Name of a specific endpoint to fetch schedules for.

--sort-by (string)

Whether to sort results by Status , CreationTime , 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 | --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.

See ‘aws help’ for descriptions of global parameters.

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)

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.