Struct aws_sdk_wisdom::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon Connect Wisdom Service
Client for invoking operations on Amazon Connect Wisdom Service. Each operation on Amazon Connect Wisdom Service 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_wisdom::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_wisdom::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§
source§impl Client
impl Client
sourcepub fn create_assistant(&self) -> CreateAssistantFluentBuilder
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>)
: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>)
:The name of the assistant.
r#type(AssistantType)
/set_type(Option<AssistantType>)
:The type of assistant.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the assistant.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
server_side_encryption_configuration(ServerSideEncryptionConfiguration)
/set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>)
:The KMS key used for encryption.
- On success, responds with
CreateAssistantOutput
with field(s):assistant(Option<AssistantData>)
:Information about the assistant.
- On failure, responds with
SdkError<CreateAssistantError>
source§impl Client
impl Client
sourcepub fn create_assistant_association(
&self
) -> CreateAssistantAssociationFluentBuilder
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>)
:The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
association_type(AssociationType)
/set_association_type(Option<AssociationType>)
:The type of association.
association(AssistantAssociationInputData)
/set_association(Option<AssistantAssociationInputData>)
:The identifier of the associated resource.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap<String, String>>)
: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>
source§impl Client
impl Client
sourcepub fn create_content(&self) -> CreateContentFluentBuilder
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>)
:The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
name(impl Into<String>)
/set_name(Option<String>)
: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>)
: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>)
: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>>)
:A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
upload_id(impl Into<String>)
/set_upload_id(Option<String>)
:A pointer to the uploaded asset. This value is returned by StartContentUpload.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap<String, String>>)
: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>
source§impl Client
impl Client
sourcepub fn create_knowledge_base(&self) -> CreateKnowledgeBaseFluentBuilder
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>)
: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>)
:The name of the knowledge base.
knowledge_base_type(KnowledgeBaseType)
/set_knowledge_base_type(Option<KnowledgeBaseType>)
: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>)
:The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
rendering_configuration(RenderingConfiguration)
/set_rendering_configuration(Option<RenderingConfiguration>)
:Information about how to render the content.
server_side_encryption_configuration(ServerSideEncryptionConfiguration)
/set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>)
:The KMS key used for encryption.
description(impl Into<String>)
/set_description(Option<String>)
:The description.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap<String, String>>)
: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>
source§impl Client
impl Client
sourcepub fn create_session(&self) -> CreateSessionFluentBuilder
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>)
: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>)
:The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the session.
description(impl Into<String>)
/set_description(Option<String>)
:The description.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap<String, String>>)
: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>
source§impl Client
impl Client
sourcepub fn delete_assistant(&self) -> DeleteAssistantFluentBuilder
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>)
:The identifier of the Wisdom 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>
source§impl Client
impl Client
sourcepub fn delete_assistant_association(
&self
) -> DeleteAssistantAssociationFluentBuilder
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>)
: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>)
:The identifier of the Wisdom 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>
source§impl Client
impl Client
sourcepub fn delete_content(&self) -> DeleteContentFluentBuilder
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>)
:The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
content_id(impl Into<String>)
/set_content_id(Option<String>)
: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>
source§impl Client
impl Client
sourcepub fn delete_knowledge_base(&self) -> DeleteKnowledgeBaseFluentBuilder
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>)
: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>
source§impl Client
impl Client
sourcepub fn get_assistant(&self) -> GetAssistantFluentBuilder
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>)
:The identifier of the Wisdom 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>
source§impl Client
impl Client
sourcepub fn get_assistant_association(&self) -> GetAssistantAssociationFluentBuilder
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>)
: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>)
:The identifier of the Wisdom 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>
source§impl Client
impl Client
sourcepub fn get_content(&self) -> GetContentFluentBuilder
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>)
: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>)
:The identifier of the knowledge base. 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>
source§impl Client
impl Client
sourcepub fn get_content_summary(&self) -> GetContentSummaryFluentBuilder
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>)
: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>)
:The identifier of the knowledge base. 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>
source§impl Client
impl Client
sourcepub fn get_knowledge_base(&self) -> GetKnowledgeBaseFluentBuilder
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>)
:The identifier of the knowledge base. 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>
source§impl Client
impl Client
sourcepub fn get_recommendations(&self) -> GetRecommendationsFluentBuilder
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>)
:The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
session_id(impl Into<String>)
/set_session_id(Option<String>)
: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>)
:The maximum number of results to return per page.
wait_time_seconds(i32)
/set_wait_time_seconds(i32)
: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(Option<Vec<RecommendationData>>)
:The recommendations.
triggers(Option<Vec<RecommendationTrigger>>)
:The triggers corresponding to recommendations.
- On failure, responds with
SdkError<GetRecommendationsError>
source§impl Client
impl Client
sourcepub fn get_session(&self) -> GetSessionFluentBuilder
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>)
:The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
session_id(impl Into<String>)
/set_session_id(Option<String>)
: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>
source§impl Client
impl Client
sourcepub fn list_assistant_associations(
&self
) -> ListAssistantAssociationsFluentBuilder
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>)
: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>)
:The maximum number of results to return per page.
assistant_id(impl Into<String>)
/set_assistant_id(Option<String>)
:The identifier of the Wisdom 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(Option<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>
source§impl Client
impl Client
sourcepub fn list_assistants(&self) -> ListAssistantsFluentBuilder
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>)
: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>)
:The maximum number of results to return per page.
- On success, responds with
ListAssistantsOutput
with field(s):assistant_summaries(Option<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>
source§impl Client
impl Client
sourcepub fn list_contents(&self) -> ListContentsFluentBuilder
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>)
: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>)
:The maximum number of results to return per page.
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- On success, responds with
ListContentsOutput
with field(s):content_summaries(Option<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>
source§impl Client
impl Client
sourcepub fn list_knowledge_bases(&self) -> ListKnowledgeBasesFluentBuilder
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>)
: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>)
:The maximum number of results to return per page.
- On success, responds with
ListKnowledgeBasesOutput
with field(s):knowledge_base_summaries(Option<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>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
: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>
source§impl Client
impl Client
sourcepub fn notify_recommendations_received(
&self
) -> NotifyRecommendationsReceivedFluentBuilder
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>)
:The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
session_id(impl Into<String>)
/set_session_id(Option<String>)
: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>>)
: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>
source§impl Client
impl Client
sourcepub fn query_assistant(&self) -> QueryAssistantFluentBuilder
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>)
:The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
query_text(impl Into<String>)
/set_query_text(Option<String>)
:The text to search for.
next_token(impl Into<String>)
/set_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.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
QueryAssistantOutput
with field(s):results(Option<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>
source§impl Client
impl Client
sourcepub fn remove_knowledge_base_template_uri(
&self
) -> RemoveKnowledgeBaseTemplateUriFluentBuilder
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>)
:The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- On success, responds with
RemoveKnowledgeBaseTemplateUriOutput
- On failure, responds with
SdkError<RemoveKnowledgeBaseTemplateUriError>
source§impl Client
impl Client
sourcepub fn search_content(&self) -> SearchContentFluentBuilder
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>)
: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>)
:The maximum number of results to return per page.
knowledge_base_id(impl Into<String>)
/set_knowledge_base_id(Option<String>)
:The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
search_expression(SearchExpression)
/set_search_expression(Option<SearchExpression>)
:The search expression to filter results.
- On success, responds with
SearchContentOutput
with field(s):content_summaries(Option<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>
source§impl Client
impl Client
sourcepub fn search_sessions(&self) -> SearchSessionsFluentBuilder
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>)
: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>)
:The maximum number of results to return per page.
assistant_id(impl Into<String>)
/set_assistant_id(Option<String>)
:The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
search_expression(SearchExpression)
/set_search_expression(Option<SearchExpression>)
:The search expression to filter results.
- On success, responds with
SearchSessionsOutput
with field(s):session_summaries(Option<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>
source§impl Client
impl Client
sourcepub fn start_content_upload(&self) -> StartContentUploadFluentBuilder
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>)
:The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
content_type(impl Into<String>)
/set_content_type(Option<String>)
:The type of content to upload.
- On success, responds with
StartContentUploadOutput
with field(s):upload_id(Option<String>)
:The identifier of the upload.
url(Option<String>)
:The URL of the upload.
url_expiry(Option<DateTime>)
:The expiration time of the URL as an epoch timestamp.
headers_to_include(Option<HashMap<String, String>>)
:The headers to include in the upload.
- On failure, responds with
SdkError<StartContentUploadError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_content(&self) -> UpdateContentFluentBuilder
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>)
:The identifier of the knowledge base. Can be either the ID or the ARN
content_id(impl Into<String>)
/set_content_id(Option<String>)
: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>)
:The
revisionId
of the content resource to update, taken from an earlier call toGetContent
,GetContentSummary
,SearchContent
, orListContents
. 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 aPreconditionFailedException
.title(impl Into<String>)
/set_title(Option<String>)
:The title of the content.
override_link_out_uri(impl Into<String>)
/set_override_link_out_uri(Option<String>)
: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 setremoveOverrideLinkOutUri
to true.remove_override_link_out_uri(bool)
/set_remove_override_link_out_uri(Option<bool>)
:Unset the existing
overrideLinkOutUri
if it exists.metadata(impl Into<String>, impl Into<String>)
/set_metadata(Option<HashMap<String, String>>)
:A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
upload_id(impl Into<String>)
/set_upload_id(Option<String>)
: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>
source§impl Client
impl Client
sourcepub fn update_knowledge_base_template_uri(
&self
) -> UpdateKnowledgeBaseTemplateUriFluentBuilder
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>)
:The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
template_uri(impl Into<String>)
/set_template_uri(Option<String>)
: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>
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.