delete_watchlist ¶

def delete_watchlist(
    self,
    domain_id: "capo_voice_id.types.domain_id.DomainId",
    watchlist_id: "capo_voice_id.types.watchlist_id.WatchlistId",
    *,
    config_overrides: Optional[VoiceIDClientConfig] = None,
) -> None:
    """<p>Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted. </p>

    Args:
        domain_id: <p>The identifier of the domain that contains the watchlist.</p>
        watchlist_id: <p>The identifier of the watchlist to be deleted.</p>

    Raises:
        capo_voice_id.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action. Check the error message and try again.</p>
        capo_voice_id.errors.conflict_exception.ConflictException: <p>The request failed due to a conflict. Check the <code>ConflictType</code> and error message for more details.</p>
        capo_voice_id.errors.internal_server_exception.InternalServerException: <p>The request failed due to an unknown error on the server side.</p>
        capo_voice_id.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error message for more details.</p>
        capo_voice_id.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please slow down your request rate. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas"> Amazon Connect Voice ID Service API throttling quotas </a> and try your request again.</p>
        capo_voice_id.errors.validation_exception.ValidationException: <p>The request failed one or more validations; check the error message for more details.</p>
        capo_voice_id.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_voice_id.types.delete_watchlist_request.DeleteWatchlistRequest]",
    ) -> OperationResponse[None]:
        import capo_voice_id._operations.voice_id.delete_watchlist

        output, http_response = (
            capo_voice_id._operations.voice_id.delete_watchlist.delete_watchlist(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWatchlist")
    )
    input_: capo_voice_id.types.delete_watchlist_request.DeleteWatchlistRequest = {
        "domain_id": domain_id,
        "watchlist_id": watchlist_id,
    }

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