Amazon IoT Greengrass Greengrass API
The Greengrass API from Amazon IoT Greengrass — 19 operation(s) for greengrass.
Amazon IoT Greengrass Greengrass API is one of 2 APIs that Amazon IoT Greengrass publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Greengrass. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.
This API exposes 26 operations across 19 paths, and defines 163 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://greengrass.{region}.amazonaws.com, https://greengrass.{region}.amazonaws.com, http://greengrass.{region}.amazonaws.com.cn, https://greengrass.{region}.amazonaws.com.cn.
26 operations
19 paths
163 schemas
4 DELETE14 GET6 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Amazon IoT Greengrass Greengrass API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 26
Across 19 paths, the API surfaces 26 operations — 4 DELETE, 14 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Greengrass 26
PUT
/greengrass/servicerole
Amazon IoT Greengrass Associate Service Role to Account
DELETE
/greengrass/servicerole
Amazon IoT Greengrass Disassociate Service Role from Account
GET
/greengrass/servicerole
Amazon IoT Greengrass Get Service Role for Account
POST
/greengrass/v2/coreDevices/{coreDeviceThingName}/associateClientDevices
Amazon IoT Greengrass Batch Associate Client Device with Core Device
POST
/greengrass/v2/coreDevices/{coreDeviceThingName}/disassociateClientDevices
Amazon IoT Greengrass Batch Disassociate Client Device from Core Device
POST
/greengrass/v2/deployments/{deploymentId}/cancel
Amazon IoT Greengrass Cancel Deployment
POST
/greengrass/v2/createComponentVersion
Amazon IoT Greengrass Create Component Version
POST
/greengrass/v2/deployments
Amazon IoT Greengrass Create Deployment
GET
/greengrass/v2/deployments
Amazon IoT Greengrass List Deployments
DELETE
/greengrass/v2/components/{arn}
Amazon IoT Greengrass Delete Component
GET
/greengrass/v2/components/{arn}
Amazon IoT Greengrass Get Component
DELETE
/greengrass/v2/coreDevices/{coreDeviceThingName}
Amazon IoT Greengrass Delete Core Device
GET
/greengrass/v2/coreDevices/{coreDeviceThingName}
Amazon IoT Greengrass Get Core Device
DELETE
/greengrass/v2/deployments/{deploymentId}
Amazon IoT Greengrass Delete Deployment
GET
/greengrass/v2/deployments/{deploymentId}
Amazon IoT Greengrass Get Deployment
GET
/greengrass/v2/components/{arn}/metadata
Amazon IoT Greengrass Describe Component
GET
/greengrass/v2/components/{arn}/artifacts/{artifactName}
Amazon IoT Greengrass Get Component Version Artifact
GET
/greengrass/things/{thingName}/connectivityInfo
Amazon IoT Greengrass Get Connectivity Info
PUT
/greengrass/things/{thingName}/connectivityInfo
Amazon IoT Greengrass Update Connectivity Info
GET
/greengrass/v2/coreDevices/{coreDeviceThingName}/associatedClientDevices
Amazon IoT Greengrass List Client Devices Associated with Core Device
GET
/greengrass/v2/components/{arn}/versions
Amazon IoT Greengrass List Component Versions
GET
/greengrass/v2/components
Amazon IoT Greengrass List Components
GET
/greengrass/v2/coreDevices
Amazon IoT Greengrass List Core Devices
GET
/greengrass/v2/coreDevices/{coreDeviceThingName}/effectiveDeployments
Amazon IoT Greengrass List Effective Deployments
GET
/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents
Amazon IoT Greengrass List Installed Components
POST
/greengrass/v2/resolveComponentCandidates
Amazon IoT Greengrass Resolve Component Candidates
Schemas 163
The contract defines 163 schemas that model the data the API accepts and returns. The most detailed are GetDeploymentResponse (14 properties), LambdaExecutionParameters (11 properties), EffectiveDeployment (11 properties), DescribeComponentResponse (9 properties). Each schema is shown below with its type and property counts.
ConflictException
StringMap
object
LambdaEnvironmentVariables
object
IsRoot
boolean
IoTJobAbortCriteriaList
array
InstalledComponentLifecycleStatusCodeList
array
ComponentCandidate
object
Contains information about a component that is a candidate to deploy to a Greengrass core device.
3 properties
ComponentDependencyType
string
LambdaVolumeMount
object
Contains information about a volume that Linux processes in a container can access. When you define a volume, the IoT Greengrass Core software mounts the sourc…
4 properties
2 required
LambdaExecArg
string
GetComponentVersionArtifactResponse
object
1 property
1 required
OptionalInteger
integer
DescribeComponentResponse
object
9 properties
Component
object
Contains information about a component.
3 properties
RecipeBlob
string
CoreDeviceStatus
string
ConnectivityInfo
object
Contains information about an endpoint and port where client devices can connect to an MQTT broker on a Greengrass core device.
4 properties
ComponentDependencyRequirement
object
Contains information about a component dependency for a Lambda function component.
2 properties
ThingGroupARN
string
DescriptionString
string
NonEmptyString
string
IoTJobRolloutBaseRatePerMinute
integer
Deployment
object
Contains information about a deployment.
8 properties
PublisherString
string
LambdaExecArgsList
array
ComponentVersionRequirementMap
object
InstalledComponentList
array
ResourceNotFoundException
ThrottlingException
LambdaInputPayloadEncodingType
string
LambdaFilesystemPermission
string
OptionalBoolean
boolean
ServiceQuotaExceededException
BatchAssociateClientDeviceWithCoreDeviceResponse
object
1 property
LambdaExecutionParameters
object
Contains parameters for a Lambda function that runs on IoT Greengrass.
11 properties
GetServiceRoleForAccountResponse
object
2 properties
RequestAlreadyInProgressException
ComponentNameString
string
DeploymentComponentUpdatePolicyAction
string
AccessDeniedException
DeploymentPolicies
object
Contains information about policies that define how a deployment updates components and handles failure.
3 properties
ComponentConfigurationUpdate
object
Contains information about a deployment's update to a component's configuration on Greengrass core devices. For more information, see Update component configur…
2 properties
AssociateClientDeviceWithCoreDeviceErrorList
array
EffectiveDeploymentErrorType
string
LambdaLinuxProcessParams
object
Contains parameters for a Linux process that contains an Lambda function.
2 properties
ResolvedComponentVersion
object
Contains information about a component version that is compatible to run on a Greengrass core device.
6 properties
Timestamp
string
LambdaDeviceMount
object
Contains information about a device that Linux processes in a container can access.
3 properties
1 required
String
string
GetDeploymentResponse
object
14 properties
CreateDeploymentResponse
object
3 properties
LambdaVolumeList
array
LifecycleStateDetails
string
GetConnectivityInfoResponse
object
2 properties
EffectiveDeploymentErrorCode
string
CloudComponentStatus
object
Contains the status of a component version in the IoT Greengrass service.
5 properties
ComponentARN
string
CoreDevicePlatformString
string
ComponentList
array
CreateComponentVersionResponse
object
5 properties
4 required
IoTJobNumberOfThings
integer
DeploymentIoTJobConfiguration
object
Contains information about an IoT job configuration.
3 properties
VendorGuidance
string
EffectiveDeploymentErrorStack
array
InstalledComponent
object
Contains information about a component on a Greengrass core device.
9 properties
TagValue
string
AssociatedClientDeviceList
array
ListComponentVersionsResponse
object
2 properties
LambdaDeviceList
array
TopicString
string
EffectiveDeploymentExecutionStatus
string
InternalServerException
ComponentVersionList
array
PortNumberInt
integer
ComponentDependencyMap
object
connectivityInfoList
array
TargetARN
string
DisassociateClientDeviceFromCoreDeviceErrorList
array
ComponentConfigurationPath
string
CoreDeviceThingName
string
DeploymentName
string
IoTJobRolloutIncrementFactor
number
IoTJobExecutionFailureType
string
LambdaEventSourceType
string
EffectiveDeploymentsList
array
DisassociateClientDeviceFromCoreDeviceEntry
object
Contains a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice operation consumes a list of these reque…
1 property
1 required
IoTJobExecutionsRolloutConfig
object
Contains information about the rollout configuration for a job. This configuration defines the rate at which the job deploys a configuration to a fleet of targ…
2 properties
DisassociateClientDeviceFromCoreDeviceErrorEntry
object
Contains an error that occurs from a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice operation retu…
3 properties
ResolveComponentCandidatesResponse
object
1 property
NullableString
string
ListInstalledComponentsResponse
object
2 properties
IoTJobMaxExecutionsPerMin
integer
ComponentDeploymentSpecification
object
Contains information about a component to deploy.
3 properties
CloudComponentState
string
GetCoreDeviceResponse
object
7 properties
ListEffectiveDeploymentsResponse
object
2 properties
ListClientDevicesAssociatedWithCoreDeviceResponse
object
2 properties
IoTJobMinimumNumberOfExecutedThings
integer
IoTJobExponentialRolloutRate
object
Contains information about an exponential rollout rate for a configuration deployment job.
3 properties
3 required
ComponentDeploymentSpecifications
object
LambdaEventSourceList
array
IoTJobAbortCriteria
object
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 de…
4 properties
4 required
IoTJobAbortConfig
object
Contains a list of criteria that define when and how to cancel a configuration deployment.
1 property
1 required
DeploymentStatus
string
IoTJobTimeoutConfig
object
Contains information about the timeout configuration for a job.
1 property
AssociateClientDeviceWithCoreDeviceEntry
object
Contains a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice operation consumes a list of these requests.
1 property
1 required
LambdaContainerParams
object
Contains information about a container in which Lambda functions run on Greengrass core devices.
4 properties
AssociateServiceRoleToAccountResponse
object
1 property
IoTJobRateIncreaseCriteria
object
Contains information about criteria to meet before a job increases its rollout rate. Specify either numberOfNotifiedThings or numberOfSucceededThings .
2 properties
EffectiveDeploymentStatusDetails
object
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 v…
2 properties
AssociateClientDeviceWithCoreDeviceErrorEntry
object
Contains an error that occurs from a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice operation returns a…
3 properties
ResolvedComponentVersionsList
array
ValidationException
TagMap
object
ListCoreDevicesResponse
object
2 properties
ComponentVersionListItem
object
Contains information about a component version in a list.
3 properties
UpdateConnectivityInfoResponse
object
2 properties
GetComponentResponse
object
3 properties
2 required
IoTJobInProgressTimeoutInMinutes
integer
CoreDevice
object
Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass Core software.
3 properties
DeploymentFailureHandlingPolicy
string
Memory
integer
ComponentLatestVersion
object
Contains information about the latest version of a component.
6 properties
GGCVersion
string
DeploymentConfigurationValidationPolicy
object
Contains information about how long a component on a core device can validate its configuration updates before it times out. Components can use the SubscribeTo…
1 property
PlatformAttributesMap
object
FileSystemPath
string
ComponentPlatformList
array
ListComponentsResponse
object
2 properties
ComponentRunWith
object
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…
3 properties
DeploymentID
string
IoTJobAbortAction
string
BatchDisassociateClientDeviceFromCoreDeviceResponse
object
1 property
Reason
string
RecipeOutputFormat
string
IoTJobAbortThresholdPercentage
number
InstalledComponentLifecycleStatusCode
string
CancelDeploymentResponse
object
1 property
SystemResourceLimits
object
Contains information about system resource limits that the IoT Greengrass Core software applies to a component's processes. For more information, see Configure…
2 properties
IoTThingName
string
Description
string
ComponentPlatform
object
Contains information about a platform that a component supports.
2 properties
CPU
number
AssociatedClientDevice
object
Contains information about a client device that is associated to a core device for cloud discovery.
2 properties
ListDeploymentsResponse
object
2 properties
IoTJobARN
string
EffectiveDeployment
object
Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.
11 properties
6 required
EffectiveDeploymentErrorTypeList
array
ComponentVersionString
string
IsLatestForTarget
boolean
LambdaEventSource
object
Contains information about an event source for an Lambda function. The event source defines the topics on which this Lambda function subscribes to receive mess…
2 properties
2 required
ComponentConfigurationString
string
DisassociateServiceRoleFromAccountResponse
object
1 property
IoTJobId
string
CoreDevicesList
array
InstalledComponentLifecycleState
string
NextTokenString
string
ComponentVersionARN
string
ComponentConfigurationPathList
array
LambdaIsolationMode
string
CoreDeviceArchitectureString
string
DeploymentComponentUpdatePolicy
object
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 rea…
2 properties
DeploymentList
array
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Amazon IoT Greengrass 1
Other APIs Amazon IoT Greengrass publishes across the network.
Amazon IoT Greengrass Tags API
#Greengrass
Where this information came from
This is an independent, third-party profile of Amazon IoT Greengrass Greengrass API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.