Greengrass / Paginator / ListGroups

ListGroups

class Greengrass.Paginator.ListGroups

paginator = client.get_paginator('list_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Greengrass.Client.list_groups().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'Groups': [
        {
            'Arn': 'string',
            'CreationTimestamp': 'string',
            'Id': 'string',
            'LastUpdatedTimestamp': 'string',
            'LatestVersion': 'string',
            'LatestVersionArn': 'string',
            'Name': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Groups (list) – Information about a group.

    • (dict) – Information about a group.

      • Arn (string) – The ARN of the group.

      • CreationTimestamp (string) – The time, in milliseconds since the epoch, when the group was created.

      • Id (string) – The ID of the group.

      • LastUpdatedTimestamp (string) – The time, in milliseconds since the epoch, when the group was last updated.

      • LatestVersion (string) – The ID of the latest version associated with the group.

      • LatestVersionArn (string) – The ARN of the latest version associated with the group.

      • Name (string) – The name of the group.