DataAutomationforBedrock / Paginator / ListDataAutomationLibraryEntities

ListDataAutomationLibraryEntities

class DataAutomationforBedrock.Paginator.ListDataAutomationLibraryEntities

paginator = client.get_paginator('list_data_automation_library_entities')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataAutomationforBedrock.Client.list_data_automation_library_entities().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• libraryArn (string) –

  [REQUIRED]

  ARN generated at the server side when a DataAutomationLibrary is created

• entityType (string) –

  [REQUIRED]

  The entity type for which the entity list is requested

• 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

{
    'entities': [
        {
            'vocabulary': {
                'entityId': 'string',
                'description': 'string',
                'language': 'EN'|'DE'|'ES'|'FR'|'IT'|'PT'|'JA'|'KO'|'CN'|'TW'|'HK',
                'numOfPhrases': 123,
                'lastModifiedTime': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  List DataAutomationLibraryEntities Response

  • entities (list) –

    List of entities

    • (dict) –

      Summarized information about an entity

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: vocabulary. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • vocabulary (dict) –

        Summary of a Vocabulary entity

        • entityId (string) –

          Unique identifier for the entity

        • description (string) –

          Description of the entity

        • language (string) –

          Supported input languages

        • numOfPhrases (integer) –

          num of phrases in the entity

        • lastModifiedTime (datetime) –

          Time Stamp

  • NextToken (string) –

    A token to resume pagination.