DataAutomationforBedrock / Client / invoke_data_automation_library_ingestion_job

invoke_data_automation_library_ingestion_job

DataAutomationforBedrock.Client.invoke_data_automation_library_ingestion_job(**kwargs)

Async API: Invoke data automation library ingestion job

See also: AWS API Documentation

Request Syntax

response = client.invoke_data_automation_library_ingestion_job(
    libraryArn='string',
    clientToken='string',
    inputConfiguration={
        's3Object': {
            's3Uri': 'string',
            'version': 'string'
        },
        'inlinePayload': {
            'upsertEntitiesInfo': [
                {
                    'vocabulary': {
                        'entityId': 'string',
                        'description': 'string',
                        'language': 'EN'|'DE'|'ES'|'FR'|'IT'|'PT'|'JA'|'KO'|'CN'|'TW'|'HK',
                        'phrases': [
                            {
                                'text': 'string',
                                'displayAsText': 'string'
                            },
                        ]
                    }
                },
            ],
            'deleteEntitiesInfo': {
                'entityIds': [
                    'string',
                ]
            }
        }
    },
    entityType='VOCABULARY',
    operationType='UPSERT'|'DELETE',
    outputConfiguration={
        's3Uri': 'string'
    },
    notificationConfiguration={
        'eventBridgeConfiguration': {
            'eventBridgeEnabled': True|False
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

• libraryArn (string) –

  [REQUIRED]

  ARN generated at the server side when a DataAutomationLibrary is created

• clientToken (string) –

  Idempotency token

  This field is autopopulated if not provided.

• inputConfiguration (dict) –

  [REQUIRED]

  Input configuration of DataAutomationLibraryIngestionJob request

  • s3Object (dict) –

    S3 object

    • s3Uri (string) – [REQUIRED]

      S3 uri.

    • version (string) –

      S3 object version.

  • inlinePayload (dict) –

    Input Payload

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: upsertEntitiesInfo, deleteEntitiesInfo.

    • upsertEntitiesInfo (list) –

      List of UpsertEntityInfo for upserting data in a DataAutomationLibraryIngestionJob

      • (dict) –

        Input configuration for upserting data in a DataAutomationLibraryIngestionJob

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: vocabulary.

        • vocabulary (dict) –

          Vocabulary entity info with detailed information

          • entityId (string) –

            Unique identifier for the entity

          • description (string) –

            Description of the entity

          • language (string) – [REQUIRED]

            Supported input languages

          • phrases (list) – [REQUIRED]

            List of phrases

            • (dict) –

              Phrase structure for vocabulary

              • text (string) – [REQUIRED]

                Text content of the phrase

              • displayAsText (string) –

                Text to configure how phrase is displayed in Transcript

    • deleteEntitiesInfo (dict) –

      Input for entities needed to be deleted

      • entityIds (list) – [REQUIRED]

        List of EntityId

        • (string) –

          Unique identifier for the entity

• entityType (string) –

  [REQUIRED]

  The entity type for which DataAutomationLibraryIngestionJob is being run

• operationType (string) –

  [REQUIRED]

  The operation to be performed by DataAutomationLibraryIngestionJob

• outputConfiguration (dict) –

  [REQUIRED]

  Output configuration of DataAutomationLibraryIngestionJob

  • s3Uri (string) – [REQUIRED]

    S3 Uri

• notificationConfiguration (dict) –

  Notification configuration.

  • eventBridgeConfiguration (dict) – [REQUIRED]

    Event bridge configuration.

    • eventBridgeEnabled (boolean) – [REQUIRED]

      Event bridge flag.

• tags (list) –

  List of tags

  • (dict) –

    Key value pair of a tag

    • key (string) – [REQUIRED]

      Defines the context of the tag.

    • value (string) – [REQUIRED]

      Defines the value within the context. e.g. <key=reason, value=training>.

Return type:

dict

Returns:

Response Syntax

{
    'jobArn': 'string'
}

Response Structure

• (dict) –

  Invoke DataAutomationLibraryIngestionJob Response

  • jobArn (string) –

    ARN of the DataAutomationLibraryIngestionJob

Exceptions

• DataAutomationforBedrock.Client.exceptions.ServiceQuotaExceededException

• DataAutomationforBedrock.Client.exceptions.ValidationException

• DataAutomationforBedrock.Client.exceptions.ConflictException

• DataAutomationforBedrock.Client.exceptions.InternalServerException

• DataAutomationforBedrock.Client.exceptions.ThrottlingException

• DataAutomationforBedrock.Client.exceptions.AccessDeniedException

• DataAutomationforBedrock.Client.exceptions.ResourceNotFoundException