stop_contact_streaming ¶

def stop_contact_streaming(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    contact_id: "capo_connect.types.contact_id.ContactId",
    streaming_id: "capo_connect.types.streaming_id.StreamingId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> "capo_connect.types.stop_contact_streaming_response.StopContactStreamingResponse":
    """<p> Ends message streaming on a specified contact. To restart message streaming on that contact, call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a> API. </p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        contact_id: <p>The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.</p>
        streaming_id: <p>The identifier of the streaming configuration enabled. </p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.stop_contact_streaming_request.StopContactStreamingRequest]",
    ) -> OperationResponse[
        "capo_connect.types.stop_contact_streaming_response.StopContactStreamingResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.stop_contact_streaming

        output, http_response = (
            capo_connect._operations.amazon_connect_service.stop_contact_streaming.stop_contact_streaming(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopContactStreaming")
    )
    input_: capo_connect.types.stop_contact_streaming_request.StopContactStreamingRequest = {
        "instance_id": instance_id,
        "contact_id": contact_id,
        "streaming_id": streaming_id,
    }

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