pub struct CreateAIPromptFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateAIPrompt.
Creates an Amazon Q in Connect AI Prompt.
Implementations§
Source§impl CreateAIPromptFluentBuilder
impl CreateAIPromptFluentBuilder
Sourcepub fn as_input(&self) -> &CreateAiPromptInputBuilder
pub fn as_input(&self) -> &CreateAiPromptInputBuilder
Access the CreateAIPrompt as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateAiPromptOutput, SdkError<CreateAIPromptError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateAiPromptOutput, SdkError<CreateAIPromptError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateAiPromptOutput, CreateAIPromptError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateAiPromptOutput, CreateAIPromptError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
Sourcepub fn assistant_id(self, input: impl Into<String>) -> Self
pub fn assistant_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Sourcepub fn set_assistant_id(self, input: Option<String>) -> Self
pub fn set_assistant_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Sourcepub fn get_assistant_id(&self) -> &Option<String>
pub fn get_assistant_id(&self) -> &Option<String>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Sourcepub fn type(self, input: AiPromptType) -> Self
pub fn type(self, input: AiPromptType) -> Self
The type of this AI Prompt.
Sourcepub fn set_type(self, input: Option<AiPromptType>) -> Self
pub fn set_type(self, input: Option<AiPromptType>) -> Self
The type of this AI Prompt.
Sourcepub fn get_type(&self) -> &Option<AiPromptType>
pub fn get_type(&self) -> &Option<AiPromptType>
The type of this AI Prompt.
Sourcepub fn template_configuration(
self,
input: AiPromptTemplateConfiguration,
) -> Self
pub fn template_configuration( self, input: AiPromptTemplateConfiguration, ) -> Self
The configuration of the prompt template for this AI Prompt.
Sourcepub fn set_template_configuration(
self,
input: Option<AiPromptTemplateConfiguration>,
) -> Self
pub fn set_template_configuration( self, input: Option<AiPromptTemplateConfiguration>, ) -> Self
The configuration of the prompt template for this AI Prompt.
Sourcepub fn get_template_configuration(
&self,
) -> &Option<AiPromptTemplateConfiguration>
pub fn get_template_configuration( &self, ) -> &Option<AiPromptTemplateConfiguration>
The configuration of the prompt template for this AI Prompt.
Sourcepub fn visibility_status(self, input: VisibilityStatus) -> Self
pub fn visibility_status(self, input: VisibilityStatus) -> Self
The visibility status of the AI Prompt.
Sourcepub fn set_visibility_status(self, input: Option<VisibilityStatus>) -> Self
pub fn set_visibility_status(self, input: Option<VisibilityStatus>) -> Self
The visibility status of the AI Prompt.
Sourcepub fn get_visibility_status(&self) -> &Option<VisibilityStatus>
pub fn get_visibility_status(&self) -> &Option<VisibilityStatus>
The visibility status of the AI Prompt.
Sourcepub fn template_type(self, input: AiPromptTemplateType) -> Self
pub fn template_type(self, input: AiPromptTemplateType) -> Self
The type of the prompt template for this AI Prompt.
Sourcepub fn set_template_type(self, input: Option<AiPromptTemplateType>) -> Self
pub fn set_template_type(self, input: Option<AiPromptTemplateType>) -> Self
The type of the prompt template for this AI Prompt.
Sourcepub fn get_template_type(&self) -> &Option<AiPromptTemplateType>
pub fn get_template_type(&self) -> &Option<AiPromptTemplateType>
The type of the prompt template for this AI Prompt.
Sourcepub fn model_id(self, input: impl Into<String>) -> Self
pub fn model_id(self, input: impl Into<String>) -> Self
The identifier of the model used for this AI Prompt.
For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.
Sourcepub fn set_model_id(self, input: Option<String>) -> Self
pub fn set_model_id(self, input: Option<String>) -> Self
The identifier of the model used for this AI Prompt.
For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.
Sourcepub fn get_model_id(&self) -> &Option<String>
pub fn get_model_id(&self) -> &Option<String>
The identifier of the model used for this AI Prompt.
For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.
Sourcepub fn api_format(self, input: AiPromptApiFormat) -> Self
pub fn api_format(self, input: AiPromptApiFormat) -> Self
The API Format of the AI Prompt.
Recommended values: MESSAGES | TEXT_COMPLETIONS
The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.
Sourcepub fn set_api_format(self, input: Option<AiPromptApiFormat>) -> Self
pub fn set_api_format(self, input: Option<AiPromptApiFormat>) -> Self
The API Format of the AI Prompt.
Recommended values: MESSAGES | TEXT_COMPLETIONS
The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.
Sourcepub fn get_api_format(&self) -> &Option<AiPromptApiFormat>
pub fn get_api_format(&self) -> &Option<AiPromptApiFormat>
The API Format of the AI Prompt.
Recommended values: MESSAGES | TEXT_COMPLETIONS
The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
The tags used to organize, track, or control access for this resource.
The tags used to organize, track, or control access for this resource.
The tags used to organize, track, or control access for this resource.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the AI Prompt.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the AI Prompt.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the AI Prompt.
Trait Implementations§
Source§impl Clone for CreateAIPromptFluentBuilder
impl Clone for CreateAIPromptFluentBuilder
Source§fn clone(&self) -> CreateAIPromptFluentBuilder
fn clone(&self) -> CreateAIPromptFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateAIPromptFluentBuilder
impl !RefUnwindSafe for CreateAIPromptFluentBuilder
impl Send for CreateAIPromptFluentBuilder
impl Sync for CreateAIPromptFluentBuilder
impl Unpin for CreateAIPromptFluentBuilder
impl !UnwindSafe for CreateAIPromptFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);