create_case_rule `async` ¶

create_case_rule(
    domain_id: DomainId,
    name: CaseRuleName,
    rule: CaseRuleDetails,
    *,
    config_overrides: Optional[AsyncConnectCasesClientConfig] = None,
    description: Optional[CaseRuleDescription] = None,
) -> CreateCaseRuleResponse

Creates a new case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Parameters:

domain_id (DomainId) –

Unique identifier of a Cases domain.
name (CaseRuleName) –

Name of the case rule.
description (Optional[CaseRuleDescription], default: None ) –

The description of a case rule.
rule (CaseRuleDetails) –

Represents what rule type should take place, under what conditions.

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.
ServiceQuotaExceededException –

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
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 create_case_rule(
    self,
    domain_id: "capo_connectcases.types.domain_id.DomainId",
    name: "capo_connectcases.types.case_rule_name.CaseRuleName",
    rule: "capo_connectcases.types.case_rule_details.CaseRuleDetails",
    *,
    config_overrides: Optional[AsyncConnectCasesClientConfig] = None,
    description: Optional[
        "capo_connectcases.types.case_rule_description.CaseRuleDescription"
    ] = None,
) -> "capo_connectcases.types.create_case_rule_response.CreateCaseRuleResponse":
    """<p>Creates a new case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a case template</a>.</p>

    Args:
        domain_id: <p>Unique identifier of a Cases domain.</p>
        name: <p>Name of the case rule.</p>
        description: <p>The description of a case rule.</p>
        rule: <p>Represents what rule type should take place, under what conditions.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</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.create_case_rule_request.CreateCaseRuleRequest]",
    ) -> AsyncOperationResponse[
        "capo_connectcases.types.create_case_rule_response.CreateCaseRuleResponse"
    ]:
        import capo_connectcases._operations.amazon_connect_cases.create_case_rule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateCaseRule")
    )
    input_: capo_connectcases.types.create_case_rule_request.CreateCaseRuleRequest = {
        "domain_id": domain_id,
        "name": name,
        "rule": rule,
    }
    if description is not None:
        input_["description"] = description

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

create_case_rule async ¶

create_case_rule `async` ¶