IoTThingsGraph / Client / deploy_system_instance

deploy_system_instance

IoTThingsGraph.Client.deploy_system_instance(**kwargs)

Greengrass and Cloud Deployments

Deploys the system instance to the target specified in CreateSystemInstance.

Greengrass Deployments

If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

Since this action creates a Greengrass deployment on the caller’s behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.deploy_system_instance(
    id='string'
)

Parameters:

id (string) –

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

The ID should be in the following format.

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

Return type:

dict

Returns:

Response Syntax

{
    'summary': {
        'id': 'string',
        'arn': 'string',
        'status': 'NOT_DEPLOYED'|'BOOTSTRAP'|'DEPLOY_IN_PROGRESS'|'DEPLOYED_IN_TARGET'|'UNDEPLOY_IN_PROGRESS'|'FAILED'|'PENDING_DELETE'|'DELETED_IN_TARGET',
        'target': 'GREENGRASS'|'CLOUD',
        'greengrassGroupName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'greengrassGroupId': 'string',
        'greengrassGroupVersionId': 'string'
    },
    'greengrassDeploymentId': 'string'
}

Response Structure

• (dict) –

  • summary (dict) –

    An object that contains summary information about a system instance that was deployed.

    • 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 (datetime) –

      The date when the system instance was created.

    • updatedAt (datetime) –

      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.

  • greengrassDeploymentId (string) –

    The ID of the Greengrass deployment used to deploy the system instance.

Exceptions

• IoTThingsGraph.Client.exceptions.ResourceNotFoundException

• IoTThingsGraph.Client.exceptions.InvalidRequestException

• IoTThingsGraph.Client.exceptions.ThrottlingException

• IoTThingsGraph.Client.exceptions.InternalFailureException

• IoTThingsGraph.Client.exceptions.ResourceInUseException