TimestreamInfluxDB / Paginator / ListDbParameterGroups

ListDbParameterGroups#

class TimestreamInfluxDB.Paginator.ListDbParameterGroups#
paginator = client.get_paginator('list_db_parameter_groups')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from TimestreamInfluxDB.Client.list_db_parameter_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

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      A list of Timestream for InfluxDB DB parameter group summaries.

      • (dict) –

        Contains a summary of a DB parameter group.

        • id (string) –

          A service-generated unique identifier.

        • name (string) –

          This customer-supplied name uniquely identifies the parameter group.

        • arn (string) –

          The Amazon Resource Name (ARN) of the DB parameter group.

        • description (string) –

          A description of the DB parameter group.

    • NextToken (string) –

      A token to resume pagination.