Skip to content

delete_domain async

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

Removes a domain and all of its resources. Call this operation in the Region where the domain was created. A domain cannot be deleted while it contains spaces.

Parameters:

  • domain_id (DomainId) –

    The unique ID of the domain to delete.

Raises:

Examples:

Delete a domain The following example deletes a domain in the Region where it was created. The domain must not contain any spaces. A successful response returns an empty body. Payloads are shown as JSON; on the wire they are CBOR-encoded.

>>> await client.delete_domain(domain_id='d-1a2b3c4d5e')
Source code in docs_src/capo_cloudwatchomni/_services/async_cloud_watch_omni.py
async def delete_domain(
    self,
    domain_id: "capo_cloudwatchomni.types.domain_id.DomainId",
    *,
    config_overrides: Optional[AsyncCloudWatchOmniClientConfig] = None,
) -> "capo_cloudwatchomni.types.delete_domain_output.DeleteDomainOutput":
    """Removes a domain and all of its resources. Call this operation in the Region where the domain was created. A domain cannot be deleted while it contains spaces.

    Args:
        domain_id: The unique ID of the domain to delete.

    Raises:
        capo_cloudwatchomni.errors.access_denied_exception.AccessDeniedException: The caller is not authorized to perform this action.
        capo_cloudwatchomni.errors.conflict_exception.ConflictException: The operation could not be completed because of a conflict with the current state of the resource.
        capo_cloudwatchomni.errors.internal_server_exception.InternalServerException: An unexpected error occurred while processing the request.
        capo_cloudwatchomni.errors.throttling_exception.ThrottlingException: The request was throttled due to exceeding the allowed request rate.
        capo_cloudwatchomni.errors.validation_exception.ValidationException: A parameter is specified incorrectly.
        capo_cloudwatchomni.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Delete a domain
        The following example deletes a domain in the Region where it was created. The domain must not contain any spaces. A successful response returns an empty body. Payloads are shown as JSON; on the wire they are CBOR-encoded.

        >>> await client.delete_domain(domain_id='d-1a2b3c4d5e')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatchomni.types.delete_domain_input.DeleteDomainInput]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatchomni.types.delete_domain_output.DeleteDomainOutput"
    ]:
        import capo_cloudwatchomni._operations.cloud_watch_omni_frontend.delete_domain

        (
            output,
            http_response,
        ) = await capo_cloudwatchomni._operations.cloud_watch_omni_frontend.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_cloudwatchomni.types.delete_domain_input.DeleteDomainInput = {
        "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