aws_sdk_sagemaker/client/
list_endpoints.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 [`ListEndpoints`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`sort_by(EndpointSortKey)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::sort_by) / [`set_sort_by(Option<EndpointSortKey>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_sort_by):<br>required: **false**<br><p>Sorts the list of results. The default is <code>CreationTime</code>.</p><br>
8    ///   - [`sort_order(OrderKey)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::sort_order) / [`set_sort_order(Option<OrderKey>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for results. The default is <code>Descending</code>.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the result of a <code>ListEndpoints</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of endpoints, use the token in the next request.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of endpoints to return in the response. This value defaults to 10.</p><br>
11    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_name_contains):<br>required: **false**<br><p>A string in endpoint names. This filter returns only endpoints whose name contains the specified string.</p><br>
12    ///   - [`creation_time_before(DateTime)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::creation_time_before) / [`set_creation_time_before(Option<DateTime>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_creation_time_before):<br>required: **false**<br><p>A filter that returns only endpoints that were created before the specified time (timestamp).</p><br>
13    ///   - [`creation_time_after(DateTime)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::creation_time_after) / [`set_creation_time_after(Option<DateTime>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_creation_time_after):<br>required: **false**<br><p>A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).</p><br>
14    ///   - [`last_modified_time_before(DateTime)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::last_modified_time_before) / [`set_last_modified_time_before(Option<DateTime>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_last_modified_time_before):<br>required: **false**<br><p>A filter that returns only endpoints that were modified before the specified timestamp.</p><br>
15    ///   - [`last_modified_time_after(DateTime)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::last_modified_time_after) / [`set_last_modified_time_after(Option<DateTime>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_last_modified_time_after):<br>required: **false**<br><p>A filter that returns only endpoints that were modified after the specified timestamp.</p><br>
16    ///   - [`status_equals(EndpointStatus)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::status_equals) / [`set_status_equals(Option<EndpointStatus>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_status_equals):<br>required: **false**<br><p>A filter that returns only endpoints with the specified status.</p><br>
17    /// - On success, responds with [`ListEndpointsOutput`](crate::operation::list_endpoints::ListEndpointsOutput) with field(s):
18    ///   - [`endpoints(Option<Vec::<EndpointSummary>>)`](crate::operation::list_endpoints::ListEndpointsOutput::endpoints): <p>An array or endpoint objects.</p>
19    ///   - [`next_token(Option<String>)`](crate::operation::list_endpoints::ListEndpointsOutput::next_token): <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.</p>
20    /// - On failure, responds with [`SdkError<ListEndpointsError>`](crate::operation::list_endpoints::ListEndpointsError)
21    pub fn list_endpoints(&self) -> crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder {
22        crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::new(self.handle.clone())
23    }
24}