Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-data-automation ]

invoke-data-automation-library-ingestion-job

Description

Async API: Invoke data automation library ingestion job

See also: AWS API Documentation

Synopsis

  invoke-data-automation-library-ingestion-job
--library-arn <value>
[--client-token <value>]
--input-configuration <value>
--entity-type <value>
--operation-type <value>
--output-configuration <value>
[--notification-configuration <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--library-arn (string)

ARN generated at the server side when a DataAutomationLibrary is created

--client-token (string)

Idempotency token

--input-configuration (structure)

Input configuration of DataAutomationLibraryIngestionJob request

s3Object -> (structure)

S3 object

s3Uri -> (string)

S3 uri.

version -> (string)

S3 object version.

inlinePayload -> (tagged union structure)

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

(tagged union structure)

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 -> (structure)

Vocabulary entity info 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

(structure)

Phrase structure for vocabulary

text -> (string)

Text content of the phrase

displayAsText -> (string)

Text to configure how phrase is displayed in Transcript

deleteEntitiesInfo -> (structure)

Input for entities needed to be deleted

entityIds -> (list)

List of EntityId

(string)

Unique identifier for the entity

JSON Syntax:

{
  "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", ...]
    }
  }
}

--entity-type (string)

The entity type for which DataAutomationLibraryIngestionJob is being run

Possible values:

• VOCABULARY

--operation-type (string)

The operation to be performed by DataAutomationLibraryIngestionJob

Possible values:

• UPSERT
• DELETE

--output-configuration (structure)

Output configuration of DataAutomationLibraryIngestionJob

s3Uri -> (string)

S3 Uri

Shorthand Syntax:

s3Uri=string

JSON Syntax:

{
  "s3Uri": "string"
}

--notification-configuration (structure)

Notification configuration.

eventBridgeConfiguration -> (structure)

Event bridge configuration.

eventBridgeEnabled -> (boolean)

Event bridge flag.

Shorthand Syntax:

eventBridgeConfiguration={eventBridgeEnabled=boolean}

JSON Syntax:

{
  "eventBridgeConfiguration": {
    "eventBridgeEnabled": true|false
  }
}

--tags (list)

List of tags

(structure)

Key value pair of a tag

key -> (string)

Defines the context of the tag.

value -> (string)

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

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

jobArn -> (string)

ARN of the DataAutomationLibraryIngestionJob