aws_sdk_transcribe/client/

list_language_models.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListLanguageModels`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`status_equals(ModelStatus)`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::status_equals) / [`set_status_equals(Option<ModelStatus>)`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::set_status_equals):<br>required: **false**<br><p>Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you do not include <code>StatusEquals</code>, all custom language models are returned.</p><br>
    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::set_name_contains):<br>required: **false**<br><p>Returns only the custom language models that contain the specified string. The search is not case sensitive.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::set_next_token):<br>required: **false**<br><p>If your <code>ListLanguageModels</code> request returns more results than can be displayed, <code>NextToken</code> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <code>NextToken</code> with the value of the copied string. Repeat as needed to view all your results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.</p><br>
    /// - On success, responds with [`ListLanguageModelsOutput`](crate::operation::list_language_models::ListLanguageModelsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_language_models::ListLanguageModelsOutput::next_token): <p>If <code>NextToken</code> is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the <code>NextToken</code> parameter in your results output, then run your request again including <code>NextToken</code> with the value of the copied string. Repeat as needed to view all your results.</p>
    ///   - [`models(Option<Vec::<LanguageModel>>)`](crate::operation::list_language_models::ListLanguageModelsOutput::models): <p>Provides information about the custom language models that match the criteria specified in your request.</p>
    /// - On failure, responds with [`SdkError<ListLanguageModelsError>`](crate::operation::list_language_models::ListLanguageModelsError)
    pub fn list_language_models(&self) -> crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder {
        crate::operation::list_language_models::builders::ListLanguageModelsFluentBuilder::new(self.handle.clone())
    }
}