Own AWS? Customize your docs with AI search, analytics, and more.

GET

/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents

http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents

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 <code>topologyFilter</code> parameter to <code>ALL</code>. <note> 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: <ul> <li> When the IoT Greengrass Core software starts </li> <li> When the core device receives a deployment from the Amazon Web Services Cloud </li> <li> When the status of any component on the core device becomes <code>BROKEN</code> </li> <li> At a <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss">regular interval that you can configure</a>, which defaults to 24 hours </li> <li> For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment </li> </ul> </note>

Access Token Required: API Key

Path Parameters

coreDeviceThingNamestringrequired

The name of the core device. This is also the name of the IoT thing.

Query Params

maxResultsinteger

The maximum number of results to be returned per paginated request.

nextTokenstring

The token to be used for the next set of paginated results.

topologyFilterstring

The filter for the list of components. Choose from the following options: <ul> <li> <code>ALL</code> – The list includes all components installed on the core device. </li> <li> <code>ROOT</code> – 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. </li> </ul> Default: <code>ROOT</code>

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents

http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents

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 <code>topologyFilter</code> parameter to <code>ALL</code>. <note> 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: <ul> <li> When the IoT Greengrass Core software starts </li> <li> When the core device receives a deployment from the Amazon Web Services Cloud </li> <li> When the status of any component on the core device becomes <code>BROKEN</code> </li> <li> At a <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss">regular interval that you can configure</a>, which defaults to 24 hours </li> <li> For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment </li> </ul> </note>

Access Token Required: API Key

Path Parameters

coreDeviceThingNamestringrequired

The name of the core device. This is also the name of the IoT thing.

Query Params

maxResultsinteger

The maximum number of results to be returned per paginated request.

nextTokenstring

The token to be used for the next set of paginated results.

topologyFilterstring

The filter for the list of components. Choose from the following options: <ul> <li> <code>ALL</code> – The list includes all components installed on the core device. </li> <li> <code>ROOT</code> – 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. </li> </ul> Default: <code>ROOT</code>

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents

http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents

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 <code>topologyFilter</code> parameter to <code>ALL</code>. <note> 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: <ul> <li> When the IoT Greengrass Core software starts </li> <li> When the core device receives a deployment from the Amazon Web Services Cloud </li> <li> When the status of any component on the core device becomes <code>BROKEN</code> </li> <li> At a <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss">regular interval that you can configure</a>, which defaults to 24 hours </li> <li> For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment </li> </ul> </note>

Access Token Required: API Key

Path Parameters

coreDeviceThingNamestringrequired

The name of the core device. This is also the name of the IoT thing.

Query Params

maxResultsinteger

The maximum number of results to be returned per paginated request.

nextTokenstring

The token to be used for the next set of paginated results.

topologyFilterstring

The filter for the list of components. Choose from the following options: <ul> <li> <code>ALL</code> – The list includes all components installed on the core device. </li> <li> <code>ROOT</code> – 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. </li> </ul> Default: <code>ROOT</code>

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents

http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents

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 <code>topologyFilter</code> parameter to <code>ALL</code>. <note> 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: <ul> <li> When the IoT Greengrass Core software starts </li> <li> When the core device receives a deployment from the Amazon Web Services Cloud </li> <li> When the status of any component on the core device becomes <code>BROKEN</code> </li> <li> At a <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss">regular interval that you can configure</a>, which defaults to 24 hours </li> <li> For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment </li> </ul> </note>

Access Token Required: API Key

Path Parameters

coreDeviceThingNamestringrequired

The name of the core device. This is also the name of the IoT thing.

Query Params

maxResultsinteger

The maximum number of results to be returned per paginated request.

nextTokenstring

The token to be used for the next set of paginated results.

topologyFilterstring

The filter for the list of components. Choose from the following options: <ul> <li> <code>ALL</code> – The list includes all components installed on the core device. </li> <li> <code>ROOT</code> – 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. </li> </ul> Default: <code>ROOT</code>

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}