@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AWS IoT Greengrass V2
@version 2020-11-30
@auth AWS SigV4
@endpoints 29
@hint download_for_search
@toc greengrass(26), tags(3)

@group greengrass
@endpoint PUT /greengrass/servicerole
@desc Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
@required {roleArn: str}
@returns(200) {associatedAt: str?}

@endpoint POST /greengrass/v2/coreDevices/{coreDeviceThingName}/associateClientDevices
@desc Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer Guide.  Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see Interact with local IoT devices in the IoT Greengrass V2 Developer Guide.
@required {coreDeviceThingName: str}
@optional {entries: [AssociateClientDeviceWithCoreDeviceEntry]}
@returns(200) {errorEntries: [AssociateClientDeviceWithCoreDeviceErrorEntry]?}

@endpoint POST /greengrass/v2/coreDevices/{coreDeviceThingName}/disassociateClientDevices
@desc Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.
@required {coreDeviceThingName: str}
@optional {entries: [DisassociateClientDeviceFromCoreDeviceEntry]}
@returns(200) {errorEntries: [DisassociateClientDeviceFromCoreDeviceErrorEntry]?}

@endpoint POST /greengrass/v2/deployments/{deploymentId}/cancel
@desc Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.
@required {deploymentId: str}
@returns(200) {message: str?}

@endpoint POST /greengrass/v2/createComponentVersion
@desc Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices. You can use this operation to do the following:    Create components from recipes  Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT Greengrass component recipe reference in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, specify inlineRecipe when you call this operation.    Create components from Lambda functions  Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. This function accepts Lambda functions in all supported versions of Python, Node.js, and Java runtimes. IoT Greengrass doesn't apply any additional restrictions on deprecated Lambda runtime versions. To create a component from a Lambda function, specify lambdaFunction when you call this operation.  IoT Greengrass currently supports Lambda functions on only Linux core devices.
@optional {inlineRecipe: bytes, lambdaFunction: LambdaFunctionRecipeSource, tags: map<str,str>, clientToken: str}
@returns(200) {arn: str?, componentName: str, componentVersion: str, creationTimestamp: str(timestamp), status: CloudComponentStatus{componentState: str?, message: str?, errors: map<str,str>?, vendorGuidance: str?, vendorGuidanceMessage: str?}}

@endpoint POST /greengrass/v2/deployments
@desc Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device. You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices. Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.
@required {targetArn: str}
@optional {deploymentName: str, components: map<str,ComponentDeploymentSpecification>, iotJobConfiguration: DeploymentIoTJobConfiguration, deploymentPolicies: DeploymentPolicies, parentTargetArn: str, tags: map<str,str>, clientToken: str}
@returns(200) {deploymentId: str?, iotJobId: str?, iotJobArn: str?}

@endpoint DELETE /greengrass/v2/components/{arn}
@desc Deletes a version of a component from IoT Greengrass.  This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.
@required {arn: str}

@endpoint DELETE /greengrass/v2/coreDevices/{coreDeviceThingName}
@desc Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.
@required {coreDeviceThingName: str}

@endpoint DELETE /greengrass/v2/deployments/{deploymentId}
@desc Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment. Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.
@required {deploymentId: str}

@endpoint GET /greengrass/v2/components/{arn}/metadata
@desc Retrieves metadata for a version of a component.
@required {arn: str}
@returns(200) {arn: str?, componentName: str?, componentVersion: str?, creationTimestamp: str(timestamp)?, publisher: str?, description: str?, status: CloudComponentStatus?{componentState: str?, message: str?, errors: map<str,str>?, vendorGuidance: str?, vendorGuidanceMessage: str?}, platforms: [ComponentPlatform]?, tags: map<str,str>?}

@endpoint DELETE /greengrass/servicerole
@desc Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
@returns(200) {disassociatedAt: str?}

@endpoint GET /greengrass/v2/components/{arn}
@desc Gets the recipe for a version of a component.
@required {arn: str}
@optional {recipeOutputFormat: str}
@returns(200) {recipeOutputFormat: str, recipe: bytes, tags: map<str,str>?}

@endpoint GET /greengrass/v2/components/{arn}/artifacts/{artifactName+}
@desc Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.
@required {arn: str, artifactName: str}
@optional {s3EndpointType: str, x-amz-iot-endpoint-type: str}
@returns(200) {preSignedUrl: str}

@endpoint GET /greengrass/things/{thingName}/connectivityInfo
@desc Retrieves connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
@required {thingName: str}
@returns(200) {connectivityInfo: [ConnectivityInfo]?, message: str?}

@endpoint GET /greengrass/v2/coreDevices/{coreDeviceThingName}
@desc Retrieves metadata for a Greengrass core device.  IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times:   When the IoT Greengrass Core software starts   When the core device receives a deployment from the Amazon Web Services Cloud   When the status of any component on the core device becomes BROKEN    At a regular interval that you can configure, which defaults to 24 hours   For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
@required {coreDeviceThingName: str}
@returns(200) {coreDeviceThingName: str?, coreVersion: str?, platform: str?, architecture: str?, status: str?, lastStatusUpdateTimestamp: str(timestamp)?, tags: map<str,str>?}

@endpoint GET /greengrass/v2/deployments/{deploymentId}
@desc Gets a deployment. Deployments define the components that run on Greengrass core devices.
@required {deploymentId: str}
@returns(200) {targetArn: str?, revisionId: str?, deploymentId: str?, deploymentName: str?, deploymentStatus: str?, iotJobId: str?, iotJobArn: str?, components: map<str,ComponentDeploymentSpecification>?, deploymentPolicies: DeploymentPolicies?{failureHandlingPolicy: str?, componentUpdatePolicy: DeploymentComponentUpdatePolicy?{timeoutInSeconds: int?, action: str?}, configurationValidationPolicy: DeploymentConfigurationValidationPolicy?{timeoutInSeconds: int?}}, iotJobConfiguration: DeploymentIoTJobConfiguration?{jobExecutionsRolloutConfig: IoTJobExecutionsRolloutConfig?{exponentialRate: IoTJobExponentialRolloutRate?{baseRatePerMinute: int, incrementFactor: num(f64), rateIncreaseCriteria: IoTJobRateIncreaseCriteria}, maximumPerMinute: int?}, abortConfig: IoTJobAbortConfig?{criteriaList: [IoTJobAbortCriteria]}, timeoutConfig: IoTJobTimeoutConfig?{inProgressTimeoutInMinutes: int(i64)?}}, creationTimestamp: str(timestamp)?, isLatestForTarget: bool?, parentTargetArn: str?, tags: map<str,str>?}

@endpoint GET /greengrass/servicerole
@desc Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
@returns(200) {associatedAt: str?, roleArn: str?}

@endpoint GET /greengrass/v2/coreDevices/{coreDeviceThingName}/associatedClientDevices
@desc Retrieves a paginated list of client devices that are associated with a core device.
@required {coreDeviceThingName: str}
@optional {maxResults: int, nextToken: str}
@returns(200) {associatedClientDevices: [AssociatedClientDevice]?, nextToken: str?}

@endpoint GET /greengrass/v2/components/{arn}/versions
@desc Retrieves a paginated list of all versions for a component. Greater versions are listed first.
@required {arn: str}
@optional {maxResults: int, nextToken: str}
@returns(200) {componentVersions: [ComponentVersionListItem]?, nextToken: str?}

@endpoint GET /greengrass/v2/components
@desc Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
@optional {scope: str, maxResults: int, nextToken: str}
@returns(200) {components: [Component]?, nextToken: str?}

@endpoint GET /greengrass/v2/coreDevices
@desc Retrieves a paginated list of Greengrass core devices.  IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times:   When the IoT Greengrass Core software starts   When the core device receives a deployment from the Amazon Web Services Cloud   When the status of any component on the core device becomes BROKEN    At a regular interval that you can configure, which defaults to 24 hours   For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
@optional {thingGroupArn: str, status: str, maxResults: int, nextToken: str}
@returns(200) {coreDevices: [CoreDevice]?, nextToken: str?}

@endpoint GET /greengrass/v2/deployments
@desc Retrieves a paginated list of deployments.
@optional {targetArn: str, historyFilter: str, parentTargetArn: str, maxResults: int, nextToken: str}
@returns(200) {deployments: [Deployment]?, nextToken: str?}

@endpoint GET /greengrass/v2/coreDevices/{coreDeviceThingName}/effectiveDeployments
@desc Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
@required {coreDeviceThingName: str}
@optional {maxResults: int, nextToken: str}
@returns(200) {effectiveDeployments: [EffectiveDeployment]?, nextToken: str?}

@endpoint GET /greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents
@desc Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the topologyFilter parameter to ALL.  IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times:   When the IoT Greengrass Core software starts   When the core device receives a deployment from the Amazon Web Services Cloud   When the status of any component on the core device becomes BROKEN    At a regular interval that you can configure, which defaults to 24 hours   For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
@required {coreDeviceThingName: str}
@optional {maxResults: int, nextToken: str, topologyFilter: str}
@returns(200) {installedComponents: [InstalledComponent]?, nextToken: str?}

@endgroup

@group tags
@endpoint GET /tags/{resourceArn}
@desc Retrieves the list of tags for an IoT Greengrass resource.
@required {resourceArn: str}
@returns(200) {tags: map<str,str>?}

@endgroup

@group greengrass
@endpoint POST /greengrass/v2/resolveComponentCandidates
@desc Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install. This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version  of a component dependency. When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.  To use this operation, you must use the data plane API endpoint and authenticate with an IoT device certificate. For more information, see IoT Greengrass endpoints and quotas.
@optional {platform: ComponentPlatform, componentCandidates: [ComponentCandidate]}
@returns(200) {resolvedComponentVersions: [ResolvedComponentVersion]?}

@endgroup

@group tags
@endpoint POST /tags/{resourceArn}
@desc Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
@required {resourceArn: str, tags: map<str,str>}

@endpoint DELETE /tags/{resourceArn}
@desc Removes a tag from an IoT Greengrass resource.
@required {resourceArn: str, tagKeys: [str]}

@endgroup

@group greengrass
@endpoint PUT /greengrass/things/{thingName}/connectivityInfo
@desc Updates connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
@required {thingName: str, connectivityInfo: [ConnectivityInfo]}
@returns(200) {version: str?, message: str?}

@endgroup

@end