IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.
IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.
For more information, see What is IoT Greengrass? in the IoT Greengrass V2 Developer Guide.
' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: greengrassv2 x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/greengrassv2-2020-11-30.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/greengrass/' servers: - url: 'http://greengrass.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS GreengrassV2 multi-region endpoint - url: 'https://greengrass.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS GreengrassV2 multi-region endpoint - url: 'http://greengrass.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS GreengrassV2 endpoint for China (Beijing) and China (Ningxia) - url: 'https://greengrass.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS GreengrassV2 endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /greengrass/servicerole: put: operationId: AssociateServiceRoleToAccount description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateServiceRoleToAccountResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - RoleArn properties: RoleArn: description: The Amazon Resource Name (ARN) of the service role to associate with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. type: string summary: Amazon IoT Greengrass Associate Service Role to Account x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DisassociateServiceRoleFromAccount description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisassociateServiceRoleFromAccountResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] summary: Amazon IoT Greengrass Disassociate Service Role from Account x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: GetServiceRoleForAccount description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetServiceRoleForAccountResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] summary: Amazon IoT Greengrass Get Service Role for Account x-microcks-operation: delay: 0 dispatcher: FALLBACK '/greengrass/v2/coreDevices/{coreDeviceThingName}/associateClientDevices': post: operationId: BatchAssociateClientDeviceWithCoreDevice description: '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.
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 only accepts Lambda functions that use the following runtimes:
Python 2.7 – python2.7
Python
3.7 – python3.7
Python 3.8 – python3.8
Python 3.9 – python3.9
Java 8 – java8
Java 11 – java11
Node.js 10 – nodejs10.x
Node.js 12 – nodejs12.x
Node.js 14 – nodejs14.x
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.
The recipe to use to create the component. The recipe defines the component''s metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility.
You must specify either inlineRecipe or lambdaFunction.
$LATEST.'
componentName:
allOf:
- $ref: '#/components/schemas/ComponentNameString'
- description: The name of the component.
Defaults to the name of the Lambda function.
componentVersion: allOf: - $ref: '#/components/schemas/ComponentVersionString' - description: 'The version of the component.
Defaults to the version of the Lambda function as a semantic version. For example, if your function version is 3,
the component version becomes 3.0.0.
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.
' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDeploymentResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '485': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '486': description: RequestAlreadyInProgressException content: application/json: schema: $ref: '#/components/schemas/RequestAlreadyInProgressException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - targetArn properties: targetArn: description: 'The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.' type: string pattern: 'arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+' deploymentName: description: The name of the deployment. type: string minLength: 1 maxLength: 256 components: description: 'The components to deploy. This is a dictionary, where each key is the name of a component, and each key''s value is the version and configuration to deploy for that component.' type: object additionalProperties: $ref: '#/components/schemas/ComponentDeploymentSpecification' iotJobConfiguration: description: Contains information about an IoT job configuration. type: object properties: jobExecutionsRolloutConfig: allOf: - $ref: '#/components/schemas/IoTJobExecutionsRolloutConfig' - description: The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices. abortConfig: allOf: - $ref: '#/components/schemas/IoTJobAbortConfig' - description: The stop configuration for the job. This configuration defines when and how to stop a job rollout. timeoutConfig: allOf: - $ref: '#/components/schemas/IoTJobTimeoutConfig' - description: The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job. deploymentPolicies: description: Contains information about policies that define how a deployment updates components and handles failure. type: object properties: failureHandlingPolicy: allOf: - $ref: '#/components/schemas/DeploymentFailureHandlingPolicy' - description: 'The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.
Default: ROLLBACK
The filter for the list of deployments. Choose one of the following options:
ALL – The list includes all deployments.
LATEST_ONLY
– The list includes only the latest revision of each deployment.
Default: LATEST_ONLY
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.
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
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.
' responses: '204': description: Success '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: deploymentId in: path required: true description: The ID of the deployment. schema: type: string minLength: 1 summary: Amazon IoT Greengrass Delete Deployment x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetDeployment description: Gets a deployment. Deployments define the components that run on Greengrass core devices. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDeploymentResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: deploymentId in: path required: true description: The ID of the deployment. schema: type: string minLength: 1 summary: Amazon IoT Greengrass Get Deployment x-microcks-operation: delay: 0 dispatcher: FALLBACK '/greengrass/v2/components/{arn}/metadata': get: operationId: DescribeComponent description: Retrieves metadata for a version of a component. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeComponentResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: arn in: path required: true description: 'The ARN of the component version.' schema: type: string pattern: 'arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):components:[^:]+:versions:[^:]+' summary: Amazon IoT Greengrass Describe Component x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/greengrass/v2/components/{arn}/artifacts/{artifactName}': get: operationId: GetComponentVersionArtifact description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetComponentVersionArtifactResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: arn in: path required: true description: 'The ARN of the component version. Specify the ARN of a public or a Lambda component version.' schema: type: string pattern: 'arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):components:[^:]+:versions:[^:]+' - name: artifactName in: path required: true description: 'The name of the artifact.
You can use the GetComponent operation to download the
component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI greengrass:SomeArtifact.zip,
the artifact name is SomeArtifact.zip.
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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetConnectivityInfoResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: thingName in: path required: true description: The name of the core device. This is also the name of the IoT thing. schema: type: string minLength: 1 maxLength: 128 summary: Amazon IoT Greengrass Get Connectivity Info x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateConnectivityInfo description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateConnectivityInfoResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: thingName in: path required: true description: The name of the core device. This is also the name of the IoT thing. schema: type: string minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - ConnectivityInfo properties: ConnectivityInfo: description: The connectivity information for the core device. type: array items: $ref: '#/components/schemas/ConnectivityInfo' summary: Amazon IoT Greengrass Update Connectivity Info x-microcks-operation: delay: 0 dispatcher: FALLBACK '/greengrass/v2/coreDevices/{coreDeviceThingName}/associatedClientDevices': get: operationId: ListClientDevicesAssociatedWithCoreDevice description: Retrieves a paginated list of client devices that are associated with a core device. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListClientDevicesAssociatedWithCoreDeviceResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: coreDeviceThingName in: path required: true description: The name of the core device. This is also the name of the IoT thing. schema: type: string minLength: 1 maxLength: 128 - name: maxResults in: query required: false description: The maximum number of results to be returned per paginated request. schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: The token to be used for the next set of paginated results. schema: type: string summary: Amazon IoT Greengrass List Client Devices Associated with Core Device x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/greengrass/v2/components/{arn}/versions': get: operationId: ListComponentVersions description: Retrieves a paginated list of all versions for a component. Greater versions are listed first. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListComponentVersionsResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: arn in: path required: true description: 'The ARN of the component.' schema: type: string pattern: 'arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):components:[^:]+' - name: maxResults in: query required: false description: The maximum number of results to be returned per paginated request. schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: The token to be used for the next set of paginated results. schema: type: string summary: Amazon IoT Greengrass List Component Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /greengrass/v2/components: get: operationId: ListComponents description: Retrieves a paginated list of component summaries. This list includes components that you have permission to view. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListComponentsResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: scope in: query required: false description: 'The scope of the components to list.
Default: PRIVATE
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
The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:
HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software
or a component is in a failed state on the core device.
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
The filter for the list of components. Choose from the following options:
ALL – The list includes all components installed on the core device.
ROOT – The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn''t include
components that the core device installs as dependencies of other components.
Default: ROOT
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 <2.0.0
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.
The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, IoT Greengrass creates a friendly name from the
os and architecture of the platform.
os and architecture by default. You can specify
additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the Greengrass
nucleus component in the IoT Greengrass V2 Developer Guide.'
componentCandidates:
description: The list of components to resolve.
type: array
items:
$ref: '#/components/schemas/ComponentCandidate'
summary: Amazon IoT Greengrass Resolve Component Candidates
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/tags/{resourceArn}#tagKeys':
delete:
operationId: UntagResource
description: Removes a tag from an IoT Greengrass resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: resourceArn
in: path
required: true
description: 'The ARN of the resource to untag.'
schema:
type: string
pattern: 'arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):(components|deployments|coreDevices):.*'
- name: tagKeys
in: query
required: true
description: A list of keys for tags to remove from the resource.
schema:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 1
maxItems: 200
summary: Amazon IoT Greengrass Untag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
AssociateServiceRoleToAccountResponse:
type: object
properties:
associatedAt:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: AssociatedAt
description: The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
ValidationException: {}
InternalServerException: {}
BatchAssociateClientDeviceWithCoreDeviceResponse:
type: object
properties:
errorEntries:
allOf:
- $ref: '#/components/schemas/AssociateClientDeviceWithCoreDeviceErrorList'
- description: The list of any errors for the entries in the request. Each error entry contains the name of the IoT thing that failed to associate.
AssociateClientDeviceWithCoreDeviceEntry:
type: object
required:
- thingName
properties:
thingName:
allOf:
- $ref: '#/components/schemas/IoTThingName'
- description: The name of the IoT thing that represents the client device to associate.
description: 'Contains a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice
operation consumes a list of these requests.'
ResourceNotFoundException: {}
AccessDeniedException: {}
ThrottlingException: {}
BatchDisassociateClientDeviceFromCoreDeviceResponse:
type: object
properties:
errorEntries:
allOf:
- $ref: '#/components/schemas/DisassociateClientDeviceFromCoreDeviceErrorList'
- description: The list of any errors for the entries in the request. Each error entry contains the name of the IoT thing that failed to disassociate.
DisassociateClientDeviceFromCoreDeviceEntry:
type: object
required:
- thingName
properties:
thingName:
allOf:
- $ref: '#/components/schemas/IoTThingName'
- description: The name of the IoT thing that represents the client device to disassociate.
description: 'Contains a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice
operation consumes a list of these requests.'
CancelDeploymentResponse:
type: object
properties:
message:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: A message that communicates if the cancel was successful.
ConflictException: {}
CreateComponentVersionResponse:
type: object
required:
- componentName
- componentVersion
- creationTimestamp
- status
properties:
arn:
allOf:
- $ref: '#/components/schemas/ComponentVersionARN'
- description: 'The ARN of the component version.'
componentName:
allOf:
- $ref: '#/components/schemas/ComponentNameString'
- description: The name of the component.
componentVersion:
allOf:
- $ref: '#/components/schemas/ComponentVersionString'
- description: The version of the component.
creationTimestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The time at which the component was created, expressed in ISO 8601 format.'
status:
allOf:
- $ref: '#/components/schemas/CloudComponentStatus'
- description: The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.
NonEmptyString:
type: string
minLength: 1
ComponentNameString:
type: string
minLength: 1
maxLength: 128
ComponentVersionString:
type: string
minLength: 1
maxLength: 64
ComponentPlatformList:
type: array
items:
$ref: '#/components/schemas/ComponentPlatform'
ComponentDependencyMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ComponentDependencyRequirement'
LambdaExecutionParameters:
type: object
properties:
eventSources:
allOf:
- $ref: '#/components/schemas/LambdaEventSourceList'
- description: The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this
function to local publish/subscribe messages and Amazon Web Services IoT Core MQTT messages.
maxQueueSize:
allOf:
- $ref: '#/components/schemas/OptionalInteger'
- description: The maximum size of the message queue for the Lambda function component. The IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until it can run the
Lambda function to consume each message.
maxInstancesCount:
allOf:
- $ref: '#/components/schemas/OptionalInteger'
- description: The maximum number of instances that a non-pinned Lambda function can run at the same time.
maxIdleTimeInSeconds:
allOf:
- $ref: '#/components/schemas/OptionalInteger'
- description: The maximum amount of time in seconds that a non-pinned Lambda function can idle before the IoT Greengrass Core software stops its process.
timeoutInSeconds:
allOf:
- $ref: '#/components/schemas/OptionalInteger'
- description: The maximum amount of time in seconds that the Lambda function can process a work item.
statusTimeoutInSeconds:
allOf:
- $ref: '#/components/schemas/OptionalInteger'
- description: The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.
pinned:
allOf:
- $ref: '#/components/schemas/OptionalBoolean'
- description: 'Whether or not the Lambda function is pinned, or long-lived.
A pinned Lambda function starts when IoT Greengrass starts and keeps running in its own container.
A non-pinned Lambda function starts only when it receives a work item and exists after it idles for maxIdleTimeInSeconds. If the function has multiple work items,
the IoT Greengrass Core software creates multiple instances of the function.
Default: true
The encoding type that the Lambda function supports.
Default: json
The amount of time, in minutes, that devices have to complete the job. The timer starts when the job status is set to IN_PROGRESS. If the job status doesn''t change
to a terminal state before the time expires, then the job status is set to TIMED_OUT.
The timeout interval must be between 1 minute and 7 days (10080 minutes).
' description: Contains information about the timeout configuration for a job. DeploymentFailureHandlingPolicy: type: string enum: - ROLLBACK - DO_NOTHING DeploymentComponentUpdatePolicy: type: object properties: timeoutInSeconds: allOf: - $ref: '#/components/schemas/OptionalInteger' - description: 'The amount of time in seconds that each component on a device has to report that it''s safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.
Default: 60
Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
NOTIFY_COMPONENTS – The
deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates
IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate
IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer
Guide.
SKIP_NOTIFY_COMPONENTS – The deployment doesn''t notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
Contains information about a deployment''s policy that defines when components are safe to update.
Each component on a device can report whether or not it''s ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.
' DeploymentConfigurationValidationPolicy: type: object properties: timeoutInSeconds: allOf: - $ref: '#/components/schemas/OptionalInteger' - description: 'The amount of time in seconds that a component can validate its configuration updates. If the validation time exceeds this timeout, then the deployment proceeds for the device.
Default: 30
The status of the core device. The core device status can be:
HEALTHY – The IoT Greengrass Core software and all components run on the core device
without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.
A list that summarizes each component on the core device.
Greengrass nucleus v2.7.0 or later is required to get an accurate
lastStatusChangeTimestamp response. This response can be inaccurate in earlier Greengrass nucleus versions.
Greengrass nucleus v2.8.0 or later is
required to get an accurate lastInstallationSource and lastReportedTimestamp response. This response can be inaccurate or null in earlier Greengrass nucleus
versions.
The version requirements for the component''s dependencies. Greengrass core devices get the version requirements from component recipes.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
' description: Contains information about a component that is a candidate to deploy to a Greengrass core device. TagResourceResponse: type: object properties: {} UntagResourceResponse: type: object properties: {} TagKey: type: string minLength: 1 maxLength: 128 UpdateConnectivityInfoResponse: type: object properties: version: allOf: - $ref: '#/components/schemas/String' - xml: name: Version description: The new version of the connectivity information for the core device. message: allOf: - $ref: '#/components/schemas/String' - xml: name: Message description: A message about the connectivity information update request. ConnectivityInfo: type: object properties: id: allOf: - $ref: '#/components/schemas/String' - xml: name: Id description: An ID for the connectivity information. hostAddress: allOf: - $ref: '#/components/schemas/String' - xml: name: HostAddress description: The IP address or DNS address where client devices can connect to an MQTT broker on the Greengrass core device. portNumber: allOf: - $ref: '#/components/schemas/PortNumberInt' - xml: name: PortNumber description: 'The port where the MQTT broker operates on the core device. This port is typically 8883, which is the default port for the MQTT broker component that runs on core devices.' metadata: allOf: - $ref: '#/components/schemas/String' - xml: name: Metadata description: Additional metadata to provide to client devices that connect to this core device. description: Contains information about an endpoint and port where client devices can connect to an MQTT broker on a Greengrass core device. IoTThingName: type: string minLength: 1 maxLength: 128 AssociateClientDeviceWithCoreDeviceEntryList: type: array items: $ref: '#/components/schemas/AssociateClientDeviceWithCoreDeviceEntry' minItems: 1 maxItems: 100 AssociateClientDeviceWithCoreDeviceErrorEntry: type: object properties: thingName: allOf: - $ref: '#/components/schemas/IoTThingName' - description: The name of the IoT thing whose associate request failed. code: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The error code for the request. message: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: A message that provides additional information about the error. description: 'Contains an error that occurs from a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice operation returns a list of these errors.' AssociateClientDeviceWithCoreDeviceErrorList: type: array items: $ref: '#/components/schemas/AssociateClientDeviceWithCoreDeviceErrorEntry' maxItems: 100 String: type: string AssociateServiceRoleToAccountRequest: type: object required: - roleArn title: AssociateServiceRoleToAccountRequest properties: roleArn: allOf: - $ref: '#/components/schemas/String' - xml: name: RoleArn description: The Amazon Resource Name (ARN) of the service role to associate with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Timestamp: type: string format: date-time AssociatedClientDevice: type: object properties: thingName: allOf: - $ref: '#/components/schemas/IoTThingName' - description: The name of the IoT thing that represents the associated client device. associationTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time that the client device was associated, expressed in ISO 8601 format.' description: Contains information about a client device that is associated to a core device for cloud discovery. AssociatedClientDeviceList: type: array items: $ref: '#/components/schemas/AssociatedClientDevice' minItems: 1 maxItems: 100 BatchAssociateClientDeviceWithCoreDeviceRequest: type: object title: BatchAssociateClientDeviceWithCoreDeviceRequest properties: entries: allOf: - $ref: '#/components/schemas/AssociateClientDeviceWithCoreDeviceEntryList' - description: The list of client devices to associate. DisassociateClientDeviceFromCoreDeviceEntryList: type: array items: $ref: '#/components/schemas/DisassociateClientDeviceFromCoreDeviceEntry' minItems: 1 maxItems: 100 BatchDisassociateClientDeviceFromCoreDeviceRequest: type: object title: BatchDisassociateClientDeviceFromCoreDeviceRequest properties: entries: allOf: - $ref: '#/components/schemas/DisassociateClientDeviceFromCoreDeviceEntryList' - description: The list of client devices to disassociate. DisassociateClientDeviceFromCoreDeviceErrorList: type: array items: $ref: '#/components/schemas/DisassociateClientDeviceFromCoreDeviceErrorEntry' maxItems: 100 CPU: type: number format: double minimum: 0 CancelDeploymentRequest: type: object title: CancelDeploymentRequest properties: {} ClientTokenString: type: string pattern: '^[a-zA-Z0-9-]+$' minLength: 1 maxLength: 64 CloudComponentState: type: string enum: - REQUESTED - INITIATED - DEPLOYABLE - FAILED - DEPRECATED StringMap: type: object additionalProperties: $ref: '#/components/schemas/NonEmptyString' VendorGuidance: type: string enum: - ACTIVE - DISCONTINUED - DELETED CloudComponentStatus: type: object properties: componentState: allOf: - $ref: '#/components/schemas/CloudComponentState' - description: The state of the component version. message: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: 'A message that communicates details, such as errors, about the status of the component version.' errors: allOf: - $ref: '#/components/schemas/StringMap' - description: 'A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can''t access an artifact for the component version, thenerrors contains the artifact''s URI as a key, and the error message as the value for that key.'
vendorGuidance:
allOf:
- $ref: '#/components/schemas/VendorGuidance'
- description: 'The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:
ACTIVE – This component version is available and recommended for use.
DISCONTINUED – This component version
has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.
DELETED
– This component version has been deleted by its publisher, so you can''t deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
/)
and use forward slashes to separate the key for each level in the object. For more information, see the JSON pointer specification and Reset configuration updates in the IoT Greengrass V2
Developer Guide.'
description: 'Contains information about a deployment''s update to a component''s configuration on Greengrass core devices. For more information, see Update
component configurations in the IoT Greengrass V2 Developer Guide.'
ComponentDependencyRequirement:
type: object
properties:
versionRequirement:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'The component version requirement for the component dependency.
IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
' dependencyType: allOf: - $ref: '#/components/schemas/ComponentDependencyType' - description: 'The type of this dependency. Choose from the following options:
SOFT – The component doesn''t restart if the dependency changes state.
HARD – The component restarts if the dependency changes state.
Default: HARD
The POSIX system user and, optionally, group to use to run this component on Linux core devices. The user, and group if specified, must exist on each Linux core device. Specify
the user and group separated by a colon (:) in the following format: user:group. The group is optional. If you don''t specify a group, the IoT Greengrass Core software
uses the primary user for the group.
If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
' systemResourceLimits: allOf: - $ref: '#/components/schemas/SystemResourceLimits' - description: 'The system resource limits to apply to this component''s process on the core device. IoT Greengrass currently supports this feature on only Linux core devices.
If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.
' windowsUser: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: 'The Windows user to use to run this component on Windows core devices. The user must exist on each Windows core device, and its name and password must be in the LocalSystem account''s Credentials Manager instance.
If you omit this parameter, the IoT Greengrass Core software uses the default Windows user that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
' description: 'Contains information system user and group that the IoT Greengrass Core software uses to run component processes on the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.' ComponentDeploymentSpecifications: type: object additionalProperties: $ref: '#/components/schemas/ComponentDeploymentSpecification' ComponentVersionARN: type: string pattern: 'arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):components:[^:]+:versions:[^:]+' ComponentList: type: array items: $ref: '#/components/schemas/Component' ComponentPlatform: type: object properties: name: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: 'The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, IoT Greengrass creates a friendly name from the os
and architecture of the platform.
os and architecture by default. You can specify additional platform
attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the Greengrass
nucleus component in the IoT Greengrass V2 Developer Guide.'
description: Contains information about a platform that a component supports.
SystemResourceLimits:
type: object
properties:
memory:
allOf:
- $ref: '#/components/schemas/Memory'
- description: 'The maximum amount of RAM, expressed in kilobytes, that a component''s processes can use on the core device.'
cpus:
allOf:
- $ref: '#/components/schemas/CPU'
- description: 'The maximum amount of CPU time that a component''s processes can use on the core device. A core device''s total CPU time is equivalent to the device''s number of CPU cores. For
example, on a core device with 4 CPU cores, you can set this value to 2 to limit the component''s processes to 50 percent usage of each CPU core. On a device with 1 CPU core,
you can set this value to 0.25 to limit the component''s processes to 25 percent usage of the CPU. If you set this value to a number greater than the number of CPU cores, the
IoT Greengrass Core software doesn''t limit the component''s CPU usage.'
description: 'Contains information about system resource limits that the IoT Greengrass Core software applies to a component''s processes. For more information, see Configure
system resource limits for components.'
ComponentVersionListItem:
type: object
properties:
componentName:
allOf:
- $ref: '#/components/schemas/ComponentNameString'
- description: The name of the component.
componentVersion:
allOf:
- $ref: '#/components/schemas/ComponentVersionString'
- description: The version of the component.
arn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'The ARN of the component version.'
description: Contains information about a component version in a list.
ComponentVersionList:
type: array
items:
$ref: '#/components/schemas/ComponentVersionListItem'
ComponentVisibilityScope:
type: string
enum:
- PRIVATE
- PUBLIC
PortNumberInt:
type: integer
minimum: 0
maximum: 65535
CoreDeviceThingName:
type: string
minLength: 1
maxLength: 128
CoreDeviceStatus:
type: string
enum:
- HEALTHY
- UNHEALTHY
CoreDevice:
type: object
properties:
coreDeviceThingName:
allOf:
- $ref: '#/components/schemas/CoreDeviceThingName'
- description: The name of the core device. This is also the name of the IoT thing.
status:
allOf:
- $ref: '#/components/schemas/CoreDeviceStatus'
- description: 'The status of the core device. Core devices can have the following statuses:
HEALTHY – The IoT Greengrass Core software and all components run
on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.
$LATEST.'
componentName:
allOf:
- $ref: '#/components/schemas/ComponentNameString'
- description: The name of the component.
Defaults to the name of the Lambda function.
componentVersion: allOf: - $ref: '#/components/schemas/ComponentVersionString' - description: 'The version of the component.
Defaults to the version of the Lambda function as a semantic version. For example, if your function version is 3, the component
version becomes 3.0.0.
The recipe to use to create the component. The recipe defines the component''s metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility.
You
must specify either inlineRecipe or lambdaFunction.
The parameters to create a component from a Lambda function.
You must specify either inlineRecipe or lambdaFunction.
The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.
Default: ROLLBACK
coreDeviceExecutionStatus is in a failed state. The response will be an empty list if there is no error.
errorTypes:
allOf:
- $ref: '#/components/schemas/EffectiveDeploymentErrorTypeList'
- description: Contains tags which describe the error. You can use the error types to classify errors to assist with remediating the failure. The response will be an empty list if there is
no error.
description: Contains all error-related information for the deployment record. The status details will be null if the deployment is in a success state.
Greengrass nucleus v2.8.0
or later is required to get an accurate errorStack and errorTypes response. This field will not be returned for earlier Greengrass nucleus versions.
The status of the deployment job on the Greengrass core device.
IN_PROGRESS – The deployment job is running.
QUEUED
– The deployment job is in the job queue and waiting to run.
FAILED – The deployment failed. For more information, see the statusDetails field.
COMPLETED – The deployment to an IoT thing was completed successfully.
TIMED_OUT – The deployment didn''t complete in the allotted
time.
CANCELED – The deployment was canceled by the user.
REJECTED – The deployment was rejected. For more information, see
the statusDetails field.
SUCCEEDED – The deployment to an IoT thing group was completed successfully.
The status of how current the data is.
This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.
' lastReportedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description:The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.
A component does not need to see a state change for this field to update.
lastInstallationSource: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: 'The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the The ID of
the deployment. and for local deployments it will be LOCAL.
Any deployment will attempt to reinstall currently broken components on the device, which will update the last installation source.
The status codes that indicate the reason for failure whenever the lifecycleState has an error or is in a broken state.
Greengrass nucleus v2.8.0
or later is required to get an accurate lifecycleStatusCodes response. This response can be inaccurate in earlier Greengrass nucleus versions.
The minimum percentage of failureType failures that occur before the job can cancel.
This parameter supports up to two digits after the decimal (for example,
you can specify 10.9 or 10.99, but not 10.999).
Contains criteria that define when and how to cancel a job.
The deployment stops if the following conditions are true:
The number of things that receive the
deployment exceeds the minNumberOfExecutedThings.
The percentage of failures with type failureType exceeds the thresholdPercentage.
The exponential factor to increase the rollout rate for the job.
This parameter supports up to one digit after the decimal (for example, you can specify 1.5,
but not 1.55).
numberOfNotifiedThings or numberOfSucceededThings.
IoTJobInProgressTimeoutInMinutes:
type: integer
IoTJobNumberOfThings:
type: integer
minimum: 1
OptionalBoolean:
type: boolean
LambdaVolumeList:
type: array
items:
$ref: '#/components/schemas/LambdaVolumeMount'
LambdaDeviceList:
type: array
items:
$ref: '#/components/schemas/LambdaDeviceMount'
LambdaContainerParams:
type: object
properties:
memorySizeInKB:
allOf:
- $ref: '#/components/schemas/OptionalInteger'
- description: 'The memory size of the container, expressed in kilobytes.
Default: 16384 (16 MB)
Whether or not the container can read information from the device''s /sys folder.
Default: false
The permission to access the device: read/only (ro) or read/write (rw).
Default: ro
Whether or not to add the component''s system user as an owner of the device.
Default: false
The type of event source. Choose from the following options:
PUB_SUB – Subscribe to local publish/subscribe messages. This event source type doesn''t
support MQTT wildcards (+ and #) in the event source topic.
IOT_CORE – Subscribe to Amazon Web Services IoT Core MQTT messages. This
event source type supports MQTT wildcards (+ and #) in the event source topic.
The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the IoT Greengrass container, or as a regular process outside any container.
Default: GreengrassContainer
The permission to access the volume: read/only (ro) or read/write (rw).
Default: ro
Whether or not to add the IoT Greengrass user group as an owner of the volume.
Default: false
The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:
ACTIVE – This component version is available and recommended for use.
DISCONTINUED – This component version
has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.
DELETED
– This component version has been deleted by its publisher, so you can''t deploy it. If you have any existing deployments that specify this component version, those deployments will fail.