stop_speaker_search_task ¶

stop_speaker_search_task(
    voice_connector_id: VoiceConnectorId,
    speaker_search_task_id: NonEmptyString256,
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
) -> None

Stops a speaker search task.

Parameters:

voice_connector_id (VoiceConnectorId) –

The Voice Connector ID.
speaker_search_task_id (NonEmptyString256) –

The speaker search task ID.

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.
UnprocessableEntityException –

A well-formed request couldn't be followed due to semantic errors.
UnknownServiceError –

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

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

def stop_speaker_search_task(
    self,
    voice_connector_id: "capo_chime_sdk_voice.types.voice_connector_id.VoiceConnectorId",
    speaker_search_task_id: "capo_chime_sdk_voice.types.non_empty_string256.NonEmptyString256",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
) -> None:
    """<p>Stops a speaker search task.</p>

    Args:
        voice_connector_id: <p>The Voice Connector ID.</p>
        speaker_search_task_id: <p>The speaker search task ID.</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.unprocessable_entity_exception.UnprocessableEntityException: <p>A well-formed request couldn't be followed due to semantic errors.</p>
        capo_chime_sdk_voice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_voice.types.stop_speaker_search_task_request.StopSpeakerSearchTaskRequest]",
    ) -> OperationResponse[None]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.stop_speaker_search_task

        output, http_response = (
            capo_chime_sdk_voice._operations.chime_sdk_telephony_service.stop_speaker_search_task.stop_speaker_search_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopSpeakerSearchTask")
    )
    input_: capo_chime_sdk_voice.types.stop_speaker_search_task_request.StopSpeakerSearchTaskRequest = {
        "voice_connector_id": voice_connector_id,
        "speaker_search_task_id": speaker_search_task_id,
    }

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