Skip to content

get_system_instance

get_system_instance(
    id: Urn, *, config_overrides: Optional[IoTThingsGraphClientConfig] = None
) -> GetSystemInstanceResponse

Gets a system instance.

Parameters:

  • id (Urn) –

    The ID of the system deployment instance. This value is returned by CreateSystemInstance.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME

Raises:

Source code in docs_src/capo_iotthingsgraph/_services/io_t_things_graph.py
def get_system_instance(
    self,
    id: "capo_iotthingsgraph.types.urn.Urn",
    *,
    config_overrides: Optional[IoTThingsGraphClientConfig] = None,
) -> "capo_iotthingsgraph.types.get_system_instance_response.GetSystemInstanceResponse":
    """<p>Gets a system instance.</p>

    Args:
        id: <p>The ID of the system deployment instance. This value is returned by <code>CreateSystemInstance</code>.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME</code> </p>

    Raises:
        capo_iotthingsgraph.errors.internal_failure_exception.InternalFailureException: <p></p>
        capo_iotthingsgraph.errors.invalid_request_exception.InvalidRequestException: <p></p>
        capo_iotthingsgraph.errors.resource_not_found_exception.ResourceNotFoundException: <p></p>
        capo_iotthingsgraph.errors.throttling_exception.ThrottlingException: <p></p>
        capo_iotthingsgraph.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotthingsgraph.types.get_system_instance_request.GetSystemInstanceRequest]",
    ) -> OperationResponse[
        "capo_iotthingsgraph.types.get_system_instance_response.GetSystemInstanceResponse"
    ]:
        import capo_iotthingsgraph._operations.iot_things_graph_front_end_service.get_system_instance

        output, http_response = (
            capo_iotthingsgraph._operations.iot_things_graph_front_end_service.get_system_instance.get_system_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSystemInstance")
    )
    input_: capo_iotthingsgraph.types.get_system_instance_request.GetSystemInstanceRequest = {
        "id": id
    }

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