aws_sdk_qconnect/client/list_ai_prompt_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 [`ListAIPromptVersions`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`assistant_id(impl Into<String>)`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::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_prompt_id(impl Into<String>)`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::ai_prompt_id) / [`set_ai_prompt_id(Option<String>)`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::set_ai_prompt_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::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_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::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_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::origin) / [`set_origin(Option<Origin>)`](crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::set_origin):<br>required: **false**<br><p>The origin of the AI Prompt 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 [`ListAiPromptVersionsOutput`](crate::operation::list_ai_prompt_versions::ListAiPromptVersionsOutput) with field(s):
13 /// - [`ai_prompt_version_summaries(Vec::<AiPromptVersionSummary>)`](crate::operation::list_ai_prompt_versions::ListAiPromptVersionsOutput::ai_prompt_version_summaries): <p>The summaries of the AI Prompt versions.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::list_ai_prompt_versions::ListAiPromptVersionsOutput::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<ListAIPromptVersionsError>`](crate::operation::list_ai_prompt_versions::ListAIPromptVersionsError)
16 pub fn list_ai_prompt_versions(&self) -> crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder {
17 crate::operation::list_ai_prompt_versions::builders::ListAIPromptVersionsFluentBuilder::new(self.handle.clone())
18 }
19}