update_watchlist async ¶

async def update_watchlist(
    self,
    domain_id: "capo_voice_id.types.domain_id.DomainId",
    watchlist_id: "capo_voice_id.types.watchlist_id.WatchlistId",
    *,
    config_overrides: Optional[AsyncVoiceIDClientConfig] = None,
    name: Optional["capo_voice_id.types.watchlist_name.WatchlistName"] = None,
    description: Optional[
        "capo_voice_id.types.watchlist_description.WatchlistDescription"
    ] = None,
) -> "capo_voice_id.types.update_watchlist_response.UpdateWatchlistResponse":
    """<p>Updates the specified watchlist. Every domain has a default watchlist which cannot be updated. </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 updated.</p>
        name: <p>The name of the watchlist.</p>
        description: <p>A brief description about this watchlist.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_voice_id.types.update_watchlist_request.UpdateWatchlistRequest]",
    ) -> AsyncOperationResponse[
        "capo_voice_id.types.update_watchlist_response.UpdateWatchlistResponse"
    ]:
        import capo_voice_id._operations.voice_id.update_watchlist

        (
            output,
            http_response,
        ) = await capo_voice_id._operations.voice_id.update_watchlist.async_update_watchlist(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_voice_id.types.update_watchlist_request.UpdateWatchlistRequest",
    ) -> dict[str, Any]:
        import capo_voice_id.types.update_watchlist_request

        return capo_voice_id.types.update_watchlist_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_voice_id.types.update_watchlist_response.UpdateWatchlistResponse",
    ) -> dict[str, Any]:
        import capo_voice_id.types.update_watchlist_response

        return capo_voice_id.types.update_watchlist_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateWatchlist",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_voice_id.types.update_watchlist_request.UpdateWatchlistRequest = {
        "domain_id": domain_id,
        "watchlist_id": watchlist_id,
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description

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