delete_layout `async` ¶

delete_layout(
    domain_id: DomainId,
    layout_id: LayoutId,
    *,
    config_overrides: Optional[AsyncConnectCasesClientConfig] = None,
) -> DeleteLayoutResponse

Deletes a layout from a cases template. You can delete up to 100 layouts per domain.

After a layout is deleted:

You can still retrieve the layout by calling GetLayout.
You cannot update a deleted layout by calling UpdateLayout; it throws a ValidationException.
Deleted layouts are not included in the ListLayouts response.

Parameters:

domain_id (DomainId) –

The unique identifier of the Cases domain.
layout_id (LayoutId) –

The unique identifier of the layout.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
InternalServerException –

We couldn't process your request because of an issue with the server. Try again later.
ResourceNotFoundException –

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
ThrottlingException –

The rate has been exceeded for this API. Please try again after a few minutes.
ValidationException –

The request isn't valid. Check the syntax and try again.
UnknownServiceError –

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

Source code in docs_src/capo_connectcases/_services/async_connect_cases.py

async def delete_layout(
    self,
    domain_id: "capo_connectcases.types.domain_id.DomainId",
    layout_id: "capo_connectcases.types.layout_id.LayoutId",
    *,
    config_overrides: Optional[AsyncConnectCasesClientConfig] = None,
) -> "capo_connectcases.types.delete_layout_response.DeleteLayoutResponse":
    """<p>Deletes a layout from a cases template. You can delete up to 100 layouts per domain.</p> <p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul>

    Args:
        domain_id: <p>The unique identifier of the Cases domain.</p>
        layout_id: <p>The unique identifier of the layout.</p>

    Raises:
        capo_connectcases.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_connectcases.errors.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
        capo_connectcases.errors.internal_server_exception.InternalServerException: <p>We couldn't process your request because of an issue with the server. Try again later.</p>
        capo_connectcases.errors.resource_not_found_exception.ResourceNotFoundException: <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
        capo_connectcases.errors.throttling_exception.ThrottlingException: <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
        capo_connectcases.errors.validation_exception.ValidationException: <p>The request isn't valid. Check the syntax and try again.</p>
        capo_connectcases.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connectcases.types.delete_layout_request.DeleteLayoutRequest]",
    ) -> AsyncOperationResponse[
        "capo_connectcases.types.delete_layout_response.DeleteLayoutResponse"
    ]:
        import capo_connectcases._operations.amazon_connect_cases.delete_layout

        (
            output,
            http_response,
        ) = await capo_connectcases._operations.amazon_connect_cases.delete_layout.async_delete_layout(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteLayout")
    )
    input_: capo_connectcases.types.delete_layout_request.DeleteLayoutRequest = {
        "domain_id": domain_id,
        "layout_id": layout_id,
    }

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

delete_layout async ¶

delete_layout `async` ¶