aws_sdk_sagemaker/client/
list_contexts.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 [`ListContexts`](crate::operation::list_contexts::builders::ListContextsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`source_uri(impl Into<String>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::source_uri) / [`set_source_uri(Option<String>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::set_source_uri):<br>required: **false**<br><p>A filter that returns only contexts with the specified source URI.</p><br>
8    ///   - [`context_type(impl Into<String>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::context_type) / [`set_context_type(Option<String>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::set_context_type):<br>required: **false**<br><p>A filter that returns only contexts of the specified type.</p><br>
9    ///   - [`created_after(DateTime)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::created_after) / [`set_created_after(Option<DateTime>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::set_created_after):<br>required: **false**<br><p>A filter that returns only contexts created on or after the specified time.</p><br>
10    ///   - [`created_before(DateTime)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::created_before) / [`set_created_before(Option<DateTime>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::set_created_before):<br>required: **false**<br><p>A filter that returns only contexts created on or before the specified time.</p><br>
11    ///   - [`sort_by(SortContextsBy)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::sort_by) / [`set_sort_by(Option<SortContextsBy>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The property used to sort results. The default value is <code>CreationTime</code>.</p><br>
12    ///   - [`sort_order(SortOrder)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order. The default value is <code>Descending</code>.</p><br>
13    ///   - [`next_token(impl Into<String>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the previous call to <code>ListContexts</code> didn't return the full set of contexts, the call returns a token for getting the next set of contexts.</p><br>
14    ///   - [`max_results(i32)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_contexts::builders::ListContextsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of contexts to return in the response. The default value is 10.</p><br>
15    /// - On success, responds with [`ListContextsOutput`](crate::operation::list_contexts::ListContextsOutput) with field(s):
16    ///   - [`context_summaries(Option<Vec::<ContextSummary>>)`](crate::operation::list_contexts::ListContextsOutput::context_summaries): <p>A list of contexts and their properties.</p>
17    ///   - [`next_token(Option<String>)`](crate::operation::list_contexts::ListContextsOutput::next_token): <p>A token for getting the next set of contexts, if there are any.</p>
18    /// - On failure, responds with [`SdkError<ListContextsError>`](crate::operation::list_contexts::ListContextsError)
19    pub fn list_contexts(&self) -> crate::operation::list_contexts::builders::ListContextsFluentBuilder {
20        crate::operation::list_contexts::builders::ListContextsFluentBuilder::new(self.handle.clone())
21    }
22}