GreengrassV2 / Paginator / ListComponentVersions

ListComponentVersions#

class GreengrassV2.Paginator.ListComponentVersions#

paginator = client.get_paginator('list_component_versions')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from GreengrassV2.Client.list_component_versions().

Request Syntax

response_iterator = paginator.paginate(
    arn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

arn (string) –
[REQUIRED]

The ARN of the component.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'componentVersions': [
        {
            'componentName': 'string',
            'componentVersion': 'string',
            'arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- componentVersions (list) –
  
  A list of versions that exist for the component.
  - (dict) –
    
    Contains information about a component version in a list.
    - componentName (string) –
      
      The name of the component.
    - componentVersion (string) –
      
      The version of the component.
    - arn (string) –
      
      The ARN of the component version.
- NextToken (string) –
  
  A token to resume pagination.