aws_sdk_bedrock/client/

list_custom_models.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListCustomModels`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`creation_time_before(DateTime)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::creation_time_before) / [`set_creation_time_before(Option<DateTime>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_creation_time_before):<br>required: **false**<br><p>Return custom models created before the specified time.</p><br>
    ///   - [`creation_time_after(DateTime)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::creation_time_after) / [`set_creation_time_after(Option<DateTime>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_creation_time_after):<br>required: **false**<br><p>Return custom models created after the specified time.</p><br>
    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_name_contains):<br>required: **false**<br><p>Return custom models only if the job name contains these characters.</p><br>
    ///   - [`base_model_arn_equals(impl Into<String>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::base_model_arn_equals) / [`set_base_model_arn_equals(Option<String>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_base_model_arn_equals):<br>required: **false**<br><p>Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.</p><br>
    ///   - [`foundation_model_arn_equals(impl Into<String>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::foundation_model_arn_equals) / [`set_foundation_model_arn_equals(Option<String>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_foundation_model_arn_equals):<br>required: **false**<br><p>Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p><br>
    ///   - [`sort_by(SortModelsBy)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::sort_by) / [`set_sort_by(Option<SortModelsBy>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field to sort by in the returned list of models.</p><br>
    ///   - [`sort_order(SortOrder)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order of the results.</p><br>
    ///   - [`is_owned(bool)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::is_owned) / [`set_is_owned(Option<bool>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_is_owned):<br>required: **false**<br><p>Return custom models depending on if the current account owns them (<code>true</code>) or if they were shared with the current account (<code>false</code>).</p><br>
    ///   - [`model_status(ModelStatus)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::model_status) / [`set_model_status(Option<ModelStatus>)`](crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::set_model_status):<br>required: **false**<br><p>The status of them model to filter results by. Possible values include:</p> <ul>  <li>   <p><code>Creating</code> - Include only models that are currently being created and validated.</p></li>  <li>   <p><code>Active</code> - Include only models that have been successfully created and are ready for use.</p></li>  <li>   <p><code>Failed</code> - Include only models where the creation process failed.</p></li> </ul> <p>If you don't specify a status, the API returns models in all states.</p><br>
    /// - On success, responds with [`ListCustomModelsOutput`](crate::operation::list_custom_models::ListCustomModelsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_custom_models::ListCustomModelsOutput::next_token): <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
    ///   - [`model_summaries(Option<Vec::<CustomModelSummary>>)`](crate::operation::list_custom_models::ListCustomModelsOutput::model_summaries): <p>Model summaries.</p>
    /// - On failure, responds with [`SdkError<ListCustomModelsError>`](crate::operation::list_custom_models::ListCustomModelsError)
    pub fn list_custom_models(&self) -> crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder {
        crate::operation::list_custom_models::builders::ListCustomModelsFluentBuilder::new(self.handle.clone())
    }
}