aws_sdk_qconnect/client/
list_ai_prompts.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListAIPrompts`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`assistant_id(impl Into<String>)`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::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>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::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>
    ///   - [`max_results(i32)`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
    ///   - [`origin(Origin)`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::origin) / [`set_origin(Option<Origin>)`](crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::set_origin):<br>required: **false**<br><p>The origin of the AI Prompts 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>
    /// - On success, responds with [`ListAiPromptsOutput`](crate::operation::list_ai_prompts::ListAiPromptsOutput) with field(s):
    ///   - [`ai_prompt_summaries(Vec::<AiPromptSummary>)`](crate::operation::list_ai_prompts::ListAiPromptsOutput::ai_prompt_summaries): <p>The summaries of the AI Prompts.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_ai_prompts::ListAiPromptsOutput::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>
    /// - On failure, responds with [`SdkError<ListAIPromptsError>`](crate::operation::list_ai_prompts::ListAIPromptsError)
    pub fn list_ai_prompts(&self) -> crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder {
        crate::operation::list_ai_prompts::builders::ListAIPromptsFluentBuilder::new(self.handle.clone())
    }
}