Skip to content

update_sip_media_application

update_sip_media_application(
    sip_media_application_id: NonEmptyString,
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    name: Optional[SipMediaApplicationName] = None,
    endpoints: Optional[SipMediaApplicationEndpointList] = None,
) -> UpdateSipMediaApplicationResponse

Updates the details of the specified SIP media application.

Parameters:

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/chime_sdk_voice.py
def update_sip_media_application(
    self,
    sip_media_application_id: "capo_chime_sdk_voice.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    name: Optional[
        "capo_chime_sdk_voice.types.sip_media_application_name.SipMediaApplicationName"
    ] = None,
    endpoints: Optional[
        "capo_chime_sdk_voice.types.sip_media_application_endpoint_list.SipMediaApplicationEndpointList"
    ] = None,
) -> "capo_chime_sdk_voice.types.update_sip_media_application_response.UpdateSipMediaApplicationResponse":
    """<p>Updates the details of the specified SIP media application.</p>

    Args:
        sip_media_application_id: <p>The SIP media application ID.</p>
        name: <p>The new name for the specified SIP media application.</p>
        endpoints: <p>The new set of endpoints for the specified SIP media application.</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.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.update_sip_media_application_request.UpdateSipMediaApplicationRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_voice.types.update_sip_media_application_response.UpdateSipMediaApplicationResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.update_sip_media_application

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

    def _redact_input(
        input_: "capo_chime_sdk_voice.types.update_sip_media_application_request.UpdateSipMediaApplicationRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_voice.types.update_sip_media_application_request

        return capo_chime_sdk_voice.types.update_sip_media_application_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_chime_sdk_voice.types.update_sip_media_application_response.UpdateSipMediaApplicationResponse",
    ) -> dict[str, Any]:
        import capo_chime_sdk_voice.types.update_sip_media_application_response

        return capo_chime_sdk_voice.types.update_sip_media_application_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateSipMediaApplication",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_chime_sdk_voice.types.update_sip_media_application_request.UpdateSipMediaApplicationRequest = {
        "sip_media_application_id": sip_media_application_id
    }
    if name is not None:
        input_["name"] = name
    if endpoints is not None:
        input_["endpoints"] = endpoints

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