Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListComponents

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

Request Syntax


GET /greengrass/v2/components?maxResults=maxResults&nextToken=nextToken&scope=scope HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

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

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

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

scope

The scope of the components to list.

Default: PRIVATE

Valid Values: PRIVATE | PUBLIC

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "components": [ 
      { 
         "arn": "string",
         "componentName": "string",
         "latestVersion": { 
            "arn": "string",
            "componentVersion": "string",
            "creationTimestamp": number,
            "description": "string",
            "platforms": [ 
               { 
                  "attributes": { 
                     "string" : "string" 
                  },
                  "name": "string"
               }
            ],
            "publisher": "string"
         }
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

components

A list that summarizes each component.

Type: Array of Component objects

nextToken

The token for the next set of results, or null if there are no additional results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerException

AWS IoT Greengrass can't process your request right now. Try again later.

retryAfterSeconds: The amount of time to wait before you retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

resourceId: The ID of the resource that isn't found.
resourceType: The type of the resource that isn't found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

quotaCode: The code for the quota in Service Quotas.
retryAfterSeconds: The amount of time to wait before you retry the request.
serviceCode: The code for the service in Service Quotas.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

fields: The list of fields that failed to validate.
reason: The reason for the validation exception.

HTTP Status Code: 400