GreengrassV2 / Client / list_components

list_components#

GreengrassV2.Client.list_components(**kwargs)#

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

Request Syntax

response = client.list_components(
    scope='PRIVATE'|'PUBLIC',
    maxResults=123,
    nextToken='string'
)

Parameters:

scope (string) –
The scope of the components to list.

Default: PRIVATE
maxResults (integer) – The maximum number of results to be returned per paginated request.
nextToken (string) – The token to be used for the next set of paginated results.

Return type:

dict

Returns:

Response Syntax

{
    'components': [
        {
            'arn': 'string',
            'componentName': 'string',
            'latestVersion': {
                'arn': 'string',
                'componentVersion': 'string',
                'creationTimestamp': datetime(2015, 1, 1),
                'description': 'string',
                'publisher': 'string',
                'platforms': [
                    {
                        'name': 'string',
                        'attributes': {
                            'string': 'string'
                        }
                    },
                ]
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- components (list) –
  
  A list that summarizes each component.
  - (dict) –
    
    Contains information about a component.
    - arn (string) –
      
      The ARN of the component version.
    - componentName (string) –
      
      The name of the component.
    - latestVersion (dict) –
      
      The latest version of the component and its details.
      - arn (string) –
        
        The ARN of the component version.
      - componentVersion (string) –
        
        The version of the component.
      - creationTimestamp (datetime) –
        
        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 (list) –
        
        The platforms that the component version supports.
        
        (dict) –
        
        Contains information about a platform that a component supports.
        
        name (string) –
        
        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.
        
        attributes (dict) –
        
        A dictionary of attributes for the platform. The IoT Greengrass Core software defines the 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.
        
        (string) –
        
        (string) –
- nextToken (string) –
  
  The token for the next set of results, or null if there are no additional results.

Exceptions

GreengrassV2.Client.exceptions.ValidationException
GreengrassV2.Client.exceptions.AccessDeniedException
GreengrassV2.Client.exceptions.ResourceNotFoundException
GreengrassV2.Client.exceptions.ThrottlingException
GreengrassV2.Client.exceptions.InternalServerException