AWS CLI Command Reference

[ aws . qconnect ]

start-import-job

Description

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

  • For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses .

See also: AWS API Documentation

Synopsis

  start-import-job
[--client-token <value>]
[--external-source-configuration <value>]
--import-job-type <value>
--knowledge-base-id <value>
[--metadata <value>]
--upload-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--client-token (string)

The tags used to organize, track, or control access for this resource.

--external-source-configuration (structure)

The configuration information of the external source that the resource data are imported from.

configuration -> (tagged union structure)

The configuration information of the external data source.

Note

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

connectConfiguration -> (structure)

The configuration information of the Amazon Connect data source.

instanceId -> (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

source -> (string)

The type of the external data source.

Shorthand Syntax:

configuration={connectConfiguration={instanceId=string}},source=string

JSON Syntax:

{
  "configuration": {
    "connectConfiguration": {
      "instanceId": "string"
    }
  },
  "source": "AMAZON_CONNECT"
}

--import-job-type (string)

The type of the import job.

  • For importing quick response resource, set the value to QUICK_RESPONSES .

Possible values:

  • QUICK_RESPONSES

--knowledge-base-id (string)

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES type knowledge base.

--metadata (map)

The metadata fields of the imported Amazon Q in Connect resources.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--upload-id (string)

A pointer to the uploaded asset. This value is returned by StartContentUpload .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

importJob -> (structure)

The import job.

createdTime -> (timestamp)

The timestamp when the import job was created.

externalSourceConfiguration -> (structure)

The configuration information of the external data source.

configuration -> (tagged union structure)

The configuration information of the external data source.

Note

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

connectConfiguration -> (structure)

The configuration information of the Amazon Connect data source.

instanceId -> (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

source -> (string)

The type of the external data source.

failedRecordReport -> (string)

The link to download the information of resource data that failed to be imported.

importJobId -> (string)

The identifier of the import job.

importJobType -> (string)

The type of the import job.

knowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base.

knowledgeBaseId -> (string)

The identifier of the knowledge base.

lastModifiedTime -> (timestamp)

The timestamp when the import job data was last modified.

metadata -> (map)

The metadata fields of the imported Amazon Q in Connect resources.

key -> (string)

value -> (string)

status -> (string)

The status of the import job.

uploadId -> (string)

A pointer to the uploaded asset. This value is returned by StartContentUpload .

url -> (string)

The download link to the resource file that is uploaded to the import job.

urlExpiry -> (timestamp)

The expiration time of the URL as an epoch timestamp.
© Copyright 2018, Amazon Web Services. Created using Sphinx.