aws_sdk_sagemaker/client/
list_model_packages.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 [`ListModelPackages`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`creation_time_after(DateTime)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::creation_time_after) / [`set_creation_time_after(Option<DateTime>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_creation_time_after):<br>required: **false**<br><p>A filter that returns only model packages created after the specified time (timestamp).</p><br>
8    ///   - [`creation_time_before(DateTime)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::creation_time_before) / [`set_creation_time_before(Option<DateTime>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_creation_time_before):<br>required: **false**<br><p>A filter that returns only model packages created before the specified time (timestamp).</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of model packages to return in the response.</p><br>
10    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_name_contains):<br>required: **false**<br><p>A string in the model package name. This filter returns only model packages whose name contains the specified string.</p><br>
11    ///   - [`model_approval_status(ModelApprovalStatus)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::model_approval_status) / [`set_model_approval_status(Option<ModelApprovalStatus>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_model_approval_status):<br>required: **false**<br><p>A filter that returns only the model packages with the specified approval status.</p><br>
12    ///   - [`model_package_group_name(impl Into<String>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::model_package_group_name) / [`set_model_package_group_name(Option<String>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_model_package_group_name):<br>required: **false**<br><p>A filter that returns only model versions that belong to the specified model group.</p><br>
13    ///   - [`model_package_type(ModelPackageType)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::model_package_type) / [`set_model_package_type(Option<ModelPackageType>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_model_package_type):<br>required: **false**<br><p>A filter that returns only the model packages of the specified type. This can be one of the following values.</p> <ul>  <li>   <p><code>UNVERSIONED</code> - List only unversioined models. This is the default value if no <code>ModelPackageType</code> is specified.</p></li>  <li>   <p><code>VERSIONED</code> - List only versioned models.</p></li>  <li>   <p><code>BOTH</code> - List both versioned and unversioned models.</p></li> </ul><br>
14    ///   - [`next_token(impl Into<String>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_next_token):<br>required: **false**<br><p>If the response to a previous <code>ListModelPackages</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of model packages, use the token in the next request.</p><br>
15    ///   - [`sort_by(ModelPackageSortBy)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::sort_by) / [`set_sort_by(Option<ModelPackageSortBy>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_sort_by):<br>required: **false**<br><p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p><br>
16    ///   - [`sort_order(SortOrder)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for the results. The default is <code>Ascending</code>.</p><br>
17    /// - On success, responds with [`ListModelPackagesOutput`](crate::operation::list_model_packages::ListModelPackagesOutput) with field(s):
18    ///   - [`model_package_summary_list(Option<Vec::<ModelPackageSummary>>)`](crate::operation::list_model_packages::ListModelPackagesOutput::model_package_summary_list): <p>An array of <code>ModelPackageSummary</code> objects, each of which lists a model package.</p>
19    ///   - [`next_token(Option<String>)`](crate::operation::list_model_packages::ListModelPackagesOutput::next_token): <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.</p>
20    /// - On failure, responds with [`SdkError<ListModelPackagesError>`](crate::operation::list_model_packages::ListModelPackagesError)
21    pub fn list_model_packages(&self) -> crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder {
22        crate::operation::list_model_packages::builders::ListModelPackagesFluentBuilder::new(self.handle.clone())
23    }
24}