Struct aws_sdk_qconnect::Client

pub struct Client { /* private fields */ }

Client for Amazon Q Connect

Client for invoking operations on Amazon Q Connect. Each operation on Amazon Q Connect 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_qconnect::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_qconnect::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 ListTagsForResource operation has a Client::list_tags_for_resource, 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.list_tags_for_resource()
    .resource_arn("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 create_assistant(&self) -> CreateAssistantFluentBuilder

Constructs a fluent builder for the CreateAssistant operation.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the assistant.

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

    The type of assistant.

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

    The description of the assistant.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):
    required: false
    

    The configuration information for the customer managed key used for encryption.

    The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

    
    
• On success, responds with CreateAssistantOutput with field(s):
  • assistant(Option<AssistantData>):

    Information about the assistant.

• On failure, responds with SdkError<CreateAssistantError>

impl Client

pub fn create_assistant_association( &self ) -> CreateAssistantAssociationFluentBuilder

Constructs a fluent builder for the CreateAssistantAssociation operation.

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

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • association_type(AssociationType) / set_association_type(Option<AssociationType>):
    required: true
    

    The type of association.

    
    
  • association(AssistantAssociationInputData) / set_association(Option<AssistantAssociationInputData>):
    required: true
    

    The identifier of the associated resource.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateAssistantAssociationOutput with field(s):
  • assistant_association(Option<AssistantAssociationData>):

    The assistant association.

• On failure, responds with SdkError<CreateAssistantAssociationError>

impl Client

pub fn create_content(&self) -> CreateContentFluentBuilder

Constructs a fluent builder for the CreateContent operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.

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

    The title of the content. If not set, the title is equal to the name.

    
    
  • override_link_out_uri(impl Into<String>) / set_override_link_out_uri(Option<String>):
    required: false
    

    The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.

    
    
  • metadata(impl Into<String>, impl Into<String>) / set_metadata(Option<HashMap::<String, String>>):
    required: false
    

    A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

    
    
  • upload_id(impl Into<String>) / set_upload_id(Option<String>):
    required: true
    

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateContentOutput with field(s):
  • content(Option<ContentData>):

    The content.

• On failure, responds with SdkError<CreateContentError>

impl Client

pub fn create_knowledge_base(&self) -> CreateKnowledgeBaseFluentBuilder

Constructs a fluent builder for the CreateKnowledgeBase operation.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the knowledge base.

    
    
  • knowledge_base_type(KnowledgeBaseType) / set_knowledge_base_type(Option<KnowledgeBaseType>):
    required: true
    

    The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    
    
  • source_configuration(SourceConfiguration) / set_source_configuration(Option<SourceConfiguration>):
    required: false
    

    The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

    
    
  • rendering_configuration(RenderingConfiguration) / set_rendering_configuration(Option<RenderingConfiguration>):
    required: false
    

    Information about how to render the content.

    
    
  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):
    required: false
    

    The configuration information for the customer managed key used for encryption.

    This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q.

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

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

    The description.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateKnowledgeBaseOutput with field(s):
  • knowledge_base(Option<KnowledgeBaseData>):

    The knowledge base.

• On failure, responds with SdkError<CreateKnowledgeBaseError>

impl Client

pub fn create_quick_response(&self) -> CreateQuickResponseFluentBuilder

Constructs a fluent builder for the CreateQuickResponse operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the quick response.

    
    
  • content(QuickResponseDataProvider) / set_content(Option<QuickResponseDataProvider>):
    required: true
    

    The content of the quick response.

    
    
  • content_type(impl Into<String>) / set_content_type(Option<String>):
    required: false
    

    The media type of the quick response content.

    • Use application/x.quickresponse;format=plain for a quick response written in plain text.

    • Use application/x.quickresponse;format=markdown for a quick response written in richtext.

    
    
  • grouping_configuration(GroupingConfiguration) / set_grouping_configuration(Option<GroupingConfiguration>):
    required: false
    

    The configuration information of the user groups that the quick response is accessible to.

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

    The description of the quick response.

    
    
  • shortcut_key(impl Into<String>) / set_shortcut_key(Option<String>):
    required: false
    

    The shortcut key of the quick response. The value should be unique across the knowledge base.

    
    
  • is_active(bool) / set_is_active(Option<bool>):
    required: false
    

    Whether the quick response is active.

    
    
  • channels(impl Into<String>) / set_channels(Option<Vec::<String>>):
    required: false
    

    The Amazon Connect channels this quick response applies to.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateQuickResponseOutput with field(s):
  • quick_response(Option<QuickResponseData>):

    The quick response.

• On failure, responds with SdkError<CreateQuickResponseError>

impl Client

pub fn create_session(&self) -> CreateSessionFluentBuilder

Constructs a fluent builder for the CreateSession operation.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • assistant_id(impl Into<String>) / set_assistant_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the session.

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

    The description.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateSessionOutput with field(s):
  • session(Option<SessionData>):

    The session.

• On failure, responds with SdkError<CreateSessionError>

impl Client

pub fn delete_assistant(&self) -> DeleteAssistantFluentBuilder

Constructs a fluent builder for the DeleteAssistant operation.

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

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with DeleteAssistantOutput
• On failure, responds with SdkError<DeleteAssistantError>

impl Client

pub fn delete_assistant_association( &self ) -> DeleteAssistantAssociationFluentBuilder

Constructs a fluent builder for the DeleteAssistantAssociation operation.

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

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • assistant_id(impl Into<String>) / set_assistant_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with DeleteAssistantAssociationOutput
• On failure, responds with SdkError<DeleteAssistantAssociationError>

impl Client

pub fn delete_content(&self) -> DeleteContentFluentBuilder

Constructs a fluent builder for the DeleteContent operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • content_id(impl Into<String>) / set_content_id(Option<String>):
    required: true
    

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with DeleteContentOutput
• On failure, responds with SdkError<DeleteContentError>

impl Client

pub fn delete_import_job(&self) -> DeleteImportJobFluentBuilder

Constructs a fluent builder for the DeleteImportJob operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it.

    
    
  • import_job_id(impl Into<String>) / set_import_job_id(Option<String>):
    required: true
    

    The identifier of the import job to be deleted.

    
    
• On success, responds with DeleteImportJobOutput
• On failure, responds with SdkError<DeleteImportJobError>

impl Client

pub fn delete_knowledge_base(&self) -> DeleteKnowledgeBaseFluentBuilder

Constructs a fluent builder for the DeleteKnowledgeBase operation.

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

    The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with DeleteKnowledgeBaseOutput
• On failure, responds with SdkError<DeleteKnowledgeBaseError>

impl Client

pub fn delete_quick_response(&self) -> DeleteQuickResponseFluentBuilder

Constructs a fluent builder for the DeleteQuickResponse operation.

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

    The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it.

    
    
  • quick_response_id(impl Into<String>) / set_quick_response_id(Option<String>):
    required: true
    

    The identifier of the quick response to delete.

    
    
• On success, responds with DeleteQuickResponseOutput
• On failure, responds with SdkError<DeleteQuickResponseError>

impl Client

pub fn get_assistant(&self) -> GetAssistantFluentBuilder

Constructs a fluent builder for the GetAssistant operation.

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

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with GetAssistantOutput with field(s):
  • assistant(Option<AssistantData>):

    Information about the assistant.

• On failure, responds with SdkError<GetAssistantError>

impl Client

pub fn get_assistant_association(&self) -> GetAssistantAssociationFluentBuilder

Constructs a fluent builder for the GetAssistantAssociation operation.

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

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • assistant_id(impl Into<String>) / set_assistant_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with GetAssistantAssociationOutput with field(s):
  • assistant_association(Option<AssistantAssociationData>):

    The assistant association.

• On failure, responds with SdkError<GetAssistantAssociationError>

impl Client

pub fn get_content(&self) -> GetContentFluentBuilder

Constructs a fluent builder for the GetContent operation.

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

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with GetContentOutput with field(s):
  • content(Option<ContentData>):

    The content.

• On failure, responds with SdkError<GetContentError>

impl Client

pub fn get_content_summary(&self) -> GetContentSummaryFluentBuilder

Constructs a fluent builder for the GetContentSummary operation.

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

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with GetContentSummaryOutput with field(s):
  • content_summary(Option<ContentSummary>):

    The content summary.

• On failure, responds with SdkError<GetContentSummaryError>

impl Client

pub fn get_import_job(&self) -> GetImportJobFluentBuilder

Constructs a fluent builder for the GetImportJob operation.

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

    The identifier of the import job to retrieve.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The identifier of the knowledge base that the import job belongs to.

    
    
• On success, responds with GetImportJobOutput with field(s):
  • import_job(Option<ImportJobData>):

    The import job.

• On failure, responds with SdkError<GetImportJobError>

impl Client

pub fn get_knowledge_base(&self) -> GetKnowledgeBaseFluentBuilder

Constructs a fluent builder for the GetKnowledgeBase operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with GetKnowledgeBaseOutput with field(s):
  • knowledge_base(Option<KnowledgeBaseData>):

    The knowledge base.

• On failure, responds with SdkError<GetKnowledgeBaseError>

impl Client

pub fn get_quick_response(&self) -> GetQuickResponseFluentBuilder

Constructs a fluent builder for the GetQuickResponse operation.

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

    The identifier of the quick response.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

    
    
• On success, responds with GetQuickResponseOutput with field(s):
  • quick_response(Option<QuickResponseData>):

    The quick response.

• On failure, responds with SdkError<GetQuickResponseError>

impl Client

pub fn get_recommendations(&self) -> GetRecommendationsFluentBuilder

Constructs a fluent builder for the GetRecommendations operation.

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

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

    The maximum number of results to return per page.

    
    
  • wait_time_seconds(i32) / set_wait_time_seconds(Option<i32>):
    required: false
    

    The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

    
    
• On success, responds with GetRecommendationsOutput with field(s):
  • recommendations(Vec::<RecommendationData>):

    The recommendations.

  • triggers(Option<Vec::<RecommendationTrigger>>):

    The triggers corresponding to recommendations.

• On failure, responds with SdkError<GetRecommendationsError>

impl Client

pub fn get_session(&self) -> GetSessionFluentBuilder

Constructs a fluent builder for the GetSession operation.

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

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with GetSessionOutput with field(s):
  • session(Option<SessionData>):

    The session.

• On failure, responds with SdkError<GetSessionError>

impl Client

pub fn list_assistant_associations( &self ) -> ListAssistantAssociationsFluentBuilder

Constructs a fluent builder for the ListAssistantAssociations 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
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • assistant_id(impl Into<String>) / set_assistant_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with ListAssistantAssociationsOutput with field(s):
  • assistant_association_summaries(Vec::<AssistantAssociationSummary>):

    Summary information about assistant associations.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListAssistantAssociationsError>

impl Client

pub fn list_assistants(&self) -> ListAssistantsFluentBuilder

Constructs a fluent builder for the ListAssistants 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
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
• On success, responds with ListAssistantsOutput with field(s):
  • assistant_summaries(Vec::<AssistantSummary>):

    Information about the assistants.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListAssistantsError>

impl Client

pub fn list_contents(&self) -> ListContentsFluentBuilder

Constructs a fluent builder for the ListContents 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
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with ListContentsOutput with field(s):
  • content_summaries(Vec::<ContentSummary>):

    Information about the content.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListContentsError>

impl Client

pub fn list_import_jobs(&self) -> ListImportJobsFluentBuilder

Constructs a fluent builder for the ListImportJobs 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
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with ListImportJobsOutput with field(s):
  • import_job_summaries(Vec::<ImportJobSummary>):

    Summary information about the import jobs.

  • next_token(Option<String>):

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

• On failure, responds with SdkError<ListImportJobsError>

impl Client

pub fn list_knowledge_bases(&self) -> ListKnowledgeBasesFluentBuilder

Constructs a fluent builder for the ListKnowledgeBases 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
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
• On success, responds with ListKnowledgeBasesOutput with field(s):
  • knowledge_base_summaries(Vec::<KnowledgeBaseSummary>):

    Information about the knowledge bases.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListKnowledgeBasesError>

impl Client

pub fn list_quick_responses(&self) -> ListQuickResponsesFluentBuilder

Constructs a fluent builder for the ListQuickResponses 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
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with ListQuickResponsesOutput with field(s):
  • quick_response_summaries(Vec::<QuickResponseSummary>):

    Summary information about the quick responses.

  • next_token(Option<String>):

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

• On failure, responds with SdkError<ListQuickResponsesError>

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

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn notify_recommendations_received( &self ) -> NotifyRecommendationsReceivedFluentBuilder

Constructs a fluent builder for the NotifyRecommendationsReceived operation.

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

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • recommendation_ids(impl Into<String>) / set_recommendation_ids(Option<Vec::<String>>):
    required: true
    

    The identifiers of the recommendations.

    
    
• On success, responds with NotifyRecommendationsReceivedOutput with field(s):
  • recommendation_ids(Option<Vec::<String>>):

    The identifiers of the recommendations.

  • errors(Option<Vec::<NotifyRecommendationsReceivedError>>):

    The identifiers of recommendations that are causing errors.

• On failure, responds with SdkError<NotifyRecommendationsReceivedError>

impl Client

pub fn query_assistant(&self) -> QueryAssistantFluentBuilder

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

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

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

    The text to search for.

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: false
    

    The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • query_condition(QueryCondition) / set_query_condition(Option<Vec::<QueryCondition>>):
    required: false
    

    Information about how to query content.

    
    
• On success, responds with QueryAssistantOutput with field(s):
  • results(Vec::<ResultData>):

    The results of the query.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<QueryAssistantError>

impl Client

pub fn remove_knowledge_base_template_uri( &self ) -> RemoveKnowledgeBaseTemplateUriFluentBuilder

Constructs a fluent builder for the RemoveKnowledgeBaseTemplateUri operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
• On success, responds with RemoveKnowledgeBaseTemplateUriOutput
• On failure, responds with SdkError<RemoveKnowledgeBaseTemplateUriError>

impl Client

pub fn search_content(&self) -> SearchContentFluentBuilder

Constructs a fluent builder for the SearchContent 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
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • search_expression(SearchExpression) / set_search_expression(Option<SearchExpression>):
    required: true
    

    The search expression to filter results.

    
    
• On success, responds with SearchContentOutput with field(s):
  • content_summaries(Vec::<ContentSummary>):

    Summary information about the content.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<SearchContentError>

impl Client

pub fn search_quick_responses(&self) -> SearchQuickResponsesFluentBuilder

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

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

    The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • search_expression(QuickResponseSearchExpression) / set_search_expression(Option<QuickResponseSearchExpression>):
    required: true
    

    The search expression for querying the quick response.

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

    
    
• On success, responds with SearchQuickResponsesOutput with field(s):
  • results(Vec::<QuickResponseSearchResultData>):

    The results of the quick response search.

  • next_token(Option<String>):

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

• On failure, responds with SdkError<SearchQuickResponsesError>

impl Client

pub fn search_sessions(&self) -> SearchSessionsFluentBuilder

Constructs a fluent builder for the SearchSessions 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
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • assistant_id(impl Into<String>) / set_assistant_id(Option<String>):
    required: true
    

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • search_expression(SearchExpression) / set_search_expression(Option<SearchExpression>):
    required: true
    

    The search expression to filter results.

    
    
• On success, responds with SearchSessionsOutput with field(s):
  • session_summaries(Vec::<SessionSummary>):

    Summary information about the sessions.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<SearchSessionsError>

impl Client

pub fn start_content_upload(&self) -> StartContentUploadFluentBuilder

Constructs a fluent builder for the StartContentUpload operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • content_type(impl Into<String>) / set_content_type(Option<String>):
    required: true
    

    The type of content to upload.

    
    
  • presigned_url_time_to_live(i32) / set_presigned_url_time_to_live(Option<i32>):
    required: false
    

    The expected expiration time of the generated presigned URL, specified in minutes.

    
    
• On success, responds with StartContentUploadOutput with field(s):
  • upload_id(String):

    The identifier of the upload.

  • url(String):

    The URL of the upload.

  • url_expiry(DateTime):

    The expiration time of the URL as an epoch timestamp.

  • headers_to_include(HashMap::<String, String>):

    The headers to include in the upload.

• On failure, responds with SdkError<StartContentUploadError>

impl Client

pub fn start_import_job(&self) -> StartImportJobFluentBuilder

Constructs a fluent builder for the StartImportJob operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    • For importing Amazon Q quick responses, this should be a QUICK_RESPONSES type knowledge base.

    
    
  • import_job_type(ImportJobType) / set_import_job_type(Option<ImportJobType>):
    required: true
    

    The type of the import job.

    • For importing quick response resource, set the value to QUICK_RESPONSES.

    
    
  • upload_id(impl Into<String>) / set_upload_id(Option<String>):
    required: true
    

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

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

    The tags used to organize, track, or control access for this resource.

    
    
  • metadata(impl Into<String>, impl Into<String>) / set_metadata(Option<HashMap::<String, String>>):
    required: false
    

    The metadata fields of the imported Amazon Q resources.

    
    
  • external_source_configuration(ExternalSourceConfiguration) / set_external_source_configuration(Option<ExternalSourceConfiguration>):
    required: false
    

    The configuration information of the external source that the resource data are imported from.

    
    
• On success, responds with StartImportJobOutput with field(s):
  • import_job(Option<ImportJobData>):

    The import job.

• On failure, responds with SdkError<StartImportJobError>

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags used to organize, track, or control access for this resource.

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

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_content(&self) -> UpdateContentFluentBuilder

Constructs a fluent builder for the UpdateContent operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN

    
    
  • content_id(impl Into<String>) / set_content_id(Option<String>):
    required: true
    

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • revision_id(impl Into<String>) / set_revision_id(Option<String>):
    required: false
    

    The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.

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

    The title of the content.

    
    
  • override_link_out_uri(impl Into<String>) / set_override_link_out_uri(Option<String>):
    required: false
    

    The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.

    
    
  • remove_override_link_out_uri(bool) / set_remove_override_link_out_uri(Option<bool>):
    required: false
    

    Unset the existing overrideLinkOutUri if it exists.

    
    
  • metadata(impl Into<String>, impl Into<String>) / set_metadata(Option<HashMap::<String, String>>):
    required: false
    

    A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

    
    
  • upload_id(impl Into<String>) / set_upload_id(Option<String>):
    required: false
    

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

    
    
• On success, responds with UpdateContentOutput with field(s):
  • content(Option<ContentData>):

    The content.

• On failure, responds with SdkError<UpdateContentError>

impl Client

pub fn update_knowledge_base_template_uri( &self ) -> UpdateKnowledgeBaseTemplateUriFluentBuilder

Constructs a fluent builder for the UpdateKnowledgeBaseTemplateUri operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • template_uri(impl Into<String>) / set_template_uri(Option<String>):
    required: true
    

    The template URI to update.

    
    
• On success, responds with UpdateKnowledgeBaseTemplateUriOutput with field(s):
  • knowledge_base(Option<KnowledgeBaseData>):

    The knowledge base to update.

• On failure, responds with SdkError<UpdateKnowledgeBaseTemplateUriError>

impl Client

pub fn update_quick_response(&self) -> UpdateQuickResponseFluentBuilder

Constructs a fluent builder for the UpdateQuickResponse operation.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    
    
  • quick_response_id(impl Into<String>) / set_quick_response_id(Option<String>):
    required: true
    

    The identifier of the quick response.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the quick response.

    
    
  • content(QuickResponseDataProvider) / set_content(Option<QuickResponseDataProvider>):
    required: false
    

    The updated content of the quick response.

    
    
  • content_type(impl Into<String>) / set_content_type(Option<String>):
    required: false
    

    The media type of the quick response content.

    • Use application/x.quickresponse;format=plain for quick response written in plain text.

    • Use application/x.quickresponse;format=markdown for quick response written in richtext.

    
    
  • grouping_configuration(GroupingConfiguration) / set_grouping_configuration(Option<GroupingConfiguration>):
    required: false
    

    The updated grouping configuration of the quick response.

    
    
  • remove_grouping_configuration(bool) / set_remove_grouping_configuration(Option<bool>):
    required: false
    

    Whether to remove the grouping configuration of the quick response.

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

    The updated description of the quick response.

    
    
  • remove_description(bool) / set_remove_description(Option<bool>):
    required: false
    

    Whether to remove the description from the quick response.

    
    
  • shortcut_key(impl Into<String>) / set_shortcut_key(Option<String>):
    required: false
    

    The shortcut key of the quick response. The value should be unique across the knowledge base.

    
    
  • remove_shortcut_key(bool) / set_remove_shortcut_key(Option<bool>):
    required: false
    

    Whether to remove the shortcut key of the quick response.

    
    
  • is_active(bool) / set_is_active(Option<bool>):
    required: false
    

    Whether the quick response is active.

    
    
  • channels(impl Into<String>) / set_channels(Option<Vec::<String>>):
    required: false
    

    The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

    
    
• On success, responds with UpdateQuickResponseOutput with field(s):
  • quick_response(Option<QuickResponseData>):

    The quick response.

• On failure, responds with SdkError<UpdateQuickResponseError>

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