aws_sdk_sagemaker/client/
list_monitoring_executions.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListMonitoringExecutions`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`monitoring_schedule_name(impl Into<String>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::monitoring_schedule_name) / [`set_monitoring_schedule_name(Option<String>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_monitoring_schedule_name):<br>required: **false**<br><p>Name of a specific schedule to fetch jobs for.</p><br>
8    ///   - [`endpoint_name(impl Into<String>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::endpoint_name) / [`set_endpoint_name(Option<String>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_endpoint_name):<br>required: **false**<br><p>Name of a specific endpoint to fetch jobs for.</p><br>
9    ///   - [`sort_by(MonitoringExecutionSortKey)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::sort_by) / [`set_sort_by(Option<MonitoringExecutionSortKey>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_sort_by):<br>required: **false**<br><p>Whether to sort the results by the <code>Status</code>, <code>CreationTime</code>, or <code>ScheduledTime</code> field. The default is <code>CreationTime</code>.</p><br>
10    ///   - [`sort_order(SortOrder)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_sort_order):<br>required: **false**<br><p>Whether to sort the results in <code>Ascending</code> or <code>Descending</code> order. The default is <code>Descending</code>.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.</p><br>
12    ///   - [`max_results(i32)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of jobs to return in the response. The default value is 10.</p><br>
13    ///   - [`scheduled_time_before(DateTime)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::scheduled_time_before) / [`set_scheduled_time_before(Option<DateTime>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_scheduled_time_before):<br>required: **false**<br><p>Filter for jobs scheduled before a specified time.</p><br>
14    ///   - [`scheduled_time_after(DateTime)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::scheduled_time_after) / [`set_scheduled_time_after(Option<DateTime>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_scheduled_time_after):<br>required: **false**<br><p>Filter for jobs scheduled after a specified time.</p><br>
15    ///   - [`creation_time_before(DateTime)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::creation_time_before) / [`set_creation_time_before(Option<DateTime>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_creation_time_before):<br>required: **false**<br><p>A filter that returns only jobs created before a specified time.</p><br>
16    ///   - [`creation_time_after(DateTime)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::creation_time_after) / [`set_creation_time_after(Option<DateTime>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_creation_time_after):<br>required: **false**<br><p>A filter that returns only jobs created after a specified time.</p><br>
17    ///   - [`last_modified_time_before(DateTime)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::last_modified_time_before) / [`set_last_modified_time_before(Option<DateTime>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_last_modified_time_before):<br>required: **false**<br><p>A filter that returns only jobs modified after a specified time.</p><br>
18    ///   - [`last_modified_time_after(DateTime)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::last_modified_time_after) / [`set_last_modified_time_after(Option<DateTime>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_last_modified_time_after):<br>required: **false**<br><p>A filter that returns only jobs modified before a specified time.</p><br>
19    ///   - [`status_equals(ExecutionStatus)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::status_equals) / [`set_status_equals(Option<ExecutionStatus>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_status_equals):<br>required: **false**<br><p>A filter that retrieves only jobs with a specific status.</p><br>
20    ///   - [`monitoring_job_definition_name(impl Into<String>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::monitoring_job_definition_name) / [`set_monitoring_job_definition_name(Option<String>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_monitoring_job_definition_name):<br>required: **false**<br><p>Gets a list of the monitoring job runs of the specified monitoring job definitions.</p><br>
21    ///   - [`monitoring_type_equals(MonitoringType)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::monitoring_type_equals) / [`set_monitoring_type_equals(Option<MonitoringType>)`](crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::set_monitoring_type_equals):<br>required: **false**<br><p>A filter that returns only the monitoring job runs of the specified monitoring type.</p><br>
22    /// - On success, responds with [`ListMonitoringExecutionsOutput`](crate::operation::list_monitoring_executions::ListMonitoringExecutionsOutput) with field(s):
23    ///   - [`monitoring_execution_summaries(Option<Vec::<MonitoringExecutionSummary>>)`](crate::operation::list_monitoring_executions::ListMonitoringExecutionsOutput::monitoring_execution_summaries): <p>A JSON array in which each element is a summary for a monitoring execution.</p>
24    ///   - [`next_token(Option<String>)`](crate::operation::list_monitoring_executions::ListMonitoringExecutionsOutput::next_token): <p>The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.</p>
25    /// - On failure, responds with [`SdkError<ListMonitoringExecutionsError>`](crate::operation::list_monitoring_executions::ListMonitoringExecutionsError)
26    pub fn list_monitoring_executions(&self) -> crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder {
27        crate::operation::list_monitoring_executions::builders::ListMonitoringExecutionsFluentBuilder::new(self.handle.clone())
28    }
29}