Class: Aws::QConnect::Types::StartImportJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::StartImportJobRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qconnect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

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

• #external_source_configuration ⇒ Types::ExternalSourceConfiguration

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

• #import_job_type ⇒ String

  The type of the import job.

• #knowledge_base_id ⇒ String

  The identifier of the knowledge base.

• #metadata ⇒ Hash<String,String>

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

• #upload_id ⇒ String

  A pointer to the uploaded asset.

Instance Attribute Details

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 11106

class StartImportJobRequest < Struct.new(
  :knowledge_base_id,
  :import_job_type,
  :upload_id,
  :client_token,
  :metadata,
  :external_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#external_source_configuration ⇒ Types::ExternalSourceConfiguration

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

Returns:

• (Types::ExternalSourceConfiguration)

# File 'lib/aws-sdk-qconnect/types.rb', line 11106

class StartImportJobRequest < Struct.new(
  :knowledge_base_id,
  :import_job_type,
  :upload_id,
  :client_token,
  :metadata,
  :external_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#import_job_type ⇒ String

The type of the import job.

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

^

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 11106

class StartImportJobRequest < Struct.new(
  :knowledge_base_id,
  :import_job_type,
  :upload_id,
  :client_token,
  :metadata,
  :external_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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

^

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 11106

class StartImportJobRequest < Struct.new(
  :knowledge_base_id,
  :import_job_type,
  :upload_id,
  :client_token,
  :metadata,
  :external_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-qconnect/types.rb', line 11106

class StartImportJobRequest < Struct.new(
  :knowledge_base_id,
  :import_job_type,
  :upload_id,
  :client_token,
  :metadata,
  :external_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#upload_id ⇒ String

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

[1]: docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 11106

class StartImportJobRequest < Struct.new(
  :knowledge_base_id,
  :import_job_type,
  :upload_id,
  :client_token,
  :metadata,
  :external_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end