aws_sdk_cleanroomsml/client/list_trained_model_versions.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 [`ListTrainedModelVersions`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token from a previous <code>ListTrainedModelVersions</code> request. Use this token to retrieve the next page of results.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of trained model versions to return in a single page. The default value is 10, and the maximum value is 100.</p><br>
9 /// - [`membership_identifier(impl Into<String>)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::membership_identifier) / [`set_membership_identifier(Option<String>)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::set_membership_identifier):<br>required: **true**<br><p>The membership identifier for the collaboration that contains the trained model.</p><br>
10 /// - [`trained_model_arn(impl Into<String>)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::trained_model_arn) / [`set_trained_model_arn(Option<String>)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::set_trained_model_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the trained model for which to list versions.</p><br>
11 /// - [`status(TrainedModelStatus)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::status) / [`set_status(Option<TrainedModelStatus>)`](crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::set_status):<br>required: **false**<br><p>Filter the results to only include trained model versions with the specified status. Valid values include <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>ACTIVE</code>, <code>CREATE_FAILED</code>, and others.</p><br>
12 /// - On success, responds with [`ListTrainedModelVersionsOutput`](crate::operation::list_trained_model_versions::ListTrainedModelVersionsOutput) with field(s):
13 /// - [`next_token(Option<String>)`](crate::operation::list_trained_model_versions::ListTrainedModelVersionsOutput::next_token): <p>The pagination token to use in a subsequent <code>ListTrainedModelVersions</code> request to retrieve the next page of results. This value is null when there are no more results to return.</p>
14 /// - [`trained_models(Vec::<TrainedModelSummary>)`](crate::operation::list_trained_model_versions::ListTrainedModelVersionsOutput::trained_models): <p>A list of trained model versions that match the specified criteria. Each entry contains summary information about a trained model version, including its version identifier, status, and creation details.</p>
15 /// - On failure, responds with [`SdkError<ListTrainedModelVersionsError>`](crate::operation::list_trained_model_versions::ListTrainedModelVersionsError)
16 pub fn list_trained_model_versions(&self) -> crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder {
17 crate::operation::list_trained_model_versions::builders::ListTrainedModelVersionsFluentBuilder::new(self.handle.clone())
18 }
19}