Struct aws_sdk_qbusiness::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for QBusiness
Client for invoking operations on QBusiness. Each operation on QBusiness is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_qbusiness::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_qbusiness::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the BatchDeleteDocument
operation has
a Client::batch_delete_document
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.batch_delete_document()
.application_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn batch_delete_document(&self) -> BatchDeleteDocumentFluentBuilder
pub fn batch_delete_document(&self) -> BatchDeleteDocumentFluentBuilder
Constructs a fluent builder for the BatchDeleteDocument
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business index that contains the documents to delete.
documents(DeleteDocument)
/set_documents(Option<Vec::<DeleteDocument>>)
:
required: trueDocuments deleted from the Amazon Q Business index.
data_source_sync_id(impl Into<String>)
/set_data_source_sync_id(Option<String>)
:
required: falseThe identifier of the data source sync during which the documents were deleted.
- On success, responds with
BatchDeleteDocumentOutput
with field(s):failed_documents(Option<Vec::<FailedDocument>>)
:A list of documents that couldn’t be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn’t be removed from the index.
- On failure, responds with
SdkError<BatchDeleteDocumentError>
source§impl Client
impl Client
sourcepub fn batch_put_document(&self) -> BatchPutDocumentFluentBuilder
pub fn batch_put_document(&self) -> BatchPutDocumentFluentBuilder
Constructs a fluent builder for the BatchPutDocument
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business index to add the documents to.
documents(Document)
/set_documents(Option<Vec::<Document>>)
:
required: trueOne or more documents to add to the index.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
data_source_sync_id(impl Into<String>)
/set_data_source_sync_id(Option<String>)
:
required: falseThe identifier of the data source sync during which the documents were added.
- On success, responds with
BatchPutDocumentOutput
with field(s):failed_documents(Option<Vec::<FailedDocument>>)
:A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn’t be added to the index.
- On failure, responds with
SdkError<BatchPutDocumentError>
source§impl Client
impl Client
sourcepub fn chat(&self) -> ChatFluentBuilder
pub fn chat(&self) -> ChatFluentBuilder
Constructs a fluent builder for the Chat
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: falseThe identifier of the user attached to the chat input.
user_groups(impl Into<String>)
/set_user_groups(Option<Vec::<String>>)
:
required: falseThe groups that a user associated with the chat input belongs to.
conversation_id(impl Into<String>)
/set_conversation_id(Option<String>)
:
required: falseThe identifier of the Amazon Q Business conversation.
parent_message_id(impl Into<String>)
/set_parent_message_id(Option<String>)
:
required: falseThe identifier used to associate a user message with a AI generated response.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that you provide to identify the chat input.
input_stream(EventStreamSender<ChatInputStream, ChatInputStreamError>)
/set_input_stream(EventStreamSender<ChatInputStream, ChatInputStreamError>)
:
required: falseThe streaming input for the
Chat
API.
- On success, responds with
ChatOutput
with field(s):output_stream(EventReceiver<ChatOutputStream, ChatOutputStreamError>)
:The streaming output for the
Chat
API.
- On failure, responds with
SdkError<ChatError>
source§impl Client
impl Client
sourcepub fn chat_sync(&self) -> ChatSyncFluentBuilder
pub fn chat_sync(&self) -> ChatSyncFluentBuilder
Constructs a fluent builder for the ChatSync
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: falseThe identifier of the user attached to the chat input.
user_groups(impl Into<String>)
/set_user_groups(Option<Vec::<String>>)
:
required: falseThe groups that a user associated with the chat input belongs to.
user_message(impl Into<String>)
/set_user_message(Option<String>)
:
required: falseA end user message in a conversation.
attachments(AttachmentInput)
/set_attachments(Option<Vec::<AttachmentInput>>)
:
required: falseA list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
action_execution(ActionExecution)
/set_action_execution(Option<ActionExecution>)
:
required: falseA request from an end user to perform an Amazon Q Business plugin action.
auth_challenge_response(AuthChallengeResponse)
/set_auth_challenge_response(Option<AuthChallengeResponse>)
:
required: falseAn authentication verification event response by a third party authentication server to Amazon Q Business.
conversation_id(impl Into<String>)
/set_conversation_id(Option<String>)
:
required: falseThe identifier of the Amazon Q Business conversation.
parent_message_id(impl Into<String>)
/set_parent_message_id(Option<String>)
:
required: falseThe identifier of the previous end user text input message in a conversation.
attribute_filter(AttributeFilter)
/set_attribute_filter(Option<AttributeFilter>)
:
required: falseEnables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
chat_mode(ChatMode)
/set_chat_mode(Option<ChatMode>)
:
required: falseThe chat modes available to an Amazon Q Business end user.
-
RETRIEVAL_MODE
- The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application. -
CREATOR_MODE
- By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request. -
PLUGIN_MODE
- By selecting this mode, users can choose to use plugins in chat.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
-
chat_mode_configuration(ChatModeConfiguration)
/set_chat_mode_configuration(Option<ChatModeConfiguration>)
:
required: falseThe chat mode configuration for an Amazon Q Business application.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that you provide to identify a chat request.
- On success, responds with
ChatSyncOutput
with field(s):conversation_id(Option<String>)
:The identifier of the Amazon Q Business conversation.
system_message(Option<String>)
:An AI-generated message in a conversation.
system_message_id(Option<String>)
:The identifier of an Amazon Q Business AI generated message within the conversation.
user_message_id(Option<String>)
:The identifier of an Amazon Q Business end user text input message within the conversation.
action_review(Option<ActionReview>)
:A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
auth_challenge_request(Option<AuthChallengeRequest>)
:An authentication verification event activated by an end user request to use a custom plugin.
source_attributions(Option<Vec::<Option<SourceAttribution>>>)
:The source documents used to generate the conversation response.
failed_attachments(Option<Vec::<AttachmentOutput>>)
:A list of files which failed to upload during chat.
- On failure, responds with
SdkError<ChatSyncError>
source§impl Client
impl Client
sourcepub fn create_application(&self) -> CreateApplicationFluentBuilder
pub fn create_application(&self) -> CreateApplicationFluentBuilder
Constructs a fluent builder for the CreateApplication
operation.
- The fluent builder is configurable:
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: trueA name for the Amazon Q Business application.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
identity_center_instance_arn(impl Into<String>)
/set_identity_center_instance_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the Amazon Q Business application.
encryption_configuration(EncryptionConfiguration)
/set_encryption_configuration(Option<EncryptionConfiguration>)
:
required: falseThe identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn’t support asymmetric keys.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that you provide to identify the request to create your Amazon Q Business application.
attachments_configuration(AttachmentsConfiguration)
/set_attachments_configuration(Option<AttachmentsConfiguration>)
:
required: falseAn option to allow end users to upload files directly during chat.
- On success, responds with
CreateApplicationOutput
with field(s):application_id(Option<String>)
:The identifier of the Amazon Q Business application.
application_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Amazon Q Business application.
- On failure, responds with
SdkError<CreateApplicationError>
source§impl Client
impl Client
sourcepub fn create_data_source(&self) -> CreateDataSourceFluentBuilder
pub fn create_data_source(&self) -> CreateDataSourceFluentBuilder
Constructs a fluent builder for the CreateDataSource
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application the data source will be attached to.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index that you want to use with the data source connector.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: trueA name for the data source connector.
configuration(Document)
/set_configuration(Option<Document>)
:
required: trueConfiguration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
vpc_configuration(DataSourceVpcConfiguration)
/set_vpc_configuration(Option<DataSourceVpcConfiguration>)
:
required: falseConfiguration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the data source connector.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
sync_schedule(impl Into<String>)
/set_sync_schedule(Option<String>)
:
required: falseSets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don’t set a schedule, Amazon Q Business won’t periodically update the index.
Specify a
cron-
format schedule string or an empty string to indicate that the index is updated on demand. You can’t specify theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token you provide to identify a request to create a data source connector. Multiple calls to the
CreateDataSource
API with the same client token will create only one data source connector.document_enrichment_configuration(DocumentEnrichmentConfiguration)
/set_document_enrichment_configuration(Option<DocumentEnrichmentConfiguration>)
:
required: falseProvides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
- On success, responds with
CreateDataSourceOutput
with field(s):data_source_id(Option<String>)
:The identifier of the data source connector.
data_source_arn(Option<String>)
:The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
- On failure, responds with
SdkError<CreateDataSourceError>
source§impl Client
impl Client
sourcepub fn create_index(&self) -> CreateIndexFluentBuilder
pub fn create_index(&self) -> CreateIndexFluentBuilder
Constructs a fluent builder for the CreateIndex
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application using the index.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: trueA name for the Amazon Q Business index.
r#type(IndexType)
/set_type(Option<IndexType>)
:
required: falseThe index type that’s suitable for your needs. For more information on what’s included in each type of index or index tier, see Amazon Q Business tiers.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the Amazon Q Business index.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
capacity_configuration(IndexCapacityConfiguration)
/set_capacity_configuration(Option<IndexCapacityConfiguration>)
:
required: falseThe capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that you provide to identify the request to create an index. Multiple calls to the
CreateIndex
API with the same client token will create only one index.
- On success, responds with
CreateIndexOutput
with field(s):index_id(Option<String>)
:The identifier for the Amazon Q Business index.
index_arn(Option<String>)
:The Amazon Resource Name (ARN) of an Amazon Q Business index.
- On failure, responds with
SdkError<CreateIndexError>
source§impl Client
impl Client
sourcepub fn create_plugin(&self) -> CreatePluginFluentBuilder
pub fn create_plugin(&self) -> CreatePluginFluentBuilder
Constructs a fluent builder for the CreatePlugin
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application that will contain the plugin.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: trueA the name for your plugin.
r#type(PluginType)
/set_type(Option<PluginType>)
:
required: trueThe type of plugin you want to create.
auth_configuration(PluginAuthConfiguration)
/set_auth_configuration(Option<PluginAuthConfiguration>)
:
required: trueAuthentication configuration information for an Amazon Q Business plugin.
server_url(impl Into<String>)
/set_server_url(Option<String>)
:
required: falseThe source URL used for plugin configuration.
custom_plugin_configuration(CustomPluginConfiguration)
/set_custom_plugin_configuration(Option<CustomPluginConfiguration>)
:
required: falseContains configuration for a custom plugin.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that you provide to identify the request to create your Amazon Q Business plugin.
- On success, responds with
CreatePluginOutput
with field(s):plugin_id(Option<String>)
:The identifier of the plugin created.
plugin_arn(Option<String>)
:The Amazon Resource Name (ARN) of a plugin.
build_status(Option<PluginBuildStatus>)
:The current status of a plugin. A plugin is modified asynchronously.
- On failure, responds with
SdkError<CreatePluginError>
source§impl Client
impl Client
sourcepub fn create_retriever(&self) -> CreateRetrieverFluentBuilder
pub fn create_retriever(&self) -> CreateRetrieverFluentBuilder
Constructs a fluent builder for the CreateRetriever
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of your Amazon Q Business application.
r#type(RetrieverType)
/set_type(Option<RetrieverType>)
:
required: trueThe type of retriever you are using.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: trueThe name of your retriever.
configuration(RetrieverConfiguration)
/set_configuration(Option<RetrieverConfiguration>)
:
required: trueProvides information on how the retriever used for your Amazon Q Business application is configured.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that you provide to identify the request to create your Amazon Q Business application retriever.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
- On success, responds with
CreateRetrieverOutput
with field(s):retriever_id(Option<String>)
:The identifier of the retriever you are using.
retriever_arn(Option<String>)
:The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
- On failure, responds with
SdkError<CreateRetrieverError>
source§impl Client
impl Client
sourcepub fn create_user(&self) -> CreateUserFluentBuilder
pub fn create_user(&self) -> CreateUserFluentBuilder
Constructs a fluent builder for the CreateUser
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application for which the user mapping will be created.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe user emails attached to a user mapping.
user_aliases(UserAlias)
/set_user_aliases(Option<Vec::<UserAlias>>)
:
required: falseThe list of user aliases in the mapping.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that you provide to identify the request to create your Amazon Q Business user mapping.
- On success, responds with
CreateUserOutput
- On failure, responds with
SdkError<CreateUserError>
source§impl Client
impl Client
sourcepub fn create_web_experience(&self) -> CreateWebExperienceFluentBuilder
pub fn create_web_experience(&self) -> CreateWebExperienceFluentBuilder
Constructs a fluent builder for the CreateWebExperience
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business web experience.
title(impl Into<String>)
/set_title(Option<String>)
:
required: falseThe title for your Amazon Q Business web experience.
subtitle(impl Into<String>)
/set_subtitle(Option<String>)
:
required: falseA subtitle to personalize your Amazon Q Business web experience.
welcome_message(impl Into<String>)
/set_welcome_message(Option<String>)
:
required: falseThe customized welcome message for end users of an Amazon Q Business web experience.
sample_prompts_control_mode(WebExperienceSamplePromptsControlMode)
/set_sample_prompts_control_mode(Option<WebExperienceSamplePromptsControlMode>)
:
required: falseDetermines whether sample prompts are enabled in the web experience for an end user.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the service role attached to your web experience.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token you provide to identify a request to create an Amazon Q Business web experience.
- On success, responds with
CreateWebExperienceOutput
with field(s):web_experience_id(Option<String>)
:The identifier of the Amazon Q Business web experience.
web_experience_arn(Option<String>)
:The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
- On failure, responds with
SdkError<CreateWebExperienceError>
source§impl Client
impl Client
sourcepub fn delete_application(&self) -> DeleteApplicationFluentBuilder
pub fn delete_application(&self) -> DeleteApplicationFluentBuilder
Constructs a fluent builder for the DeleteApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application.
- On success, responds with
DeleteApplicationOutput
- On failure, responds with
SdkError<DeleteApplicationError>
source§impl Client
impl Client
sourcepub fn delete_chat_controls_configuration(
&self
) -> DeleteChatControlsConfigurationFluentBuilder
pub fn delete_chat_controls_configuration( &self ) -> DeleteChatControlsConfigurationFluentBuilder
Constructs a fluent builder for the DeleteChatControlsConfiguration
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application the chat controls have been configured for.
- On success, responds with
DeleteChatControlsConfigurationOutput
- On failure, responds with
SdkError<DeleteChatControlsConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_conversation(&self) -> DeleteConversationFluentBuilder
pub fn delete_conversation(&self) -> DeleteConversationFluentBuilder
Constructs a fluent builder for the DeleteConversation
operation.
- The fluent builder is configurable:
conversation_id(impl Into<String>)
/set_conversation_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business web experience conversation being deleted.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application associated with the conversation.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: falseThe identifier of the user who is deleting the conversation.
- On success, responds with
DeleteConversationOutput
- On failure, responds with
SdkError<DeleteConversationError>
source§impl Client
impl Client
sourcepub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder
pub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder
Constructs a fluent builder for the DeleteDataSource
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application used with the data source connector.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index used with the data source connector.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe identifier of the data source connector that you want to delete.
- On success, responds with
DeleteDataSourceOutput
- On failure, responds with
SdkError<DeleteDataSourceError>
source§impl Client
impl Client
sourcepub fn delete_group(&self) -> DeleteGroupFluentBuilder
pub fn delete_group(&self) -> DeleteGroupFluentBuilder
Constructs a fluent builder for the DeleteGroup
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application in which the group mapping belongs.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index you want to delete the group from.
group_name(impl Into<String>)
/set_group_name(Option<String>)
:
required: trueThe name of the group you want to delete.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: falseThe identifier of the data source linked to the group
A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups “Research”, “Engineering”, and “Sales and Marketing” are all tied to the company’s documents stored in the data sources Confluence and Salesforce. You want to delete “Research” and “Engineering” groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only “Sales and Marketing” should access documents in the Salesforce data source.
- On success, responds with
DeleteGroupOutput
- On failure, responds with
SdkError<DeleteGroupError>
source§impl Client
impl Client
sourcepub fn delete_index(&self) -> DeleteIndexFluentBuilder
pub fn delete_index(&self) -> DeleteIndexFluentBuilder
Constructs a fluent builder for the DeleteIndex
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application the Amazon Q Business index is linked to.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business index.
- On success, responds with
DeleteIndexOutput
- On failure, responds with
SdkError<DeleteIndexError>
source§impl Client
impl Client
sourcepub fn delete_plugin(&self) -> DeletePluginFluentBuilder
pub fn delete_plugin(&self) -> DeletePluginFluentBuilder
Constructs a fluent builder for the DeletePlugin
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier the application attached to the Amazon Q Business plugin.
plugin_id(impl Into<String>)
/set_plugin_id(Option<String>)
:
required: trueThe identifier of the plugin being deleted.
- On success, responds with
DeletePluginOutput
- On failure, responds with
SdkError<DeletePluginError>
source§impl Client
impl Client
sourcepub fn delete_retriever(&self) -> DeleteRetrieverFluentBuilder
pub fn delete_retriever(&self) -> DeleteRetrieverFluentBuilder
Constructs a fluent builder for the DeleteRetriever
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application using the retriever.
retriever_id(impl Into<String>)
/set_retriever_id(Option<String>)
:
required: trueThe identifier of the retriever being deleted.
- On success, responds with
DeleteRetrieverOutput
- On failure, responds with
SdkError<DeleteRetrieverError>
source§impl Client
impl Client
sourcepub fn delete_user(&self) -> DeleteUserFluentBuilder
pub fn delete_user(&self) -> DeleteUserFluentBuilder
Constructs a fluent builder for the DeleteUser
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application from which the user is being deleted.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe user email being deleted.
- On success, responds with
DeleteUserOutput
- On failure, responds with
SdkError<DeleteUserError>
source§impl Client
impl Client
sourcepub fn delete_web_experience(&self) -> DeleteWebExperienceFluentBuilder
pub fn delete_web_experience(&self) -> DeleteWebExperienceFluentBuilder
Constructs a fluent builder for the DeleteWebExperience
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.
web_experience_id(impl Into<String>)
/set_web_experience_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business web experience being deleted.
- On success, responds with
DeleteWebExperienceOutput
- On failure, responds with
SdkError<DeleteWebExperienceError>
source§impl Client
impl Client
sourcepub fn get_application(&self) -> GetApplicationFluentBuilder
pub fn get_application(&self) -> GetApplicationFluentBuilder
Constructs a fluent builder for the GetApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application.
- On success, responds with
GetApplicationOutput
with field(s):display_name(Option<String>)
:The name of the Amazon Q Business application.
application_id(Option<String>)
:The identifier of the Amazon Q Business application.
application_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Amazon Q Business application.
identity_center_application_arn(Option<String>)
:The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
status(Option<ApplicationStatus>)
:The status of the Amazon Q Business application.
description(Option<String>)
:A description for the Amazon Q Business application.
encryption_configuration(Option<EncryptionConfiguration>)
:The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn’t support asymmetric keys.
created_at(Option<DateTime>)
:The Unix timestamp when the Amazon Q Business application was last updated.
updated_at(Option<DateTime>)
:The Unix timestamp when the Amazon Q Business application was last updated.
error(Option<ErrorDetail>)
:If the
Status
field is set toERROR
, theErrorMessage
field contains a description of the error that caused the synchronization to fail.attachments_configuration(Option<AppliedAttachmentsConfiguration>)
:Settings for whether end users can upload files directly during chat.
- On failure, responds with
SdkError<GetApplicationError>
source§impl Client
impl Client
sourcepub fn get_chat_controls_configuration(
&self
) -> GetChatControlsConfigurationFluentBuilder
pub fn get_chat_controls_configuration( &self ) -> GetChatControlsConfigurationFluentBuilder
Constructs a fluent builder for the GetChatControlsConfiguration
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application for which the chat controls are configured.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of configured chat controls to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
- On success, responds with
GetChatControlsConfigurationOutput
with field(s):response_scope(Option<ResponseScope>)
:The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
blocked_phrases(Option<BlockedPhrasesConfiguration>)
:The phrases blocked from chat by your chat control configuration.
topic_configurations(Option<Vec::<TopicConfiguration>>)
:The topic specific controls configured for a Amazon Q Business application.
creator_mode_configuration(Option<AppliedCreatorModeConfiguration>)
:The configuration details for
CREATOR_MODE
.next_token(Option<String>)
:If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
- On failure, responds with
SdkError<GetChatControlsConfigurationError>
source§impl Client
impl Client
sourcepub fn get_data_source(&self) -> GetDataSourceFluentBuilder
pub fn get_data_source(&self) -> GetDataSourceFluentBuilder
Constructs a fluent builder for the GetDataSource
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identfier of the index used with the data source connector.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe identifier of the data source connector.
- On success, responds with
GetDataSourceOutput
with field(s):application_id(Option<String>)
:The identifier of the Amazon Q Business application.
index_id(Option<String>)
:The identifier of the index linked to the data source connector.
data_source_id(Option<String>)
:The identifier of the data source connector.
data_source_arn(Option<String>)
:The Amazon Resource Name (ARN) of the data source.
display_name(Option<String>)
:The name for the data source connector.
r#type(Option<String>)
:The type of the data source connector. For example,
S3
.configuration(Option<Document>)
:The details of how the data source connector is configured.
vpc_configuration(Option<DataSourceVpcConfiguration>)
:Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
created_at(Option<DateTime>)
:The Unix timestamp when the data source connector was created.
updated_at(Option<DateTime>)
:The Unix timestamp when the data source connector was last updated.
description(Option<String>)
:The description for the data source connector.
status(Option<DataSourceStatus>)
:The current status of the data source connector. When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.sync_schedule(Option<String>)
:The schedule for Amazon Q Business to update the index.
role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
error(Option<ErrorDetail>)
:When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.document_enrichment_configuration(Option<DocumentEnrichmentConfiguration>)
:Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
- On failure, responds with
SdkError<GetDataSourceError>
source§impl Client
impl Client
sourcepub fn get_group(&self) -> GetGroupFluentBuilder
pub fn get_group(&self) -> GetGroupFluentBuilder
Constructs a fluent builder for the GetGroup
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application id the group is attached to.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index the group is attached to.
group_name(impl Into<String>)
/set_group_name(Option<String>)
:
required: trueThe name of the group.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: falseThe identifier of the data source the group is attached to.
- On success, responds with
GetGroupOutput
with field(s):status(Option<GroupStatusDetail>)
:The current status of the group.
status_history(Option<Vec::<GroupStatusDetail>>)
:The status history of the group.
- On failure, responds with
SdkError<GetGroupError>
source§impl Client
impl Client
sourcepub fn get_index(&self) -> GetIndexFluentBuilder
pub fn get_index(&self) -> GetIndexFluentBuilder
Constructs a fluent builder for the GetIndex
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application connected to the index.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business index you want information on.
- On success, responds with
GetIndexOutput
with field(s):application_id(Option<String>)
:The identifier of the Amazon Q Business application associated with the index.
index_id(Option<String>)
:The identifier of the Amazon Q Business index.
display_name(Option<String>)
:The name of the Amazon Q Business index.
r#type(Option<IndexType>)
:The type of index attached to your Amazon Q Business application.
index_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Amazon Q Business index.
status(Option<IndexStatus>)
:The current status of the index. When the value is
ACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.description(Option<String>)
:The description for the Amazon Q Business index.
created_at(Option<DateTime>)
:The Unix timestamp when the Amazon Q Business index was created.
updated_at(Option<DateTime>)
:The Unix timestamp when the Amazon Q Business index was last updated.
capacity_configuration(Option<IndexCapacityConfiguration>)
:The storage capacity units chosen for your Amazon Q Business index.
document_attribute_configurations(Option<Vec::<DocumentAttributeConfiguration>>)
:Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
error(Option<ErrorDetail>)
:When the
Status
field value isFAILED
, theErrorMessage
field contains a message that explains why.index_statistics(Option<IndexStatistics>)
:Provides information about the number of documents indexed.
- On failure, responds with
SdkError<GetIndexError>
source§impl Client
impl Client
sourcepub fn get_plugin(&self) -> GetPluginFluentBuilder
pub fn get_plugin(&self) -> GetPluginFluentBuilder
Constructs a fluent builder for the GetPlugin
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application which contains the plugin.
plugin_id(impl Into<String>)
/set_plugin_id(Option<String>)
:
required: trueThe identifier of the plugin.
- On success, responds with
GetPluginOutput
with field(s):application_id(Option<String>)
:The identifier of the application which contains the plugin.
plugin_id(Option<String>)
:The identifier of the plugin.
display_name(Option<String>)
:The name of the plugin.
r#type(Option<PluginType>)
:The type of the plugin.
server_url(Option<String>)
:The source URL used for plugin configuration.
auth_configuration(Option<PluginAuthConfiguration>)
:Authentication configuration information for an Amazon Q Business plugin.
custom_plugin_configuration(Option<CustomPluginConfiguration>)
:Configuration information required to create a custom plugin.
build_status(Option<PluginBuildStatus>)
:The current status of a plugin. A plugin is modified asynchronously.
plugin_arn(Option<String>)
:The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.
state(Option<PluginState>)
:The current state of the plugin.
created_at(Option<DateTime>)
:The timestamp for when the plugin was created.
updated_at(Option<DateTime>)
:The timestamp for when the plugin was last updated.
- On failure, responds with
SdkError<GetPluginError>
source§impl Client
impl Client
sourcepub fn get_retriever(&self) -> GetRetrieverFluentBuilder
pub fn get_retriever(&self) -> GetRetrieverFluentBuilder
Constructs a fluent builder for the GetRetriever
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application using the retriever.
retriever_id(impl Into<String>)
/set_retriever_id(Option<String>)
:
required: trueThe identifier of the retriever.
- On success, responds with
GetRetrieverOutput
with field(s):application_id(Option<String>)
:The identifier of the Amazon Q Business application using the retriever.
retriever_id(Option<String>)
:The identifier of the retriever.
retriever_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
r#type(Option<RetrieverType>)
:The type of the retriever.
status(Option<RetrieverStatus>)
:The status of the retriever.
display_name(Option<String>)
:The name of the retriever.
configuration(Option<RetrieverConfiguration>)
:Provides information on how the retriever used for your Amazon Q Business application is configured.
role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
created_at(Option<DateTime>)
:The Unix timestamp when the retriever was created.
updated_at(Option<DateTime>)
:The Unix timestamp when the retriever was last updated.
- On failure, responds with
SdkError<GetRetrieverError>
source§impl Client
impl Client
sourcepub fn get_user(&self) -> GetUserFluentBuilder
pub fn get_user(&self) -> GetUserFluentBuilder
Constructs a fluent builder for the GetUser
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application connected to the user.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe user email address attached to the user.
- On success, responds with
GetUserOutput
with field(s):user_aliases(Option<Vec::<UserAlias>>)
:A list of user aliases attached to a user.
- On failure, responds with
SdkError<GetUserError>
source§impl Client
impl Client
sourcepub fn get_web_experience(&self) -> GetWebExperienceFluentBuilder
pub fn get_web_experience(&self) -> GetWebExperienceFluentBuilder
Constructs a fluent builder for the GetWebExperience
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application linked to the web experience.
web_experience_id(impl Into<String>)
/set_web_experience_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business web experience.
- On success, responds with
GetWebExperienceOutput
with field(s):application_id(Option<String>)
:The identifier of the Amazon Q Business application linked to the web experience.
web_experience_id(Option<String>)
:The identifier of the Amazon Q Business web experience.
web_experience_arn(Option<String>)
:The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
default_endpoint(Option<String>)
:The endpoint of your Amazon Q Business web experience.
status(Option<WebExperienceStatus>)
:The current status of the Amazon Q Business web experience. When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.created_at(Option<DateTime>)
:The Unix timestamp when the Amazon Q Business web experience was last created.
updated_at(Option<DateTime>)
:The Unix timestamp when the Amazon Q Business web experience was last updated.
title(Option<String>)
:The title for your Amazon Q Business web experience.
subtitle(Option<String>)
:The subtitle for your Amazon Q Business web experience.
welcome_message(Option<String>)
:The customized welcome message for end users of an Amazon Q Business web experience.
sample_prompts_control_mode(Option<WebExperienceSamplePromptsControlMode>)
:Determines whether sample prompts are enabled in the web experience for an end user.
role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the service role attached to your web experience.
authentication_configuration(Option<WebExperienceAuthConfiguration>)
:The authentication configuration information for your Amazon Q Business web experience.
error(Option<ErrorDetail>)
:When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.
- On failure, responds with
SdkError<GetWebExperienceError>
source§impl Client
impl Client
sourcepub fn list_applications(&self) -> ListApplicationsFluentBuilder
pub fn list_applications(&self) -> ListApplicationsFluentBuilder
Constructs a fluent builder for the ListApplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of Amazon Q Business applications to return.
- On success, responds with
ListApplicationsOutput
with field(s):next_token(Option<String>)
:If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
applications(Option<Vec::<Application>>)
:An array of summary information on the configuration of one or more Amazon Q Business applications.
- On failure, responds with
SdkError<ListApplicationsError>
source§impl Client
impl Client
sourcepub fn list_conversations(&self) -> ListConversationsFluentBuilder
pub fn list_conversations(&self) -> ListConversationsFluentBuilder
Constructs a fluent builder for the ListConversations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: falseThe identifier of the user involved in the Amazon Q Business web experience conversation.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of Amazon Q Business conversations to return.
- On success, responds with
ListConversationsOutput
with field(s):next_token(Option<String>)
:If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
conversations(Option<Vec::<Conversation>>)
:An array of summary information on the configuration of one or more Amazon Q Business web experiences.
- On failure, responds with
SdkError<ListConversationsError>
source§impl Client
impl Client
sourcepub fn list_data_source_sync_jobs(&self) -> ListDataSourceSyncJobsFluentBuilder
pub fn list_data_source_sync_jobs(&self) -> ListDataSourceSyncJobsFluentBuilder
Constructs a fluent builder for the ListDataSourceSyncJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe identifier of the data source connector.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application connected to the data source.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index used with the Amazon Q Business data source connector.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the
maxResults
response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of synchronization jobs to return in the response.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe start time of the data source connector sync.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:
required: falseThe end time of the data source connector sync.
status_filter(DataSourceSyncJobStatus)
/set_status_filter(Option<DataSourceSyncJobStatus>)
:
required: falseOnly returns synchronization jobs with the
Status
field equal to the specified status.
- On success, responds with
ListDataSourceSyncJobsOutput
with field(s):history(Option<Vec::<DataSourceSyncJob>>)
:A history of synchronization jobs for the data source connector.
next_token(Option<String>)
:If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.
- On failure, responds with
SdkError<ListDataSourceSyncJobsError>
source§impl Client
impl Client
sourcepub fn list_data_sources(&self) -> ListDataSourcesFluentBuilder
pub fn list_data_sources(&self) -> ListDataSourcesFluentBuilder
Constructs a fluent builder for the ListDataSources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application linked to the data source connectors.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index used with one or more data source connectors.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of data source connectors to return.
- On success, responds with
ListDataSourcesOutput
with field(s):data_sources(Option<Vec::<DataSource>>)
:An array of summary information for one or more data source connector.
next_token(Option<String>)
:If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.
- On failure, responds with
SdkError<ListDataSourcesError>
source§impl Client
impl Client
sourcepub fn list_documents(&self) -> ListDocumentsFluentBuilder
pub fn list_documents(&self) -> ListDocumentsFluentBuilder
Constructs a fluent builder for the ListDocuments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application id the documents are attached to.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index the documents are attached to.
data_source_ids(impl Into<String>)
/set_data_source_ids(Option<Vec::<String>>)
:
required: falseThe identifier of the data sources the documents are attached to.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of documents to return.
- On success, responds with
ListDocumentsOutput
with field(s):document_detail_list(Option<Vec::<DocumentDetails>>)
:A list of document details.
next_token(Option<String>)
:If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
- On failure, responds with
SdkError<ListDocumentsError>
source§impl Client
impl Client
sourcepub fn list_groups(&self) -> ListGroupsFluentBuilder
pub fn list_groups(&self) -> ListGroupsFluentBuilder
Constructs a fluent builder for the ListGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application for getting a list of groups mapped to users.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index for getting a list of groups mapped to users.
updated_earlier_than(DateTime)
/set_updated_earlier_than(Option<DateTime>)
:
required: trueThe timestamp identifier used for the latest
PUT
orDELETE
action for mapping users to their groups.data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: falseThe identifier of the data source for getting a list of groups mapped to users.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of returned groups that are mapped to users.
- On success, responds with
ListGroupsOutput
with field(s):next_token(Option<String>)
:If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.
items(Option<Vec::<GroupSummary>>)
:Summary information for list of groups that are mapped to users.
- On failure, responds with
SdkError<ListGroupsError>
source§impl Client
impl Client
sourcepub fn list_indices(&self) -> ListIndicesFluentBuilder
pub fn list_indices(&self) -> ListIndicesFluentBuilder
Constructs a fluent builder for the ListIndices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application connected to the index.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of indices to return.
- On success, responds with
ListIndicesOutput
with field(s):next_token(Option<String>)
:If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.
indices(Option<Vec::<Index>>)
:An array of information on the items in one or more indexes.
- On failure, responds with
SdkError<ListIndicesError>
source§impl Client
impl Client
sourcepub fn list_messages(&self) -> ListMessagesFluentBuilder
pub fn list_messages(&self) -> ListMessagesFluentBuilder
Constructs a fluent builder for the ListMessages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
conversation_id(impl Into<String>)
/set_conversation_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business web experience conversation.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier for the Amazon Q Business application.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: falseThe identifier of the user involved in the Amazon Q Business web experience conversation.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the number of retrievers returned exceeds
maxResults
, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of messages to return.
- On success, responds with
ListMessagesOutput
with field(s):messages(Option<Vec::<Message>>)
:An array of information on one or more messages.
next_token(Option<String>)
:If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
- On failure, responds with
SdkError<ListMessagesError>
source§impl Client
impl Client
sourcepub fn list_plugins(&self) -> ListPluginsFluentBuilder
pub fn list_plugins(&self) -> ListPluginsFluentBuilder
Constructs a fluent builder for the ListPlugins
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application the plugin is attached to.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of documents to return.
- On success, responds with
ListPluginsOutput
with field(s):next_token(Option<String>)
:If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.plugins(Option<Vec::<Plugin>>)
:Information about a configured plugin.
- On failure, responds with
SdkError<ListPluginsError>
source§impl Client
impl Client
sourcepub fn list_retrievers(&self) -> ListRetrieversFluentBuilder
pub fn list_retrievers(&self) -> ListRetrieversFluentBuilder
Constructs a fluent builder for the ListRetrievers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application using the retriever.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the number of retrievers returned exceeds
maxResults
, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of retrievers returned.
- On success, responds with
ListRetrieversOutput
with field(s):retrievers(Option<Vec::<Retriever>>)
:An array of summary information for one or more retrievers.
next_token(Option<String>)
:If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.
- On failure, responds with
SdkError<ListRetrieversError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:A list of tags associated with the Amazon Q Business application or data source.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn list_web_experiences(&self) -> ListWebExperiencesFluentBuilder
pub fn list_web_experiences(&self) -> ListWebExperiencesFluentBuilder
Constructs a fluent builder for the ListWebExperiences
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application linked to the listed web experiences.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of Amazon Q Business Web Experiences to return.
- On success, responds with
ListWebExperiencesOutput
with field(s):web_experiences(Option<Vec::<WebExperience>>)
:An array of summary information for one or more Amazon Q Business experiences.
next_token(Option<String>)
:If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
- On failure, responds with
SdkError<ListWebExperiencesError>
source§impl Client
impl Client
sourcepub fn put_feedback(&self) -> PutFeedbackFluentBuilder
pub fn put_feedback(&self) -> PutFeedbackFluentBuilder
Constructs a fluent builder for the PutFeedback
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application associated with the feedback.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: falseThe identifier of the user giving the feedback.
conversation_id(impl Into<String>)
/set_conversation_id(Option<String>)
:
required: trueThe identifier of the conversation the feedback is attached to.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:
required: trueThe identifier of the chat message that the feedback was given for.
message_copied_at(DateTime)
/set_message_copied_at(Option<DateTime>)
:
required: falseThe timestamp for when the feedback was recorded.
message_usefulness(MessageUsefulnessFeedback)
/set_message_usefulness(Option<MessageUsefulnessFeedback>)
:
required: falseThe feedback usefulness value given by the user to the chat message.
- On success, responds with
PutFeedbackOutput
- On failure, responds with
SdkError<PutFeedbackError>
source§impl Client
impl Client
sourcepub fn put_group(&self) -> PutGroupFluentBuilder
pub fn put_group(&self) -> PutGroupFluentBuilder
Constructs a fluent builder for the PutGroup
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application in which the user and group mapping belongs.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index in which you want to map users to their groups.
group_name(impl Into<String>)
/set_group_name(Option<String>)
:
required: trueThe list that contains your users or sub groups that belong the same group. For example, the group “Company” includes the user “CEO” and the sub groups “Research”, “Engineering”, and “Sales and Marketing”.
If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: falseThe identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups “Research”, “Engineering”, and “Sales and Marketing” are all tied to the company’s documents stored in the data sources Confluence and Salesforce. However, “Sales and Marketing” team only needs access to customer-related documents stored in Salesforce.
r#type(MembershipType)
/set_type(Option<MembershipType>)
:
required: trueThe type of the group.
group_members(GroupMembers)
/set_group_members(Option<GroupMembers>)
:
required: trueA list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.
- On success, responds with
PutGroupOutput
- On failure, responds with
SdkError<PutGroupError>
source§impl Client
impl Client
sourcepub fn start_data_source_sync_job(&self) -> StartDataSourceSyncJobFluentBuilder
pub fn start_data_source_sync_job(&self) -> StartDataSourceSyncJobFluentBuilder
Constructs a fluent builder for the StartDataSourceSyncJob
operation.
- The fluent builder is configurable:
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe identifier of the data source connector.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of Amazon Q Business application the data source is connected to.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index used with the data source connector.
- On success, responds with
StartDataSourceSyncJobOutput
with field(s):execution_id(Option<String>)
:The identifier for a particular synchronization job.
- On failure, responds with
SdkError<StartDataSourceSyncJobError>
source§impl Client
impl Client
sourcepub fn stop_data_source_sync_job(&self) -> StopDataSourceSyncJobFluentBuilder
pub fn stop_data_source_sync_job(&self) -> StopDataSourceSyncJobFluentBuilder
Constructs a fluent builder for the StopDataSourceSyncJob
operation.
- The fluent builder is configurable:
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe identifier of the data source connector.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application that the data source is connected to.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index used with the Amazon Q Business data source connector.
- On success, responds with
StopDataSourceSyncJobOutput
- On failure, responds with
SdkError<StopDataSourceSyncJobError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueA list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_application(&self) -> UpdateApplicationFluentBuilder
pub fn update_application(&self) -> UpdateApplicationFluentBuilder
Constructs a fluent builder for the UpdateApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application.
identity_center_instance_arn(impl Into<String>)
/set_identity_center_instance_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseA name for the Amazon Q Business application.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the Amazon Q Business application.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseAn Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
attachments_configuration(AttachmentsConfiguration)
/set_attachments_configuration(Option<AttachmentsConfiguration>)
:
required: falseAn option to allow end users to upload files directly during chat.
- On success, responds with
UpdateApplicationOutput
- On failure, responds with
SdkError<UpdateApplicationError>
source§impl Client
impl Client
sourcepub fn update_chat_controls_configuration(
&self
) -> UpdateChatControlsConfigurationFluentBuilder
pub fn update_chat_controls_configuration( &self ) -> UpdateChatControlsConfigurationFluentBuilder
Constructs a fluent builder for the UpdateChatControlsConfiguration
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application for which the chat controls are configured.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that you provide to identify the request to update a Amazon Q Business application chat configuration.
response_scope(ResponseScope)
/set_response_scope(Option<ResponseScope>)
:
required: falseThe response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
blocked_phrases_configuration_update(BlockedPhrasesConfigurationUpdate)
/set_blocked_phrases_configuration_update(Option<BlockedPhrasesConfigurationUpdate>)
:
required: falseThe phrases blocked from chat by your chat control configuration.
topic_configurations_to_create_or_update(TopicConfiguration)
/set_topic_configurations_to_create_or_update(Option<Vec::<TopicConfiguration>>)
:
required: falseThe configured topic specific chat controls you want to update.
topic_configurations_to_delete(TopicConfiguration)
/set_topic_configurations_to_delete(Option<Vec::<TopicConfiguration>>)
:
required: falseThe configured topic specific chat controls you want to delete.
creator_mode_configuration(CreatorModeConfiguration)
/set_creator_mode_configuration(Option<CreatorModeConfiguration>)
:
required: falseThe configuration details for
CREATOR_MODE
.
- On success, responds with
UpdateChatControlsConfigurationOutput
- On failure, responds with
SdkError<UpdateChatControlsConfigurationError>
source§impl Client
impl Client
sourcepub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder
pub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder
Constructs a fluent builder for the UpdateDataSource
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application the data source is attached to.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the index attached to the data source connector.
data_source_id(impl Into<String>)
/set_data_source_id(Option<String>)
:
required: trueThe identifier of the data source connector.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseA name of the data source connector.
configuration(Document)
/set_configuration(Option<Document>)
:
required: falseProvides the configuration information for an Amazon Q Business data source.
vpc_configuration(DataSourceVpcConfiguration)
/set_vpc_configuration(Option<DataSourceVpcConfiguration>)
:
required: falseProvides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the data source connector.
sync_schedule(impl Into<String>)
/set_sync_schedule(Option<String>)
:
required: falseThe chosen update frequency for your data source.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
document_enrichment_configuration(DocumentEnrichmentConfiguration)
/set_document_enrichment_configuration(Option<DocumentEnrichmentConfiguration>)
:
required: falseProvides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
- On success, responds with
UpdateDataSourceOutput
- On failure, responds with
SdkError<UpdateDataSourceError>
source§impl Client
impl Client
sourcepub fn update_index(&self) -> UpdateIndexFluentBuilder
pub fn update_index(&self) -> UpdateIndexFluentBuilder
Constructs a fluent builder for the UpdateIndex
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application connected to the index.
index_id(impl Into<String>)
/set_index_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business index.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseThe name of the Amazon Q Business index.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the Amazon Q Business index.
capacity_configuration(IndexCapacityConfiguration)
/set_capacity_configuration(Option<IndexCapacityConfiguration>)
:
required: falseThe storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.
document_attribute_configurations(DocumentAttributeConfiguration)
/set_document_attribute_configurations(Option<Vec::<DocumentAttributeConfiguration>>)
:
required: falseConfiguration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
- On success, responds with
UpdateIndexOutput
- On failure, responds with
SdkError<UpdateIndexError>
source§impl Client
impl Client
sourcepub fn update_plugin(&self) -> UpdatePluginFluentBuilder
pub fn update_plugin(&self) -> UpdatePluginFluentBuilder
Constructs a fluent builder for the UpdatePlugin
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application the plugin is attached to.
plugin_id(impl Into<String>)
/set_plugin_id(Option<String>)
:
required: trueThe identifier of the plugin.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseThe name of the plugin.
state(PluginState)
/set_state(Option<PluginState>)
:
required: falseThe status of the plugin.
server_url(impl Into<String>)
/set_server_url(Option<String>)
:
required: falseThe source URL used for plugin configuration.
custom_plugin_configuration(CustomPluginConfiguration)
/set_custom_plugin_configuration(Option<CustomPluginConfiguration>)
:
required: falseThe configuration for a custom plugin.
auth_configuration(PluginAuthConfiguration)
/set_auth_configuration(Option<PluginAuthConfiguration>)
:
required: falseThe authentication configuration the plugin is using.
- On success, responds with
UpdatePluginOutput
- On failure, responds with
SdkError<UpdatePluginError>
source§impl Client
impl Client
sourcepub fn update_retriever(&self) -> UpdateRetrieverFluentBuilder
pub fn update_retriever(&self) -> UpdateRetrieverFluentBuilder
Constructs a fluent builder for the UpdateRetriever
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of your Amazon Q Business application.
retriever_id(impl Into<String>)
/set_retriever_id(Option<String>)
:
required: trueThe identifier of your retriever.
configuration(RetrieverConfiguration)
/set_configuration(Option<RetrieverConfiguration>)
:
required: falseProvides information on how the retriever used for your Amazon Q Business application is configured.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseThe name of your retriever.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
- On success, responds with
UpdateRetrieverOutput
- On failure, responds with
SdkError<UpdateRetrieverError>
source§impl Client
impl Client
sourcepub fn update_user(&self) -> UpdateUserFluentBuilder
pub fn update_user(&self) -> UpdateUserFluentBuilder
Constructs a fluent builder for the UpdateUser
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application the user is attached to.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe email id attached to the user.
user_aliases_to_update(UserAlias)
/set_user_aliases_to_update(Option<Vec::<UserAlias>>)
:
required: falseThe user aliases attached to the user id that are to be updated.
user_aliases_to_delete(UserAlias)
/set_user_aliases_to_delete(Option<Vec::<UserAlias>>)
:
required: falseThe user aliases attached to the user id that are to be deleted.
- On success, responds with
UpdateUserOutput
with field(s):user_aliases_added(Option<Vec::<UserAlias>>)
:The user aliases that have been to be added to a user id.
user_aliases_updated(Option<Vec::<UserAlias>>)
:The user aliases attached to a user id that have been updated.
user_aliases_deleted(Option<Vec::<UserAlias>>)
:The user aliases that have been deleted from a user id.
- On failure, responds with
SdkError<UpdateUserError>
source§impl Client
impl Client
sourcepub fn update_web_experience(&self) -> UpdateWebExperienceFluentBuilder
pub fn update_web_experience(&self) -> UpdateWebExperienceFluentBuilder
Constructs a fluent builder for the UpdateWebExperience
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business application attached to the web experience.
web_experience_id(impl Into<String>)
/set_web_experience_id(Option<String>)
:
required: trueThe identifier of the Amazon Q Business web experience.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
authentication_configuration(WebExperienceAuthConfiguration)
/set_authentication_configuration(Option<WebExperienceAuthConfiguration>)
:
required: falseThe authentication configuration of the Amazon Q Business web experience.
title(impl Into<String>)
/set_title(Option<String>)
:
required: falseThe title of the Amazon Q Business web experience.
subtitle(impl Into<String>)
/set_subtitle(Option<String>)
:
required: falseThe subtitle of the Amazon Q Business web experience.
welcome_message(impl Into<String>)
/set_welcome_message(Option<String>)
:
required: falseA customized welcome message for an end user in an Amazon Q Business web experience.
sample_prompts_control_mode(WebExperienceSamplePromptsControlMode)
/set_sample_prompts_control_mode(Option<WebExperienceSamplePromptsControlMode>)
:
required: falseDetermines whether sample prompts are enabled in the web experience for an end user.
- On success, responds with
UpdateWebExperienceOutput
- On failure, responds with
SdkError<UpdateWebExperienceError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
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> 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 more