get_system_template ¶

get_system_template(
    id: Urn,
    *,
    config_overrides: Optional[IoTThingsGraphClientConfig] = None,
    revision_number: Optional[Version] = None,
) -> GetSystemTemplateResponse

Gets a system.

Parameters:

id (Urn) –

The ID of the system to get. This ID must be in the user's namespace.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
revision_number (Optional[Version], default: None ) –

The number that specifies the revision of the system to get.

Raises:

InternalFailureException –
InvalidRequestException –
ResourceNotFoundException –
ThrottlingException –
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotthingsgraph/_services/io_t_things_graph.py

def get_system_template(
    self,
    id: "capo_iotthingsgraph.types.urn.Urn",
    *,
    config_overrides: Optional[IoTThingsGraphClientConfig] = None,
    revision_number: Optional["capo_iotthingsgraph.types.version.Version"] = None,
) -> "capo_iotthingsgraph.types.get_system_template_response.GetSystemTemplateResponse":
    """<p>Gets a system.</p>

    Args:
        id: <p>The ID of the system to get. This ID must be in the user's namespace.</p> <p>The ID should be in the following format.</p> <p> <code>urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME</code> </p>
        revision_number: <p>The number that specifies the revision of the system to get.</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_template_request.GetSystemTemplateRequest]",
    ) -> OperationResponse[
        "capo_iotthingsgraph.types.get_system_template_response.GetSystemTemplateResponse"
    ]:
        import capo_iotthingsgraph._operations.iot_things_graph_front_end_service.get_system_template

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSystemTemplate")
    )
    input_: capo_iotthingsgraph.types.get_system_template_request.GetSystemTemplateRequest = {
        "id": id
    }
    if revision_number is not None:
        input_["revision_number"] = revision_number

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