Class: Aws::QBusiness::Types::BatchPutDocumentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The identifier of the Amazon Q Business application.

Returns:

  • (String) 


762
763
764
765
766
767
768
769
770
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 762

class BatchPutDocumentRequest < Struct.new(
  :application_id,
  :index_id,
  :documents,
  :role_arn,
  :data_source_sync_id)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_sync_id ⇒ String

The identifier of the data source sync during which the documents were added.

Returns:

  • (String) 


762
763
764
765
766
767
768
769
770
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 762

class BatchPutDocumentRequest < Struct.new(
  :application_id,
  :index_id,
  :documents,
  :role_arn,
  :data_source_sync_id)
  SENSITIVE = []
  include Aws::Structure
end

#documents ⇒ Array<Types::Document>

One or more documents to add to the index.

Returns:



762
763
764
765
766
767
768
769
770
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 762

class BatchPutDocumentRequest < Struct.new(
  :application_id,
  :index_id,
  :documents,
  :role_arn,
  :data_source_sync_id)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the Amazon Q Business index to add the documents to.

Returns:

  • (String) 


762
763
764
765
766
767
768
769
770
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 762

class BatchPutDocumentRequest < Struct.new(
  :application_id,
  :index_id,
  :documents,
  :role_arn,
  :data_source_sync_id)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

Returns:

  • (String) 


762
763
764
765
766
767
768
769
770
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 762

class BatchPutDocumentRequest < Struct.new(
  :application_id,
  :index_id,
  :documents,
  :role_arn,
  :data_source_sync_id)
  SENSITIVE = []
  include Aws::Structure
end