list_layouts ¶

def list_layouts(
    self,
    domain_id: "capo_connectcases.types.domain_id.DomainId",
    *,
    config_overrides: Optional[ConnectCasesClientConfig] = None,
    max_results: Optional["capo_connectcases.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_connectcases.types.next_token.NextToken"] = None,
) -> "capo_connectcases.types.list_layouts_response.ListLayoutsResponse":
    """<p>Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.</p>

    Args:
        domain_id: <p>The unique identifier of the Cases domain. </p>
        max_results: <p>The maximum number of results to return per page.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</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.list_layouts_request.ListLayoutsRequest]",
    ) -> OperationResponse[
        "capo_connectcases.types.list_layouts_response.ListLayoutsResponse"
    ]:
        import capo_connectcases._operations.amazon_connect_cases.list_layouts

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLayouts")
    )
    input_: capo_connectcases.types.list_layouts_request.ListLayoutsRequest = {
        "domain_id": domain_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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