[ aws . iotthingsgraph ]
Removes a system instance from its target (Cloud or Greengrass).
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
undeploy-system-instance
[--id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--id
(string)
The ID of the system instance to remove from its target.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To undeploy a system instance from its target
The following undeploy-system-instance
example removes a system instance from its target.
aws iotthingsgraph undeploy-system-instance \
--id "urn:tdm:us-west-2/123456789012/default:Deployment:Room215"
Output:
{
"summary": {
"id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room215",
"arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room215",
"status": "PENDING_DELETE",
"target": "GREENGRASS",
"greengrassGroupName": "ThingsGraphGrnGr",
"createdAt": 1553189694.255,
"updatedAt": 1559344549.601,
"greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf",
"greengrassGroupVersionId": "731b371d-d644-4b67-ac64-3934e99b75d7"
}
}
For more information, see Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments in the AWS IoT Things Graph User Guide.
summary -> (structure)
An object that contains summary information about the system instance that was removed from its target.
id -> (string)
The ID of the system instance.
arn -> (string)
The ARN of the system instance.
status -> (string)
The status of the system instance.
target -> (string)
The target of the system instance.
greengrassGroupName -> (string)
The ID of the Greengrass group where the system instance is deployed.
createdAt -> (timestamp)
The date when the system instance was created.
updatedAt -> (timestamp)
The date and time when the system instance was last updated.
greengrassGroupId -> (string)
The ID of the Greengrass group where the system instance is deployed.
greengrassGroupVersionId -> (string)
The version of the Greengrass group where the system instance is deployed.