Skip to content

undeploy_system_instance async

undeploy_system_instance(
    *,
    config_overrides: Optional[AsyncIoTThingsGraphClientConfig] = None,
    id: Optional[Urn] = None,
) -> UndeploySystemInstanceResponse

Removes a system instance from its target (Cloud or Greengrass).

Parameters:

  • id (Optional[Urn], default: None ) –

    The ID of the system instance to remove from its target.

Raises:

Source code in docs_src/capo_iotthingsgraph/_services/async_io_t_things_graph.py
async def undeploy_system_instance(
    self,
    *,
    config_overrides: Optional[AsyncIoTThingsGraphClientConfig] = None,
    id: Optional["capo_iotthingsgraph.types.urn.Urn"] = None,
) -> "capo_iotthingsgraph.types.undeploy_system_instance_response.UndeploySystemInstanceResponse":
    """<p>Removes a system instance from its target (Cloud or Greengrass).</p>

    Args:
        id: <p>The ID of the system instance to remove from its target.</p>

    Raises:
        capo_iotthingsgraph.errors.internal_failure_exception.InternalFailureException: <p></p>
        capo_iotthingsgraph.errors.invalid_request_exception.InvalidRequestException: <p></p>
        capo_iotthingsgraph.errors.resource_in_use_exception.ResourceInUseException: <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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotthingsgraph.types.undeploy_system_instance_request.UndeploySystemInstanceRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotthingsgraph.types.undeploy_system_instance_response.UndeploySystemInstanceResponse"
    ]:
        import capo_iotthingsgraph._operations.iot_things_graph_front_end_service.undeploy_system_instance

        (
            output,
            http_response,
        ) = await capo_iotthingsgraph._operations.iot_things_graph_front_end_service.undeploy_system_instance.async_undeploy_system_instance(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UndeploySystemInstance")
    )
    input_: capo_iotthingsgraph.types.undeploy_system_instance_request.UndeploySystemInstanceRequest = {}
    if id is not None:
        input_["id"] = id

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output