ListMonitoringExecutions - Amazon SageMaker Service

ListMonitoringExecutions

Returns list of all monitoring job executions.

Request Syntax

{ "CreationTimeAfter": number, "CreationTimeBefore": number, "EndpointName": "string", "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "MonitoringScheduleName": "string", "NextToken": "string", "ScheduledTimeAfter": number, "ScheduledTimeBefore": number, "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreationTimeAfter

A filter that returns only jobs created after a specified time.

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only jobs created before a specified time.

Type: Timestamp

Required: No

EndpointName

Name of a specific endpoint to fetch jobs for.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: No

LastModifiedTimeAfter

A filter that returns only jobs modified before a specified time.

Type: Timestamp

Required: No

LastModifiedTimeBefore

A filter that returns only jobs modified after a specified time.

Type: Timestamp

Required: No

MaxResults

The maximum number of jobs to return in the response. The default value is 10.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

MonitoringScheduleName

Name of a specific schedule to fetch jobs for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

ScheduledTimeAfter

Filter for jobs scheduled after a specified time.

Type: Timestamp

Required: No

ScheduledTimeBefore

Filter for jobs scheduled before a specified time.

Type: Timestamp

Required: No

SortBy

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

Type: String

Valid Values: CreationTime | ScheduledTime | Status

Required: No

SortOrder

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

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

A filter that retrieves only jobs with a specific status.

Type: String

Valid Values: Pending | Completed | CompletedWithViolations | InProgress | Failed | Stopping | Stopped

Required: No

Response Syntax

{ "MonitoringExecutionSummaries": [ { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "MonitoringExecutionStatus": "string", "MonitoringScheduleName": "string", "ProcessingJobArn": "string", "ScheduledTime": number } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MonitoringExecutionSummaries

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

Type: Array of MonitoringExecutionSummary objects

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: