DataAutomationforBedrock / Client / get_data_automation_library_entity

get_data_automation_library_entity

DataAutomationforBedrock.Client.get_data_automation_library_entity(**kwargs)

Gets an existing entity based on entity type from the library

See also: AWS API Documentation

Request Syntax

response = client.get_data_automation_library_entity(
    libraryArn='string',
    entityType='VOCABULARY',
    entityId='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 is requested

  • entityId (string) –

    [REQUIRED]

    Unique identifier for the entity

Return type:

dict

Returns:

Response Syntax

{
    'entity': {
        'vocabulary': {
            'entityId': 'string',
            'description': 'string',
            'language': 'EN'|'DE'|'ES'|'FR'|'IT'|'PT'|'JA'|'KO'|'CN'|'TW'|'HK',
            'phrases': [
                {
                    'text': 'string',
                    'displayAsText': 'string'
                },
            ],
            'lastModifiedTime': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) –

    Get DataAutomationLibraryEntity Response

    • entity (dict) –

      Detailed information about the 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) –

        Vocabulary entity with detailed information

        • entityId (string) –

          Unique identifier for the entity

        • description (string) –

          Description of the entity

        • language (string) –

          Supported input languages

        • phrases (list) –

          List of phrases

          • (dict) –

            Phrase structure for vocabulary

            • text (string) –

              Text content of the phrase

            • displayAsText (string) –

              Text to configure how phrase is displayed in Transcript

        • lastModifiedTime (datetime) –

          Time Stamp

Exceptions