aws_sdk_connect/client/start_contact_conversational_analytics_job.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`StartContactConversationalAnalyticsJob`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`instance_id(impl Into<String>)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
7 /// - [`contact_id(impl Into<String>)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::contact_id) / [`set_contact_id(Option<String>)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::set_contact_id):<br>required: **true**<br><p>The identifier of the contact in this instance of Connect Customer.</p><br>
8 /// - [`analytics_modes(AnalyticsMode)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::analytics_modes) / [`set_analytics_modes(Option<Vec::<AnalyticsMode>>)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::set_analytics_modes):<br>required: **true**<br><p>The analytics modes to run for the contact. Valid values: <code>PostContact</code>.</p><br>
9 /// - [`analytics_configuration(AnalyticsConfiguration)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::analytics_configuration) / [`set_analytics_configuration(Option<AnalyticsConfiguration>)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::set_analytics_configuration):<br>required: **true**<br><p>The configuration for the conversational analytics job.</p><br>
10 /// - [`client_token(impl Into<String>)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::set_client_token):<br>required: **false**<br><p>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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p><br>
11 /// - On success, responds with [`StartContactConversationalAnalyticsJobOutput`](crate::operation::start_contact_conversational_analytics_job::StartContactConversationalAnalyticsJobOutput) with field(s):
12 /// - [`instance_id(Option<String>)`](crate::operation::start_contact_conversational_analytics_job::StartContactConversationalAnalyticsJobOutput::instance_id): <p>The identifier of the Connect Customer instance.</p>
13 /// - [`contact_id(Option<String>)`](crate::operation::start_contact_conversational_analytics_job::StartContactConversationalAnalyticsJobOutput::contact_id): <p>The identifier of the contact.</p>
14 /// - On failure, responds with [`SdkError<StartContactConversationalAnalyticsJobError>`](crate::operation::start_contact_conversational_analytics_job::StartContactConversationalAnalyticsJobError)
15 pub fn start_contact_conversational_analytics_job(
16 &self,
17 ) -> crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder {
18 crate::operation::start_contact_conversational_analytics_job::builders::StartContactConversationalAnalyticsJobFluentBuilder::new(
19 self.handle.clone(),
20 )
21 }
22}