get_layout ¶

get_layout(
    domain_id: DomainId,
    layout_id: LayoutId,
    *,
    config_overrides: Optional[ConnectCasesClientConfig] = None,
) -> GetLayoutResponse

Returns the details for the requested layout.

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.
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/connect_cases.py

def get_layout(
    self,
    domain_id: "capo_connectcases.types.domain_id.DomainId",
    layout_id: "capo_connectcases.types.layout_id.LayoutId",
    *,
    config_overrides: Optional[ConnectCasesClientConfig] = None,
) -> "capo_connectcases.types.get_layout_response.GetLayoutResponse":
    """<p>Returns the details for the requested layout.</p>

    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.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.
    """

    def _handler(
        req: "OperationRequest[capo_connectcases.types.get_layout_request.GetLayoutRequest]",
    ) -> OperationResponse[
        "capo_connectcases.types.get_layout_response.GetLayoutResponse"
    ]:
        import capo_connectcases._operations.amazon_connect_cases.get_layout

        output, http_response = (
            capo_connectcases._operations.amazon_connect_cases.get_layout.get_layout(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetLayout")
    )
    input_: capo_connectcases.types.get_layout_request.GetLayoutRequest = {
        "domain_id": domain_id,
        "layout_id": layout_id,
    }

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