get_voice_tone_analysis_task `async` ¶

get_voice_tone_analysis_task(
    voice_connector_id: VoiceConnectorId,
    voice_tone_analysis_task_id: NonEmptyString256,
    is_caller: Boolean,
    *,
    config_overrides: Optional[AsyncChimeSDKVoiceClientConfig] = None,
) -> GetVoiceToneAnalysisTaskResponse

Retrieves the details of a voice tone analysis task.

Parameters:

voice_connector_id (VoiceConnectorId) –

The Voice Connector ID.
voice_tone_analysis_task_id (NonEmptyString256) –

The ID of the voice tone analysis task.
is_caller (Boolean) –

Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

Raises:

AccessDeniedException –

You don't have the permissions needed to run this action.
BadRequestException –

The input parameters don't match the service's restrictions.
ConflictException –

Multiple instances of the same request were made simultaneously.
ForbiddenException –

The client is permanently forbidden from making the request.
NotFoundException –

The requested resource couldn't be found.
ServiceFailureException –

The service encountered an unexpected error.
ServiceUnavailableException –

The service is currently unavailable.
ThrottledClientException –

The number of customer requests exceeds the request rate limit.
UnauthorizedClientException –

The client isn't authorized to request a resource.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_chime_sdk_voice/_services/async_chime_sdk_voice.py

async def get_voice_tone_analysis_task(
    self,
    voice_connector_id: "capo_chime_sdk_voice.types.voice_connector_id.VoiceConnectorId",
    voice_tone_analysis_task_id: "capo_chime_sdk_voice.types.non_empty_string256.NonEmptyString256",
    is_caller: "capo_chime_sdk_voice.types.boolean.Boolean",
    *,
    config_overrides: Optional[AsyncChimeSDKVoiceClientConfig] = None,
) -> "capo_chime_sdk_voice.types.get_voice_tone_analysis_task_response.GetVoiceToneAnalysisTaskResponse":
    """<p>Retrieves the details of a voice tone analysis task.</p>

    Args:
        voice_connector_id: <p>The Voice Connector ID.</p>
        voice_tone_analysis_task_id: <p>The ID of the voice tone analysis task.</p>
        is_caller: <p>Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).</p>

    Raises:
        capo_chime_sdk_voice.errors.access_denied_exception.AccessDeniedException: <p>You don't have the permissions needed to run this action.</p>
        capo_chime_sdk_voice.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_voice.errors.conflict_exception.ConflictException: <p>Multiple instances of the same request were made simultaneously.</p>
        capo_chime_sdk_voice.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_voice.errors.not_found_exception.NotFoundException: <p>The requested resource couldn't be found.</p>
        capo_chime_sdk_voice.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_voice.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_voice.errors.throttled_client_exception.ThrottledClientException: <p>The number of customer requests exceeds the request rate limit.</p>
        capo_chime_sdk_voice.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client isn't authorized to request a resource.</p>
        capo_chime_sdk_voice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_voice.types.get_voice_tone_analysis_task_request.GetVoiceToneAnalysisTaskRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_voice.types.get_voice_tone_analysis_task_response.GetVoiceToneAnalysisTaskResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.get_voice_tone_analysis_task

        (
            output,
            http_response,
        ) = await capo_chime_sdk_voice._operations.chime_sdk_telephony_service.get_voice_tone_analysis_task.async_get_voice_tone_analysis_task(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetVoiceToneAnalysisTask")
    )
    input_: capo_chime_sdk_voice.types.get_voice_tone_analysis_task_request.GetVoiceToneAnalysisTaskRequest = {
        "voice_connector_id": voice_connector_id,
        "voice_tone_analysis_task_id": voice_tone_analysis_task_id,
        "is_caller": is_caller,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_voice_tone_analysis_task async ¶

get_voice_tone_analysis_task `async` ¶