Glue / Paginator / ListIterableForms

ListIterableForms¶

class Glue.Paginator.ListIterableForms¶

paginator = client.get_paginator('list_iterable_forms')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Glue.Client.list_iterable_forms().

Request Syntax

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

Parameters:

AssetIdentifier (string) –
[REQUIRED]

The unique identifier of the asset.
IterableFormName (string) –
[REQUIRED]

The name of the iterable form to list items from.
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': [
        {
            'ItemId': 'string',
            'ItemName': 'string',
            'Description': 'string',
            'GlossaryTerms': [
                'string',
            ]
        },
    ],

}

Response Structure

(dict) –
- Items (list) –
  
  The list of iterable form items.
  - (dict) –
    
    A summary of an item in an iterable form.
    - ItemId (string) –
      
      The unique identifier of the item.
    - ItemName (string) –
      
      The name of the item.
    - Description (string) –
      
      The description of the item.
    - GlossaryTerms (list) –
      
      The identifiers of the glossary terms associated with the item.
      - (string) –