stop_voice_tone_analysis_task ¶

stop_voice_tone_analysis_task(
    identifier: NonEmptyString,
    voice_tone_analysis_task_id: GuidString,
    *,
    config_overrides: Optional[ChimeSDKMediaPipelinesClientConfig] = None,
) -> None

Stops a voice tone analysis task.

Parameters:

identifier (NonEmptyString) –

The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
voice_tone_analysis_task_id (GuidString) –

The ID of the voice tone analysis task.

Raises:

BadRequestException –

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

The request could not be processed because of conflict in the current state of the resource.
ForbiddenException –

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

One or more of the resources in the request does not exist in the system.
ServiceFailureException –

The service encountered an unexpected error.
ServiceUnavailableException –

The service is currently unavailable.
ThrottledClientException –

The client exceeded its request rate limit.
UnauthorizedClientException –

The client is not currently authorized to make the request.
UnknownServiceError –

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

Source code in docs_src/capo_chime_sdk_media_pipelines/_services/chime_sdk_media_pipelines.py

def stop_voice_tone_analysis_task(
    self,
    identifier: "capo_chime_sdk_media_pipelines.types.non_empty_string.NonEmptyString",
    voice_tone_analysis_task_id: "capo_chime_sdk_media_pipelines.types.guid_string.GuidString",
    *,
    config_overrides: Optional[ChimeSDKMediaPipelinesClientConfig] = None,
) -> None:
    """<p>Stops a voice tone analysis task.</p>

    Args:
        identifier: <p>The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.</p>
        voice_tone_analysis_task_id: <p>The ID of the voice tone analysis task.</p>

    Raises:
        capo_chime_sdk_media_pipelines.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_media_pipelines.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
        capo_chime_sdk_media_pipelines.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_media_pipelines.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime_sdk_media_pipelines.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_media_pipelines.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_media_pipelines.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_media_pipelines.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_media_pipelines.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_media_pipelines.types.stop_voice_tone_analysis_task_request.StopVoiceToneAnalysisTaskRequest]",
    ) -> OperationResponse[None]:
        import capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.stop_voice_tone_analysis_task

        output, http_response = (
            capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.stop_voice_tone_analysis_task.stop_voice_tone_analysis_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopVoiceToneAnalysisTask")
    )
    input_: capo_chime_sdk_media_pipelines.types.stop_voice_tone_analysis_task_request.StopVoiceToneAnalysisTaskRequest = {
        "identifier": identifier,
        "voice_tone_analysis_task_id": voice_tone_analysis_task_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output