delete_domain `async` ¶

delete_domain(
    domain_id: DomainId, *, config_overrides: Optional[AsyncVoiceIDClientConfig] = None
) -> None

Deletes the specified domain from Voice ID.

Parameters:

domain_id (DomainId) –

The identifier of the domain you want to delete.

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action. Check the error message and try again.
ConflictException –

The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException –

The request failed due to an unknown error on the server side.
ResourceNotFoundException –

The specified resource cannot be found. Check the ResourceType and error message for more details.
ThrottlingException –

The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
ValidationException –

The request failed one or more validations; check the error message for more details.
UnknownServiceError –

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

Source code in docs_src/capo_voice_id/_services/async_voice_id.py

async def delete_domain(
    self,
    domain_id: "capo_voice_id.types.domain_id.DomainId",
    *,
    config_overrides: Optional[AsyncVoiceIDClientConfig] = None,
) -> None:
    """<p>Deletes the specified domain from Voice ID.</p>

    Args:
        domain_id: <p>The identifier of the domain you want to delete.</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.delete_domain_request.DeleteDomainRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_voice_id._operations.voice_id.delete_domain

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDomain")
    )
    input_: capo_voice_id.types.delete_domain_request.DeleteDomainRequest = {
        "domain_id": domain_id
    }

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

delete_domain async ¶

delete_domain `async` ¶