Skip to content

get_sip_rule

get_sip_rule(
    sip_rule_id: NonEmptyString,
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
) -> GetSipRuleResponse

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Parameters:

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/chime_sdk_voice.py
def get_sip_rule(
    self,
    sip_rule_id: "capo_chime_sdk_voice.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
) -> "capo_chime_sdk_voice.types.get_sip_rule_response.GetSipRuleResponse":
    """<p>Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.</p>

    Args:
        sip_rule_id: <p>The SIP rule ID.</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.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.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.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_voice.types.get_sip_rule_request.GetSipRuleRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_voice.types.get_sip_rule_response.GetSipRuleResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.get_sip_rule

        output, http_response = (
            capo_chime_sdk_voice._operations.chime_sdk_telephony_service.get_sip_rule.get_sip_rule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSipRule")
    )
    input_: capo_chime_sdk_voice.types.get_sip_rule_request.GetSipRuleRequest = {
        "sip_rule_id": sip_rule_id
    }

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