update_sip_rule async ¶

async def update_sip_rule(
    self,
    sip_rule_id: "capo_chime_sdk_voice.types.non_empty_string.NonEmptyString",
    name: "capo_chime_sdk_voice.types.sip_rule_name.SipRuleName",
    *,
    config_overrides: Optional[AsyncChimeSDKVoiceClientConfig] = None,
    disabled: Optional[
        "capo_chime_sdk_voice.types.nullable_boolean.NullableBoolean"
    ] = None,
    target_applications: Optional[
        "capo_chime_sdk_voice.types.sip_rule_target_application_list.SipRuleTargetApplicationList"
    ] = None,
) -> "capo_chime_sdk_voice.types.update_sip_rule_response.UpdateSipRuleResponse":
    """<p>Updates the details of the specified SIP rule.</p>

    Args:
        sip_rule_id: <p>The SIP rule ID.</p>
        name: <p>The new name for the specified SIP rule.</p>
        disabled: <p>The new value that indicates whether the rule is disabled.</p>
        target_applications: <p>The new list of target applications.</p>

    Raises:
        capo_chime_sdk_voice.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_voice.errors.conflict_exception.ConflictException: <p>Multiple instances of the same request were made simultaneously.</p>
        capo_chime_sdk_voice.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_voice.errors.not_found_exception.NotFoundException: <p>The requested resource couldn't be found.</p>
        capo_chime_sdk_voice.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</p>
        capo_chime_sdk_voice.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_voice.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_voice.errors.throttled_client_exception.ThrottledClientException: <p>The number of customer requests exceeds the request rate limit.</p>
        capo_chime_sdk_voice.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client isn't authorized to request a resource.</p>
        capo_chime_sdk_voice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_voice.types.update_sip_rule_request.UpdateSipRuleRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_voice.types.update_sip_rule_response.UpdateSipRuleResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.update_sip_rule

        (
            output,
            http_response,
        ) = await capo_chime_sdk_voice._operations.chime_sdk_telephony_service.update_sip_rule.async_update_sip_rule(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSipRule")
    )
    input_: capo_chime_sdk_voice.types.update_sip_rule_request.UpdateSipRuleRequest = {
        "sip_rule_id": sip_rule_id,
        "name": name,
    }
    if disabled is not None:
        input_["disabled"] = disabled
    if target_applications is not None:
        input_["target_applications"] = target_applications

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