aws_sdk_bedrockagent/client/list_prompts.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 [`ListPrompts`](crate::operation::list_prompts::builders::ListPromptsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_prompts::builders::ListPromptsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`prompt_identifier(impl Into<String>)`](crate::operation::list_prompts::builders::ListPromptsFluentBuilder::prompt_identifier) / [`set_prompt_identifier(Option<String>)`](crate::operation::list_prompts::builders::ListPromptsFluentBuilder::set_prompt_identifier):<br>required: **false**<br><p>The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_prompts::builders::ListPromptsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_prompts::builders::ListPromptsFluentBuilder::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>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_prompts::builders::ListPromptsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_prompts::builders::ListPromptsFluentBuilder::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>
10 /// - On success, responds with [`ListPromptsOutput`](crate::operation::list_prompts::ListPromptsOutput) with field(s):
11 /// - [`prompt_summaries(Vec::<PromptSummary>)`](crate::operation::list_prompts::ListPromptsOutput::prompt_summaries): <p>A list, each member of which contains information about a prompt using Prompt management.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_prompts::ListPromptsOutput::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>
13 /// - On failure, responds with [`SdkError<ListPromptsError>`](crate::operation::list_prompts::ListPromptsError)
14 pub fn list_prompts(&self) -> crate::operation::list_prompts::builders::ListPromptsFluentBuilder {
15 crate::operation::list_prompts::builders::ListPromptsFluentBuilder::new(self.handle.clone())
16 }
17}