DataAutomationforBedrock / Client / list_data_automation_library_entities

list_data_automation_library_entities

DataAutomationforBedrock.Client.list_data_automation_library_entities(**kwargs)

Lists all stored entities in the library

See also: AWS API Documentation

Request Syntax

response = client.list_data_automation_library_entities(
    libraryArn='string',
    entityType='VOCABULARY',
    maxResults=123,
    nextToken='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

• maxResults (integer) – Max Results

• nextToken (string) – Pagination token for retrieving the next set of results

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) –

    Pagination token for retrieving the next set of results

Exceptions

• DataAutomationforBedrock.Client.exceptions.ValidationException

• DataAutomationforBedrock.Client.exceptions.InternalServerException

• DataAutomationforBedrock.Client.exceptions.ThrottlingException

• DataAutomationforBedrock.Client.exceptions.AccessDeniedException

• DataAutomationforBedrock.Client.exceptions.ResourceNotFoundException