Glue / Client / list_iterable_forms

list_iterable_forms¶

Glue.Client.list_iterable_forms(**kwargs)¶

Lists the items in an iterable form on an asset in Glue Data Catalog. For example, lists the columns of a table asset.

Request Syntax

response = client.list_iterable_forms(
    AssetIdentifier='string',
    IterableFormName='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

AssetIdentifier (string) –
[REQUIRED]

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

The name of the iterable form to list items from.
MaxResults (integer) – The maximum number of results to return in the response.
NextToken (string) – A continuation token, if this is a continuation call.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'ItemId': 'string',
            'ItemName': 'string',
            'Description': 'string',
            'GlossaryTerms': [
                'string',
            ]
        },
    ],
    'NextToken': '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) –
- NextToken (string) –
  
  A continuation token, present if the current segment is not the last.

Exceptions

Glue.Client.exceptions.AccessDeniedException
Glue.Client.exceptions.EntityNotFoundException
Glue.Client.exceptions.InternalServiceException
Glue.Client.exceptions.ThrottlingException
Glue.Client.exceptions.InvalidInputException