start_contact_conversational_analytics_job
async
¶
start_contact_conversational_analytics_job(
instance_id: InstanceId,
contact_id: ContactId,
analytics_modes: AnalyticsModes,
analytics_configuration: AnalyticsConfiguration,
*,
config_overrides: Optional[AsyncConnectClientConfig] = None,
client_token: Optional[ClientToken] = None,
) -> StartContactConversationalAnalyticsJobResponse
Starts a Contact Lens post-call analytics job for the specified contact. This API runs Conversational Analytics post-contact analysis on a voice recording that is already attached to the contact, generating transcription, sentiment analysis, redaction, and summarization results based on the provided configuration.
A voice recording must already be attached to the contact before calling this API. Use CreateAttachedFile to attach a recording from an S3 source URI.
For example, you can call CreateContact, then CreateAttachedFile, then StartContactConversationalAnalyticsJob to create a contact, attach a recording, and run post-call analytics.
Parameters:
-
instance_id(InstanceId) –The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
-
contact_id(ContactId) –The identifier of the contact in this instance of Connect Customer.
-
analytics_modes(AnalyticsModes) –The analytics modes to run for the contact. Valid values:
PostContact. -
analytics_configuration(AnalyticsConfiguration) –The configuration for the conversational analytics job.
-
client_token(Optional[ClientToken], default:None) –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.
Raises:
-
AccessDeniedException–You do not have sufficient permissions to perform this action.
-
IdempotencyException–An entity with the same name already exists.
-
InternalServiceException–Request processing failed because of an error or failure with the service.
-
InvalidRequestException–The request is not valid.
-
ResourceNotFoundException–The specified resource was not found.
-
ThrottlingException–The throttling limit has been exceeded.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_connect/_services/async_connect.py
23409 23410 23411 23412 23413 23414 23415 23416 23417 23418 23419 23420 23421 23422 23423 23424 23425 23426 23427 23428 23429 23430 23431 23432 23433 23434 23435 23436 23437 23438 23439 23440 23441 23442 23443 23444 23445 23446 23447 23448 23449 23450 23451 23452 23453 23454 23455 23456 23457 23458 23459 23460 23461 23462 23463 23464 23465 23466 23467 23468 23469 23470 23471 | |