libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTThingsGraph.DeploySystemInstance

Description

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.

Synopsis

Creating a Request

data DeploySystemInstance Source #

See: newDeploySystemInstance smart constructor.

Constructors

DeploySystemInstance' 

Fields

  • id :: Maybe Text

    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

Instances

Instances details
Eq DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Read DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Show DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Generic DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Associated Types

type Rep DeploySystemInstance :: Type -> Type #

NFData DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Methods

rnf :: DeploySystemInstance -> () #

Hashable DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

ToJSON DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

AWSRequest DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Associated Types

type AWSResponse DeploySystemInstance #

ToHeaders DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

ToPath DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

ToQuery DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

type Rep DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

type Rep DeploySystemInstance = D1 ('MetaData "DeploySystemInstance" "Amazonka.IoTThingsGraph.DeploySystemInstance" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "DeploySystemInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse DeploySystemInstance Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

newDeploySystemInstance :: DeploySystemInstance Source #

Create a value of DeploySystemInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:DeploySystemInstance', deploySystemInstance_id - 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

Request Lenses

deploySystemInstance_id :: Lens' DeploySystemInstance (Maybe Text) Source #

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

Destructuring the Response

data DeploySystemInstanceResponse Source #

See: newDeploySystemInstanceResponse smart constructor.

Constructors

DeploySystemInstanceResponse' 

Fields

Instances

Instances details
Eq DeploySystemInstanceResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Read DeploySystemInstanceResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Show DeploySystemInstanceResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Generic DeploySystemInstanceResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

Associated Types

type Rep DeploySystemInstanceResponse :: Type -> Type #

NFData DeploySystemInstanceResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

type Rep DeploySystemInstanceResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.DeploySystemInstance

type Rep DeploySystemInstanceResponse = D1 ('MetaData "DeploySystemInstanceResponse" "Amazonka.IoTThingsGraph.DeploySystemInstance" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "DeploySystemInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "greengrassDeploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SystemInstanceSummary))))

newDeploySystemInstanceResponse Source #

Create a value of DeploySystemInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:greengrassDeploymentId:DeploySystemInstanceResponse', deploySystemInstanceResponse_greengrassDeploymentId - The ID of the Greengrass deployment used to deploy the system instance.

$sel:httpStatus:DeploySystemInstanceResponse', deploySystemInstanceResponse_httpStatus - The response's http status code.

$sel:summary:DeploySystemInstanceResponse', deploySystemInstanceResponse_summary - An object that contains summary information about a system instance that was deployed.

Response Lenses

deploySystemInstanceResponse_greengrassDeploymentId :: Lens' DeploySystemInstanceResponse (Maybe Text) Source #

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

deploySystemInstanceResponse_summary :: Lens' DeploySystemInstanceResponse SystemInstanceSummary Source #

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