ListMonitoringSchedules
Returns list of all monitoring schedules.
Request Syntax
{
"CreationTimeAfter": number,
"CreationTimeBefore": number,
"EndpointName": "string",
"LastModifiedTimeAfter": number,
"LastModifiedTimeBefore": number,
"MaxResults": number,
"MonitoringJobDefinitionName": "string",
"MonitoringTypeEquals": "string",
"NameContains": "string",
"NextToken": "string",
"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 monitoring schedules created after a specified time.
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only monitoring schedules created before a specified time.
Type: Timestamp
Required: No
- EndpointName
-
Name of a specific endpoint to fetch schedules for.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: No
- LastModifiedTimeAfter
-
A filter that returns only monitoring schedules modified after a specified time.
Type: Timestamp
Required: No
- LastModifiedTimeBefore
-
A filter that returns only monitoring schedules modified before 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
- MonitoringJobDefinitionName
-
Gets a list of the monitoring schedules for the specified monitoring job definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: No
- MonitoringTypeEquals
-
A filter that returns only the monitoring schedules for the specified monitoring type.
Type: String
Valid Values:
DataQuality | ModelQuality | ModelBias | ModelExplainabilityRequired: No
- NameContains
-
Filter for monitoring schedules whose name contains a specified string.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
[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
- SortBy
-
Whether to sort the results by the
Status,CreationTime, orScheduledTimefield. The default isCreationTime.Type: String
Valid Values:
Name | CreationTime | StatusRequired: No
- SortOrder
-
Whether to sort the results in
AscendingorDescendingorder. The default isDescending.Type: String
Valid Values:
Ascending | DescendingRequired: No
- StatusEquals
-
A filter that returns only monitoring schedules modified before a specified time.
Type: String
Valid Values:
Pending | Failed | Scheduled | StoppedRequired: No
Response Syntax
{
"MonitoringScheduleSummaries": [
{
"CreationTime": number,
"EndpointName": "string",
"LastModifiedTime": number,
"MonitoringJobDefinitionName": "string",
"MonitoringScheduleArn": "string",
"MonitoringScheduleName": "string",
"MonitoringScheduleStatus": "string",
"MonitoringType": "string"
}
],
"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.
- MonitoringScheduleSummaries
-
A JSON array in which each element is a summary for a monitoring schedule.
Type: Array of MonitoringScheduleSummary objects
- 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:
.*
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:
