Struct Client 

pub struct Client { /* private fields */ }

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 Builder 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 AssociatePermission operation has a Client::associate_permission, 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.associate_permission()
    .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

impl Client

pub fn associate_permission(&self) -> AssociatePermissionFluentBuilder

Constructs a fluent builder for the AssociatePermission operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application.

    
    
  • statement_id(impl Into<String>) / set_statement_id(Option<String>):
    required: true
    

    A unique identifier for the policy statement.

    
    
  • actions(impl Into<String>) / set_actions(Option<Vec::<String>>):
    required: true
    

    The list of Amazon Q Business actions that the ISV is allowed to perform.

    
    
  • conditions(PermissionCondition) / set_conditions(Option<Vec::<PermissionCondition>>):
    required: false
    

    The conditions that restrict when the permission is effective. These conditions can be used to limit the permission based on specific attributes of the request.

    
    
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: true
    

    The Amazon Resource Name of the IAM role for the ISV that is being granted permission.

    
    
• On success, responds with AssociatePermissionOutput with field(s):
  • statement(Option<String>):

    The JSON representation of the added permission statement.

• On failure, responds with SdkError<AssociatePermissionError>

impl Client

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: true
    

    The identifier of the Amazon Q Business application.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business index that contains the documents to delete.

    
    
  • documents(DeleteDocument) / set_documents(Option<Vec::<DeleteDocument>>):
    required: true
    

    Documents deleted from the Amazon Q Business index.

    
    
  • data_source_sync_id(impl Into<String>) / set_data_source_sync_id(Option<String>):
    required: false
    

    The 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business application.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business index to add the documents to.

    
    
  • documents(Document) / set_documents(Option<Vec::<Document>>):
    required: true
    

    One or more documents to add to the index.

    Ensure that the name of your document doesn’t contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The 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: false
    

    The 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>

impl Client

pub fn cancel_subscription(&self) -> CancelSubscriptionFluentBuilder

Constructs a fluent builder for the CancelSubscription operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business application for which the subscription is being cancelled.

    
    
  • subscription_id(impl Into<String>) / set_subscription_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business subscription being cancelled.

    
    
• On success, responds with CancelSubscriptionOutput with field(s):
  • subscription_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Q Business subscription being cancelled.

  • current_subscription(Option<SubscriptionDetails>):

    The type of your current Amazon Q Business subscription.

  • next_subscription(Option<SubscriptionDetails>):

    The type of the Amazon Q Business subscription for the next month.

• On failure, responds with SdkError<CancelSubscriptionError>

impl Client

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: true
    

    The 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: false
    

    The identifier of the user attached to the chat input.

    
    
  • user_groups(impl Into<String>) / set_user_groups(Option<Vec::<String>>):
    required: false
    

    The group names that a user associated with the chat input belongs to.

    
    
  • conversation_id(impl Into<String>) / set_conversation_id(Option<String>):
    required: false
    

    The identifier of the Amazon Q Business conversation.

    
    
  • parent_message_id(impl Into<String>) / set_parent_message_id(Option<String>):
    required: false
    

    The identifier used to associate a user message with a AI generated response.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A token that you provide to identify the chat input.

    
    
  • input_stream(EventStreamSender<ChatInputStream, ChatInputStreamError>) / set_input_stream(EventStreamSender<ChatInputStream, ChatInputStreamError>):
    required: false
    

    The 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>

impl Client

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: true
    

    The 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: false
    

    The identifier of the user attached to the chat input.

    
    
  • user_groups(impl Into<String>) / set_user_groups(Option<Vec::<String>>):
    required: false
    

    The group names that a user associated with the chat input belongs to.

    
    
  • user_message(impl Into<String>) / set_user_message(Option<String>):
    required: false
    

    A end user message in a conversation.

    
    
  • attachments(AttachmentInput) / set_attachments(Option<Vec::<AttachmentInput>>):
    required: false
    

    A 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: false
    

    A request from an end user to perform an Amazon Q Business plugin action.

    
    
  • auth_challenge_response(AuthChallengeResponse) / set_auth_challenge_response(Option<AuthChallengeResponse>):
    required: false
    

    An 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: false
    

    The identifier of the Amazon Q Business conversation.

    
    
  • parent_message_id(impl Into<String>) / set_parent_message_id(Option<String>):
    required: false
    

    The identifier of the previous system message in a conversation.

    
    
  • attribute_filter(AttributeFilter) / set_attribute_filter(Option<AttributeFilter>):
    required: false
    

    Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

    
    
  • chat_mode(ChatMode) / set_chat_mode(Option<ChatMode>):
    required: false
    

    The chatMode parameter determines the chat modes available to Amazon Q Business users:

    • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a “No Answer Found” message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge

    • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.

    • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.

    If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

    For more information, see Admin controls and guardrails, Plugins, and Response sources.

    
    
  • chat_mode_configuration(ChatModeConfiguration) / set_chat_mode_configuration(Option<ChatModeConfiguration>):
    required: false
    

    The chat mode configuration for an Amazon Q Business application.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A 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>

impl Client

pub fn check_document_access(&self) -> CheckDocumentAccessFluentBuilder

Constructs a fluent builder for the CheckDocumentAccess operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The unique identifier of the index. Used to locate the correct index within the application where the document is stored.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The unique identifier of the user. Used to check the access permissions for this specific user against the document’s ACL.

    
    
  • document_id(impl Into<String>) / set_document_id(Option<String>):
    required: true
    

    The unique identifier of the document. Specifies which document’s access permissions are being checked.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: false
    

    The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary.

    
    
• On success, responds with CheckDocumentAccessOutput with field(s):
  • user_groups(Option<Vec::<AssociatedGroup>>):

    An array of groups the user is part of for the specified data source. Each group has a name and type.

  • user_aliases(Option<Vec::<AssociatedUser>>):

    An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.

  • has_access(Option<bool>):

    A boolean value indicating whether the specified user has access to the document, either direct access or transitive access via groups and aliases attached to the document.

  • document_acl(Option<DocumentAcl>):

    The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.

• On failure, responds with SdkError<CheckDocumentAccessError>

impl Client

pub fn create_anonymous_web_experience_url( &self, ) -> CreateAnonymousWebExperienceUrlFluentBuilder

Constructs a fluent builder for the CreateAnonymousWebExperienceUrl operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business application environment attached to the web experience.

    
    
  • web_experience_id(impl Into<String>) / set_web_experience_id(Option<String>):
    required: true
    

    The identifier of the web experience.

    
    
  • session_duration_in_minutes(i32) / set_session_duration_in_minutes(Option<i32>):
    required: false
    

    The duration of the session associated with the unique URL for the web experience.

    
    
• On success, responds with CreateAnonymousWebExperienceUrlOutput with field(s):
  • anonymous_url(Option<String>):

    The unique URL for accessing the web experience.

    This URL can only be used once and must be used within 5 minutes after it’s generated.

• On failure, responds with SdkError<CreateAnonymousWebExperienceUrlError>

impl Client

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: true
    

    A name for the Amazon Q Business application.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application’s role.

    
    
  • identity_type(IdentityType) / set_identity_type(Option<IdentityType>):
    required: false
    

    The authentication type being used by a Amazon Q Business application.

    
    
  • iam_identity_provider_arn(impl Into<String>) / set_iam_identity_provider_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

    
    
  • identity_center_instance_arn(impl Into<String>) / set_identity_center_instance_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

    
    
  • client_ids_for_oidc(impl Into<String>) / set_client_ids_for_oidc(Option<Vec::<String>>):
    required: false
    

    The OIDC client ID for a Amazon Q Business application.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the Amazon Q Business application.

    
    
  • encryption_configuration(EncryptionConfiguration) / set_encryption_configuration(Option<EncryptionConfiguration>):
    required: false
    

    The 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: false
    

    A 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: false
    

    A token that you provide to identify the request to create your Amazon Q Business application.

    
    
  • attachments_configuration(AttachmentsConfiguration) / set_attachments_configuration(Option<AttachmentsConfiguration>):
    required: false
    

    An option to allow end users to upload files directly during chat.

    
    
  • q_apps_configuration(QAppsConfiguration) / set_q_apps_configuration(Option<QAppsConfiguration>):
    required: false
    

    An option to allow end users to create and use Amazon Q Apps in the web experience.

    
    
  • personalization_configuration(PersonalizationConfiguration) / set_personalization_configuration(Option<PersonalizationConfiguration>):
    required: false
    

    Configuration information about chat response personalization. For more information, see Personalizing chat responses

    
    
  • quick_sight_configuration(QuickSightConfiguration) / set_quick_sight_configuration(Option<QuickSightConfiguration>):
    required: false
    

    The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

    
    
• 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>

impl Client

pub fn create_chat_response_configuration( &self, ) -> CreateChatResponseConfigurationFluentBuilder

Constructs a fluent builder for the CreateChatResponseConfiguration operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same configuration from being created multiple times if retries occur.

    
    
  • response_configurations(ResponseConfigurationType, ResponseConfiguration) / set_response_configurations(Option<HashMap::<ResponseConfigurationType, ResponseConfiguration>>):
    required: true
    

    A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of key-value pairs to apply as tags to the new chat response configuration, enabling categorization and management of resources across Amazon Web Services services.

    
    
• On success, responds with CreateChatResponseConfigurationOutput with field(s):
  • chat_response_configuration_id(String):

    The unique identifier assigned to a newly created chat response configuration, used for subsequent operations on this resource.

  • chat_response_configuration_arn(String):

    The Amazon Resource Name (ARN) of the newly created chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.

• On failure, responds with SdkError<CreateChatResponseConfigurationError>

impl Client

pub fn create_data_accessor(&self) -> CreateDataAccessorFluentBuilder

Constructs a fluent builder for the CreateDataAccessor operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application.

    
    
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.

    
    
  • action_configurations(ActionConfiguration) / set_action_configurations(Option<Vec::<ActionConfiguration>>):
    required: true
    

    A list of action configurations specifying the allowed actions and any associated filters.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier you provide to ensure idempotency of the request.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    A friendly name for the data accessor.

    
    
  • authentication_detail(DataAccessorAuthenticationDetail) / set_authentication_detail(Option<DataAccessorAuthenticationDetail>):
    required: false
    

    The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to associate with the data accessor.

    
    
• On success, responds with CreateDataAccessorOutput with field(s):
  • data_accessor_id(String):

    The unique identifier of the created data accessor.

  • idc_application_arn(String):

    The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor.

  • data_accessor_arn(String):

    The Amazon Resource Name (ARN) of the created data accessor.

• On failure, responds with SdkError<CreateDataAccessorError>

impl Client

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: true
    

    The 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: true
    

    The 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: true
    

    A name for the data source connector.

    
    
  • configuration(Document) / set_configuration(Option<Document>):
    required: true
    

    Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

    Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

    • Amazon S3 JSON schema

    • Web Crawler JSON schema

    You can find configuration templates for your specific data source using the following steps:

    1. Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.

    2. Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.

    
    
  • vpc_configuration(DataSourceVpcConfiguration) / set_vpc_configuration(Option<DataSourceVpcConfiguration>):
    required: false
    

    Configuration 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: false
    

    A description for the data source connector.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A 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: false
    

    Sets 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 the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. This field is required for all connector types except custom connectors, where it is optional.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A 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: false
    

    Provides the configuration information for altering document metadata and content during the document ingestion process.

    For more information, see Custom document enrichment.

    
    
  • media_extraction_configuration(MediaExtractionConfiguration) / set_media_extraction_configuration(Option<MediaExtractionConfiguration>):
    required: false
    

    The configuration for extracting information from media in documents during ingestion.

    
    
• 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business application using the index.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    A name for the Amazon Q Business index.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the Amazon Q Business index.

    
    
  • r#type(IndexType) / set_type(Option<IndexType>):
    required: false
    

    The index type that’s suitable for your needs. For more information on what’s included in each type of index, see Amazon Q Business tiers.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A 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: false
    

    The 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: false
    

    A 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>

impl Client

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: true
    

    The identifier of the application that will contain the plugin.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    A the name for your plugin.

    
    
  • r#type(PluginType) / set_type(Option<PluginType>):
    required: true
    

    The type of plugin you want to create.

    
    
  • auth_configuration(PluginAuthConfiguration) / set_auth_configuration(Option<PluginAuthConfiguration>):
    required: true
    

    Authentication configuration information for an Amazon Q Business plugin.

    
    
  • server_url(impl Into<String>) / set_server_url(Option<String>):
    required: false
    

    The source URL used for plugin configuration.

    
    
  • custom_plugin_configuration(CustomPluginConfiguration) / set_custom_plugin_configuration(Option<CustomPluginConfiguration>):
    required: false
    

    Contains configuration for a custom plugin.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A 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: false
    

    A 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>

impl Client

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: true
    

    The identifier of your Amazon Q Business application.

    
    
  • r#type(RetrieverType) / set_type(Option<RetrieverType>):
    required: true
    

    The type of retriever you are using.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The name of your retriever.

    
    
  • configuration(RetrieverConfiguration) / set_configuration(Option<RetrieverConfiguration>):
    required: true
    

    Provides 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: false
    

    The 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: false
    

    A token that you provide to identify the request to create your Amazon Q Business application retriever.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A 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>

impl Client

pub fn create_subscription(&self) -> CreateSubscriptionFluentBuilder

Constructs a fluent builder for the CreateSubscription operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business application the subscription should be added to.

    
    
  • principal(SubscriptionPrincipal) / set_principal(Option<SubscriptionPrincipal>):
    required: true
    

    The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

    
    
  • r#type(SubscriptionType) / set_type(Option<SubscriptionType>):
    required: true
    

    The type of Amazon Q Business subscription you want to create.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A token that you provide to identify the request to create a subscription for your Amazon Q Business application.

    
    
• On success, responds with CreateSubscriptionOutput with field(s):
  • subscription_id(Option<String>):

    The identifier of the Amazon Q Business subscription created.

  • subscription_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Q Business subscription created.

  • current_subscription(Option<SubscriptionDetails>):

    The type of your current Amazon Q Business subscription.

  • next_subscription(Option<SubscriptionDetails>):

    The type of the Amazon Q Business subscription for the next month.

• On failure, responds with SdkError<CreateSubscriptionError>

impl Client

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: true
    

    The identifier of the application for which the user mapping will be created.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user emails attached to a user mapping.

    
    
  • user_aliases(UserAlias) / set_user_aliases(Option<Vec::<UserAlias>>):
    required: false
    

    The list of user aliases in the mapping.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business web experience.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: false
    

    The title for your Amazon Q Business web experience.

    
    
  • subtitle(impl Into<String>) / set_subtitle(Option<String>):
    required: false
    

    A subtitle to personalize your Amazon Q Business web experience.

    
    
  • welcome_message(impl Into<String>) / set_welcome_message(Option<String>):
    required: false
    

    The 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: false
    

    Determines whether sample prompts are enabled in the web experience for an end user.

    
    
  • origins(impl Into<String>) / set_origins(Option<Vec::<String>>):
    required: false
    

    Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

    You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

    The roleArn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A 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: false
    

    A token you provide to identify a request to create an Amazon Q Business web experience.

    
    
  • identity_provider_configuration(IdentityProviderConfiguration) / set_identity_provider_configuration(Option<IdentityProviderConfiguration>):
    required: false
    

    Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

    
    
  • browser_extension_configuration(BrowserExtensionConfiguration) / set_browser_extension_configuration(Option<BrowserExtensionConfiguration>):
    required: false
    

    The browser extension configuration for an Amazon Q Business web experience.

    For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

    
    
  • customization_configuration(CustomizationConfiguration) / set_customization_configuration(Option<CustomizationConfiguration>):
    required: false
    

    Sets the custom logo, favicon, font, and color used in the Amazon Q 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business application.

    
    
• On success, responds with DeleteApplicationOutput
• On failure, responds with SdkError<DeleteApplicationError>

impl Client

pub fn delete_attachment(&self) -> DeleteAttachmentFluentBuilder

Constructs a fluent builder for the DeleteAttachment operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the Amazon Q Business application environment.

    
    
  • conversation_id(impl Into<String>) / set_conversation_id(Option<String>):
    required: true
    

    The unique identifier of the conversation.

    
    
  • attachment_id(impl Into<String>) / set_attachment_id(Option<String>):
    required: true
    

    The unique identifier for the attachment.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The unique identifier of the user involved in the conversation.

    
    
• On success, responds with DeleteAttachmentOutput
• On failure, responds with SdkError<DeleteAttachmentError>

impl Client

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: true
    

    The identifier of the application the chat controls have been configured for.

    
    
• On success, responds with DeleteChatControlsConfigurationOutput
• On failure, responds with SdkError<DeleteChatControlsConfigurationError>

impl Client

pub fn delete_chat_response_configuration( &self, ) -> DeleteChatResponseConfigurationFluentBuilder

Constructs a fluent builder for the DeleteChatResponseConfiguration operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of theAmazon Q Business application from which to delete the chat response configuration.

    
    
  • chat_response_configuration_id(impl Into<String>) / set_chat_response_configuration_id(Option<String>):
    required: true
    

    The unique identifier of the chat response configuration to delete from the specified application.

    
    
• On success, responds with DeleteChatResponseConfigurationOutput
• On failure, responds with SdkError<DeleteChatResponseConfigurationError>

impl Client

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: true
    

    The identifier of the Amazon Q Business web experience conversation being deleted.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business application associated with the conversation.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The identifier of the user who is deleting the conversation.

    
    
• On success, responds with DeleteConversationOutput
• On failure, responds with SdkError<DeleteConversationError>

impl Client

pub fn delete_data_accessor(&self) -> DeleteDataAccessorFluentBuilder

Constructs a fluent builder for the DeleteDataAccessor operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application.

    
    
  • data_accessor_id(impl Into<String>) / set_data_accessor_id(Option<String>):
    required: true
    

    The unique identifier of the data accessor to delete.

    
    
• On success, responds with DeleteDataAccessorOutput
• On failure, responds with SdkError<DeleteDataAccessorError>

impl Client

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: true
    

    The identifier of the Amazon Q Business application used with the data source connector.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the index used with the data source connector.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The identifier of the data source connector that you want to delete.

    
    
• On success, responds with DeleteDataSourceOutput
• On failure, responds with SdkError<DeleteDataSourceError>

impl Client

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: true
    

    The identifier of the application in which the group mapping belongs.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the index you want to delete the group from.

    
    
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    The name of the group you want to delete.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: false
    

    The 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>

impl Client

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: true
    

    The 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: true
    

    The identifier of the Amazon Q Business index.

    
    
• On success, responds with DeleteIndexOutput
• On failure, responds with SdkError<DeleteIndexError>

impl Client

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: true
    

    The identifier the application attached to the Amazon Q Business plugin.

    
    
  • plugin_id(impl Into<String>) / set_plugin_id(Option<String>):
    required: true
    

    The identifier of the plugin being deleted.

    
    
• On success, responds with DeletePluginOutput
• On failure, responds with SdkError<DeletePluginError>

impl Client

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: true
    

    The identifier of the Amazon Q Business application using the retriever.

    
    
  • retriever_id(impl Into<String>) / set_retriever_id(Option<String>):
    required: true
    

    The identifier of the retriever being deleted.

    
    
• On success, responds with DeleteRetrieverOutput
• On failure, responds with SdkError<DeleteRetrieverError>

impl Client

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: true
    

    The identifier of the application from which the user is being deleted.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user email being deleted.

    
    
• On success, responds with DeleteUserOutput
• On failure, responds with SdkError<DeleteUserError>

impl Client

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: true
    

    The 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: true
    

    The identifier of the Amazon Q Business web experience being deleted.

    
    
• On success, responds with DeleteWebExperienceOutput
• On failure, responds with SdkError<DeleteWebExperienceError>

impl Client

pub fn disassociate_permission(&self) -> DisassociatePermissionFluentBuilder

Constructs a fluent builder for the DisassociatePermission operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application.

    
    
  • statement_id(impl Into<String>) / set_statement_id(Option<String>):
    required: true
    

    The statement ID of the permission to remove.

    
    
• On success, responds with DisassociatePermissionOutput
• On failure, responds with SdkError<DisassociatePermissionError>

impl Client

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: true
    

    The 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_type(Option<IdentityType>):

    The authentication type being used by a Amazon Q Business application.

  • iam_identity_provider_arn(Option<String>):

    The Amazon Resource Name (ARN) of an identity provider being used by an 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 to ERROR, the ErrorMessage 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.

  • q_apps_configuration(Option<QAppsConfiguration>):

    Settings for whether end users can create and use Amazon Q Apps in the web experience.

  • personalization_configuration(Option<PersonalizationConfiguration>):

    Configuration information about chat response personalization. For more information, see Personalizing chat responses.

  • auto_subscription_configuration(Option<AutoSubscriptionConfiguration>):

    Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

  • client_ids_for_oidc(Option<Vec::<String>>):

    The OIDC client ID for a Amazon Q Business application.

  • quick_sight_configuration(Option<QuickSightConfiguration>):

    The Amazon QuickSight authentication configuration for the Amazon Q Business application.

• On failure, responds with SdkError<GetApplicationError>

impl Client

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: true
    

    The identifier of the application for which the chat controls are configured.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of configured chat controls to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 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.

  • orchestration_configuration(Option<AppliedOrchestrationConfiguration>):

    The chat response orchestration settings for your application.

    Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.

  • 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.

  • hallucination_reduction_configuration(Option<HallucinationReductionConfiguration>):

    The hallucination reduction settings for your application.

• On failure, responds with SdkError<GetChatControlsConfigurationError>

impl Client

pub fn get_chat_response_configuration( &self, ) -> GetChatResponseConfigurationFluentBuilder

Constructs a fluent builder for the GetChatResponseConfiguration operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application containing the chat response configuration to retrieve.

    
    
  • chat_response_configuration_id(impl Into<String>) / set_chat_response_configuration_id(Option<String>):
    required: true
    

    The unique identifier of the chat response configuration to retrieve from the specified application.

    
    
• On success, responds with GetChatResponseConfigurationOutput with field(s):
  • chat_response_configuration_id(Option<String>):

    The unique identifier of the retrieved chat response configuration.

  • chat_response_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.

  • display_name(Option<String>):

    The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations.

  • created_at(Option<DateTime>):

    The timestamp indicating when the chat response configuration was initially created.

  • in_use_configuration(Option<ChatResponseConfigurationDetail>):

    The currently active configuration settings that are being used to generate responses in the Amazon Q Business application.

  • last_update_configuration(Option<ChatResponseConfigurationDetail>):

    Information about the most recent update to the configuration, including timestamp and modification details.

• On failure, responds with SdkError<GetChatResponseConfigurationError>

impl Client

pub fn get_data_accessor(&self) -> GetDataAccessorFluentBuilder

Constructs a fluent builder for the GetDataAccessor operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application.

    
    
  • data_accessor_id(impl Into<String>) / set_data_accessor_id(Option<String>):
    required: true
    

    The unique identifier of the data accessor to retrieve.

    
    
• On success, responds with GetDataAccessorOutput with field(s):
  • display_name(Option<String>):

    The friendly name of the data accessor.

  • data_accessor_id(Option<String>):

    The unique identifier of the data accessor.

  • data_accessor_arn(Option<String>):

    The Amazon Resource Name (ARN) of the data accessor.

  • application_id(Option<String>):

    The unique identifier of the Amazon Q Business application associated with this data accessor.

  • idc_application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor.

  • principal(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

  • action_configurations(Option<Vec::<ActionConfiguration>>):

    The list of action configurations specifying the allowed actions and any associated filters.

  • authentication_detail(Option<DataAccessorAuthenticationDetail>):

    The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.

  • created_at(Option<DateTime>):

    The timestamp when the data accessor was created.

  • updated_at(Option<DateTime>):

    The timestamp when the data accessor was last updated.

• On failure, responds with SdkError<GetDataAccessorError>

impl Client

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: true
    

    The identifier of the Amazon Q Business application.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identfier of the index used with the data source connector.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The 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 is FAILED, the ErrorMessage 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 is FAILED, the ErrorMessage 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.

  • media_extraction_configuration(Option<MediaExtractionConfiguration>):

    The configuration for extracting information from media in documents for the data source.

• On failure, responds with SdkError<GetDataSourceError>

impl Client

pub fn get_document_content(&self) -> GetDocumentContentFluentBuilder

Constructs a fluent builder for the GetDocumentContent operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the index where documents are indexed.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: false
    

    The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be “uploaded-docs-file-stat-datasourceid”.

    
    
  • document_id(impl Into<String>) / set_document_id(Option<String>):
    required: true
    

    The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.

    
    
  • output_format(OutputFormat) / set_output_format(Option<OutputFormat>):
    required: false
    

    Document outputFormat. Defaults to RAW if not selected.

    
    
• On success, responds with GetDocumentContentOutput with field(s):
  • presigned_url(String):

    A pre-signed URL that provides temporary access to download the document content directly from Amazon Q Business. The URL expires after 5 minutes for security purposes. This URL is generated only after successful ACL validation.

  • mime_type(String):

    The MIME type of the document content. When outputFormat is RAW, this corresponds to the original document’s MIME type (e.g., application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document). When outputFormat is EXTRACTED, the MIME type is always application/json.

• On failure, responds with SdkError<GetDocumentContentError>

impl Client

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: true
    

    The identifier of the application id the group is attached to.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the index the group is attached to.

    
    
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: true
    

    The name of the group.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: false
    

    The 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business application connected to the index.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The 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.

  • 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 the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

  • r#type(Option<IndexType>):

    The type of index attached to your Amazon Q Business application.

  • 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 is FAILED, the ErrorMessage 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>

impl Client

pub fn get_media(&self) -> GetMediaFluentBuilder

Constructs a fluent builder for the GetMedia operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business which contains the media object.

    
    
  • conversation_id(impl Into<String>) / set_conversation_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business conversation.

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business message.

    
    
  • media_id(impl Into<String>) / set_media_id(Option<String>):
    required: true
    

    The identifier of the media object. You can find this in the sourceAttributions returned by the Chat, ChatSync, and ListMessages API responses.

    
    
• On success, responds with GetMediaOutput with field(s):
  • media_bytes(Option<Blob>):

    The base64-encoded bytes of the media object.

  • media_mime_type(Option<String>):

    The MIME type of the media object (image/png).

• On failure, responds with SdkError<GetMediaError>

impl Client

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: true
    

    The identifier of the application which contains the plugin.

    
    
  • plugin_id(impl Into<String>) / set_plugin_id(Option<String>):
    required: true
    

    The 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>

impl Client

pub fn get_policy(&self) -> GetPolicyFluentBuilder

Constructs a fluent builder for the GetPolicy operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application.

    
    
• On success, responds with GetPolicyOutput with field(s):
  • policy(Option<String>):

    The JSON representation of the permission policy.

• On failure, responds with SdkError<GetPolicyError>

impl Client

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: true
    

    The identifier of the Amazon Q Business application using the retriever.

    
    
  • retriever_id(impl Into<String>) / set_retriever_id(Option<String>):
    required: true
    

    The 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>

impl Client

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: true
    

    The identifier of the application connected to the user.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The 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>

impl Client

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: true
    

    The 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: true
    

    The 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 is FAILED, the ErrorMessage 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.

  • origins(Option<Vec::<String>>):

    Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

  • role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

  • identity_provider_configuration(Option<IdentityProviderConfiguration>):

    Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business 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 is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

  • browser_extension_configuration(Option<BrowserExtensionConfiguration>):

    The browser extension configuration for an Amazon Q Business web experience.

  • customization_configuration(Option<CustomizationConfiguration>):

    Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.

• On failure, responds with SdkError<GetWebExperienceError>

impl Client

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: false
    

    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 applications.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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>

impl Client

pub fn list_attachments(&self) -> ListAttachmentsFluentBuilder

Constructs a fluent builder for the ListAttachments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier for the Amazon Q Business application.

    
    
  • conversation_id(impl Into<String>) / set_conversation_id(Option<String>):
    required: false
    

    The unique identifier of the Amazon Q Business web experience conversation.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The unique identifier of the user involved in the Amazon Q Business web experience conversation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the number of attachments returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of attachments.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of attachements to return.

    
    
• On success, responds with ListAttachmentsOutput with field(s):
  • attachments(Option<Vec::<Attachment>>):

    An array of information on one or more attachments.

  • 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 attachments.

• On failure, responds with SdkError<ListAttachmentsError>

impl Client

pub fn list_chat_response_configurations( &self, ) -> ListChatResponseConfigurationsFluentBuilder

Constructs a fluent builder for the ListChatResponseConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application for which to list available chat response configurations.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified maxResults value.

    
    
• On success, responds with ListChatResponseConfigurationsOutput with field(s):
  • chat_response_configurations(Option<Vec::<ChatResponseConfiguration>>):

    A list of chat response configuration summaries, each containing key information about an available configuration in the specified application.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent request to retrieve additional chat response configurations if the results were truncated due to the maxResults parameter.

• On failure, responds with SdkError<ListChatResponseConfigurationsError>

impl Client

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: true
    

    The identifier of the Amazon Q Business application.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The identifier of the user involved in the Amazon Q Business web experience conversation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 conversations.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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>

impl Client

pub fn list_data_accessors(&self) -> ListDataAccessorsFluentBuilder

Constructs a fluent builder for the ListDataAccessors operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListDataAccessorsOutput with field(s):
  • data_accessors(Option<Vec::<DataAccessor>>):

    The list of data accessors.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results, if there are any.

• On failure, responds with SdkError<ListDataAccessorsError>

impl Client

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: true
    

    The identifier of the data source connector.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business application connected to the data source.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the index used with the Amazon Q Business data source connector.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If 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: false
    

    The maximum number of synchronization jobs to return in the response.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The start time of the data source connector sync.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end time of the data source connector sync.

    
    
  • status_filter(DataSourceSyncJobStatus) / set_status_filter(Option<DataSourceSyncJobStatus>):
    required: false
    

    Only 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business application linked to the data source connectors.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the index used with one or more data source connectors.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 data source connectors.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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>

impl Client

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: true
    

    The identifier of the application id the documents are attached to.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the index the documents are attached to.

    
    
  • data_source_ids(impl Into<String>) / set_data_source_ids(Option<Vec::<String>>):
    required: false
    

    The identifier of the data sources the documents are attached to.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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>

impl Client

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: true
    

    The identifier of the application for getting a list of groups mapped to users.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the index for getting a list of groups mapped to users.

    
    
  • updated_earlier_than(DateTime) / set_updated_earlier_than(Option<DateTime>):
    required: true
    

    The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: false
    

    The 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: false
    

    If 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: false
    

    The 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business application connected to the index.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 indices.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business web experience conversation.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier for the Amazon Q Business application.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The identifier of the user involved in the Amazon Q Business web experience conversation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the number of messages 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: false
    

    The 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>

impl Client

pub fn list_plugin_actions(&self) -> ListPluginActionsFluentBuilder

Constructs a fluent builder for the ListPluginActions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business application the plugin is attached to.

    
    
  • plugin_id(impl Into<String>) / set_plugin_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business plugin.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the number of plugin actions returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of plugin actions to return.

    
    
• On success, responds with ListPluginActionsOutput 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 plugin actions.

  • items(Option<Vec::<ActionSummary>>):

    An array of information on one or more plugin actions.

• On failure, responds with SdkError<ListPluginActionsError>

impl Client

pub fn list_plugin_type_actions(&self) -> ListPluginTypeActionsFluentBuilder

Constructs a fluent builder for the ListPluginTypeActions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • plugin_type(PluginType) / set_plugin_type(Option<PluginType>):
    required: true
    

    The type of the plugin.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the number of plugins returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugins.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of plugins to return.

    
    
• On success, responds with ListPluginTypeActionsOutput 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 plugins.

  • items(Option<Vec::<ActionSummary>>):

    An array of information on one or more plugins.

• On failure, responds with SdkError<ListPluginTypeActionsError>

impl Client

pub fn list_plugin_type_metadata(&self) -> ListPluginTypeMetadataFluentBuilder

Constructs a fluent builder for the ListPluginTypeMetadata operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the metadata returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of plugin metadata items to return.

    
    
• On success, responds with ListPluginTypeMetadataOutput 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 plugin metadata.

  • items(Option<Vec::<PluginTypeMetadataSummary>>):

    An array of information on plugin metadata.

• On failure, responds with SdkError<ListPluginTypeMetadataError>

impl Client

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: true
    

    The identifier of the application the plugin is attached to.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business application using the retriever.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If 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: false
    

    The 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>

impl Client

pub fn list_subscriptions(&self) -> ListSubscriptionsFluentBuilder

Constructs a fluent builder for the ListSubscriptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business application linked to the subscription.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 subscriptions.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of Amazon Q Business subscriptions to return.

    
    
• On success, responds with ListSubscriptionsOutput 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 subscriptions.

  • subscriptions(Option<Vec::<Subscription>>):

    An array of summary information on the subscriptions configured for an Amazon Q Business application.

• On failure, responds with SdkError<ListSubscriptionsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business application linked to the listed web experiences.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 conversations.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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>

impl Client

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: true
    

    The identifier of the application associated with the feedback.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The identifier of the user giving the feedback.

    
    
  • conversation_id(impl Into<String>) / set_conversation_id(Option<String>):
    required: true
    

    The identifier of the conversation the feedback is attached to.

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The identifier of the chat message that the feedback was given for.

    
    
  • message_copied_at(DateTime) / set_message_copied_at(Option<DateTime>):
    required: false
    

    The timestamp for when the feedback was recorded.

    
    
  • message_usefulness(MessageUsefulnessFeedback) / set_message_usefulness(Option<MessageUsefulnessFeedback>):
    required: false
    

    The feedback usefulness value given by the user to the chat message.

    
    
• On success, responds with PutFeedbackOutput
• On failure, responds with SdkError<PutFeedbackError>

impl Client

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: true
    

    The identifier of the application in which the user and group mapping belongs.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The 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: true
    

    The 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”.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: false
    

    The 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: true
    

    The type of the group.

    
    
  • group_members(GroupMembers) / set_group_members(Option<GroupMembers>):
    required: true
    

    A 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.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

    
    
• On success, responds with PutGroupOutput
• On failure, responds with SdkError<PutGroupError>

impl Client

pub fn search_relevant_content(&self) -> SearchRelevantContentFluentBuilder

Constructs a fluent builder for the SearchRelevantContent operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application to search.

    
    
  • query_text(impl Into<String>) / set_query_text(Option<String>):
    required: true
    

    The text to search for.

    
    
  • content_source(ContentSource) / set_content_source(Option<ContentSource>):
    required: true
    

    The source of content to search in.

    
    
  • attribute_filter(AttributeFilter) / set_attribute_filter(Option<AttributeFilter>):
    required: false
    

    Enables filtering of responses based on document attributes or metadata fields.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. (You received this token from a previous call.)

    
    
• On success, responds with SearchRelevantContentOutput with field(s):
  • relevant_content(Option<Vec::<RelevantContent>>):

    The list of relevant content items found.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results, if there are any.

• On failure, responds with SdkError<SearchRelevantContentError>

impl Client

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: true
    

    The identifier of the data source connector.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of Amazon Q Business application the data source is connected to.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The 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>

impl Client

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: true
    

    The identifier of the data source connector.

    
    
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The 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: true
    

    The identifier of the index used with the Amazon Q Business data source connector.

    
    
• On success, responds with StopDataSourceSyncJobOutput
• On failure, responds with SdkError<StopDataSourceSyncJobError>

impl Client

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: true
    

    The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    A 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>

impl Client

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: true
    

    The 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: true
    

    A 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>

impl Client

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: true
    

    The identifier of the Amazon Q Business application.

    
    
  • identity_center_instance_arn(impl Into<String>) / set_identity_center_instance_arn(Option<String>):
    required: false
    

    The 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: false
    

    A name for the Amazon Q Business application.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the Amazon Q Business application.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    An 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: false
    

    An option to allow end users to upload files directly during chat.

    
    
  • q_apps_configuration(QAppsConfiguration) / set_q_apps_configuration(Option<QAppsConfiguration>):
    required: false
    

    An option to allow end users to create and use Amazon Q Apps in the web experience.

    
    
  • personalization_configuration(PersonalizationConfiguration) / set_personalization_configuration(Option<PersonalizationConfiguration>):
    required: false
    

    Configuration information about chat response personalization. For more information, see Personalizing chat responses.

    
    
  • auto_subscription_configuration(AutoSubscriptionConfiguration) / set_auto_subscription_configuration(Option<AutoSubscriptionConfiguration>):
    required: false
    

    An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.

    
    
• On success, responds with UpdateApplicationOutput
• On failure, responds with SdkError<UpdateApplicationError>

impl Client

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: true
    

    The identifier of the application for which the chat controls are configured.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A 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: false
    

    The 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.

    
    
  • orchestration_configuration(OrchestrationConfiguration) / set_orchestration_configuration(Option<OrchestrationConfiguration>):
    required: false
    

    The chat response orchestration settings for your application.

    
    
  • blocked_phrases_configuration_update(BlockedPhrasesConfigurationUpdate) / set_blocked_phrases_configuration_update(Option<BlockedPhrasesConfigurationUpdate>):
    required: false
    

    The 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: false
    

    The configured topic specific chat controls you want to update.

    
    
  • topic_configurations_to_delete(TopicConfiguration) / set_topic_configurations_to_delete(Option<Vec::<TopicConfiguration>>):
    required: false
    

    The configured topic specific chat controls you want to delete.

    
    
  • creator_mode_configuration(CreatorModeConfiguration) / set_creator_mode_configuration(Option<CreatorModeConfiguration>):
    required: false
    

    The configuration details for CREATOR_MODE.

    
    
  • hallucination_reduction_configuration(HallucinationReductionConfiguration) / set_hallucination_reduction_configuration(Option<HallucinationReductionConfiguration>):
    required: false
    

    The hallucination reduction settings for your application.

    
    
• On success, responds with UpdateChatControlsConfigurationOutput
• On failure, responds with SdkError<UpdateChatControlsConfigurationError>

impl Client

pub fn update_chat_response_configuration( &self, ) -> UpdateChatResponseConfigurationFluentBuilder

Constructs a fluent builder for the UpdateChatResponseConfiguration operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application containing the chat response configuration to update.

    
    
  • chat_response_configuration_id(impl Into<String>) / set_chat_response_configuration_id(Option<String>):
    required: true
    

    The unique identifier of the chat response configuration to update within the specified application.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations.

    
    
  • response_configurations(ResponseConfigurationType, ResponseConfiguration) / set_response_configurations(Option<HashMap::<ResponseConfigurationType, ResponseConfiguration>>):
    required: true
    

    The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur.

    
    
• On success, responds with UpdateChatResponseConfigurationOutput
• On failure, responds with SdkError<UpdateChatResponseConfigurationError>

impl Client

pub fn update_data_accessor(&self) -> UpdateDataAccessorFluentBuilder

Constructs a fluent builder for the UpdateDataAccessor operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The unique identifier of the Amazon Q Business application.

    
    
  • data_accessor_id(impl Into<String>) / set_data_accessor_id(Option<String>):
    required: true
    

    The unique identifier of the data accessor to update.

    
    
  • action_configurations(ActionConfiguration) / set_action_configurations(Option<Vec::<ActionConfiguration>>):
    required: true
    

    The updated list of action configurations specifying the allowed actions and any associated filters.

    
    
  • authentication_detail(DataAccessorAuthenticationDetail) / set_authentication_detail(Option<DataAccessorAuthenticationDetail>):
    required: false
    

    The updated authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The updated friendly name for the data accessor.

    
    
• On success, responds with UpdateDataAccessorOutput
• On failure, responds with SdkError<UpdateDataAccessorError>

impl Client

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: true
    

    The identifier of the Amazon Q Business application the data source is attached to.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the index attached to the data source connector.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The identifier of the data source connector.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    A name of the data source connector.

    
    
  • configuration(Document) / set_configuration(Option<Document>):
    required: false
    

    Provides the configuration information for an Amazon Q Business data source.

    
    
  • vpc_configuration(DataSourceVpcConfiguration) / set_vpc_configuration(Option<DataSourceVpcConfiguration>):
    required: false
    

    Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the data source connector.

    
    
  • sync_schedule(impl Into<String>) / set_sync_schedule(Option<String>):
    required: false
    

    The chosen update frequency for your data source.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The 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: false
    

    Provides the configuration information for altering document metadata and content during the document ingestion process.

    For more information, see Custom document enrichment.

    
    
  • media_extraction_configuration(MediaExtractionConfiguration) / set_media_extraction_configuration(Option<MediaExtractionConfiguration>):
    required: false
    

    The configuration for extracting information from media in documents for your data source.

    
    
• On success, responds with UpdateDataSourceOutput
• On failure, responds with SdkError<UpdateDataSourceError>

impl Client

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: true
    

    The identifier of the Amazon Q Business application connected to the index.

    
    
  • index_id(impl Into<String>) / set_index_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business index.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The name of the Amazon Q Business index.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the Amazon Q Business index.

    
    
  • capacity_configuration(IndexCapacityConfiguration) / set_capacity_configuration(Option<IndexCapacityConfiguration>):
    required: false
    

    The 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: false
    

    Configuration 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>

impl Client

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: true
    

    The identifier of the application the plugin is attached to.

    
    
  • plugin_id(impl Into<String>) / set_plugin_id(Option<String>):
    required: true
    

    The identifier of the plugin.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The name of the plugin.

    
    
  • state(PluginState) / set_state(Option<PluginState>):
    required: false
    

    The status of the plugin.

    
    
  • server_url(impl Into<String>) / set_server_url(Option<String>):
    required: false
    

    The source URL used for plugin configuration.

    
    
  • custom_plugin_configuration(CustomPluginConfiguration) / set_custom_plugin_configuration(Option<CustomPluginConfiguration>):
    required: false
    

    The configuration for a custom plugin.

    
    
  • auth_configuration(PluginAuthConfiguration) / set_auth_configuration(Option<PluginAuthConfiguration>):
    required: false
    

    The authentication configuration the plugin is using.

    
    
• On success, responds with UpdatePluginOutput
• On failure, responds with SdkError<UpdatePluginError>

impl Client

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: true
    

    The identifier of your Amazon Q Business application.

    
    
  • retriever_id(impl Into<String>) / set_retriever_id(Option<String>):
    required: true
    

    The identifier of your retriever.

    
    
  • configuration(RetrieverConfiguration) / set_configuration(Option<RetrieverConfiguration>):
    required: false
    

    Provides 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: false
    

    The name of your retriever.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The 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>

impl Client

pub fn update_subscription(&self) -> UpdateSubscriptionFluentBuilder

Constructs a fluent builder for the UpdateSubscription operation.

• The fluent builder is configurable:
  • application_id(impl Into<String>) / set_application_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business application where the subscription update should take effect.

    
    
  • subscription_id(impl Into<String>) / set_subscription_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q Business subscription to be updated.

    
    
  • r#type(SubscriptionType) / set_type(Option<SubscriptionType>):
    required: true
    

    The type of the Amazon Q Business subscription to be updated.

    
    
• On success, responds with UpdateSubscriptionOutput with field(s):
  • subscription_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.

  • current_subscription(Option<SubscriptionDetails>):

    The type of your current Amazon Q Business subscription.

  • next_subscription(Option<SubscriptionDetails>):

    The type of the Amazon Q Business subscription for the next month.

• On failure, responds with SdkError<UpdateSubscriptionError>

impl Client

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: true
    

    The identifier of the application the user is attached to.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The email id attached to the user.

    
    
  • user_aliases_to_update(UserAlias) / set_user_aliases_to_update(Option<Vec::<UserAlias>>):
    required: false
    

    The 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: false
    

    The 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>

impl Client

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: true
    

    The 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: true
    

    The identifier of the Amazon Q Business web experience.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The 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: false
    

    The authentication configuration of the Amazon Q Business web experience.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: false
    

    The title of the Amazon Q Business web experience.

    
    
  • subtitle(impl Into<String>) / set_subtitle(Option<String>):
    required: false
    

    The subtitle of the Amazon Q Business web experience.

    
    
  • welcome_message(impl Into<String>) / set_welcome_message(Option<String>):
    required: false
    

    A 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: false
    

    Determines whether sample prompts are enabled in the web experience for an end user.

    
    
  • identity_provider_configuration(IdentityProviderConfiguration) / set_identity_provider_configuration(Option<IdentityProviderConfiguration>):
    required: false
    

    Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

    
    
  • origins(impl Into<String>) / set_origins(Option<Vec::<String>>):
    required: false
    

    Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

    • Any values except null submitted as part of this update will replace all previous values.

    • You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

    
    
  • browser_extension_configuration(BrowserExtensionConfiguration) / set_browser_extension_configuration(Option<BrowserExtensionConfiguration>):
    required: false
    

    The browser extension configuration for an Amazon Q Business web experience.

    For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

    
    
  • customization_configuration(CustomizationConfiguration) / set_customization_configuration(Option<CustomizationConfiguration>):
    required: false
    

    Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.

    
    
• On success, responds with UpdateWebExperienceOutput
• On failure, responds with SdkError<UpdateWebExperienceError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.