aws_sdk_qconnect/client/
list_ai_agent_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 [`ListAIAgentVersions`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`assistant_id(impl Into<String>)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::set_assistant_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p><br>
8    ///   - [`ai_agent_id(impl Into<String>)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::ai_agent_id) / [`set_ai_agent_id(Option<String>)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::set_ai_agent_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
11    ///   - [`origin(Origin)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::origin) / [`set_origin(Option<Origin>)`](crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::set_origin):<br>required: **false**<br><p>The origin of the AI Agent versions to be listed. <code>SYSTEM</code> for a default AI Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation APIs.</p><br>
12    /// - On success, responds with [`ListAiAgentVersionsOutput`](crate::operation::list_ai_agent_versions::ListAiAgentVersionsOutput) with field(s):
13    ///   - [`ai_agent_version_summaries(Vec::<AiAgentVersionSummary>)`](crate::operation::list_ai_agent_versions::ListAiAgentVersionsOutput::ai_agent_version_summaries): <p>The summaries of AI Agent versions.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_ai_agent_versions::ListAiAgentVersionsOutput::next_token): <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
15    /// - On failure, responds with [`SdkError<ListAIAgentVersionsError>`](crate::operation::list_ai_agent_versions::ListAIAgentVersionsError)
16    pub fn list_ai_agent_versions(&self) -> crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder {
17        crate::operation::list_ai_agent_versions::builders::ListAIAgentVersionsFluentBuilder::new(self.handle.clone())
18    }
19}