---
title: "GET /greengrass/v2/components"
method: GET
path: "/greengrass/v2/components"
---

# GET /greengrass/v2/components

`GET /greengrass/v2/components`

Retrieves a paginated list of component summaries. This list includes components that you have permission to view.

## Query parameters

- `scope` 'PRIVATE' | 'PUBLIC'
- `maxResults` integer
- `nextToken` string

## Response `200`

Success

- ListComponentsResponse
  - `components` Component[] — A list that summarizes each component.
    - `arn` string — The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.
    - `componentName` string — The name of the component.
    - `latestVersion` object — The latest version of the component and its details.
      - `arn` string — The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.
      - `componentVersion` string — The version of the component.
      - `creationTimestamp` string, date-time — The time at which the component was created, expressed in ISO 8601 format.
      - `description` string — The description of the component version.
      - `publisher` string — The publisher of the component version.
      - `platforms` ComponentPlatform[] — The platforms that the component version supports.
        - `name` string — <p>The friendly name of the platform. This name helps you identify the platform.</p> <p>If you omit this parameter, IoT Greengrass creates a friendly name from the <code>os</code> and <code>architecture</code> of the platform.</p>
        - `attributes` object — A dictionary of attributes for the platform. The IoT Greengrass Core software defines the <code>os</code> and <code>architecture</code> by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html">Greengrass nucleus component</a> in the <i>IoT Greengrass V2 Developer Guide</i>.
  - `nextToken` string — The token for the next set of results, or null if there are no additional results.

## Other responses

- `480` — ValidationException
- `481` — AccessDeniedException
- `482` — ResourceNotFoundException
- `483` — ThrottlingException
- `484` — InternalServerException

---

[API](https://skmtc.net/aws/apis/greengrassv2.md) · [All operations](https://skmtc.net/aws/apis/greengrassv2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/greengrassv2/versions/f491b1d234d1/schema)