Class: Aws::QBusiness::Types::UpdateRetrieverRequest

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 your Amazon Q Business application.

Returns:

  • (String) 


5928
5929
5930
5931
5932
5933
5934
5935
5936
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5928

class UpdateRetrieverRequest < Struct.new(
  :application_id,
  :retriever_id,
  :configuration,
  :display_name,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::RetrieverConfiguration

Provides information on how the retriever used for your Amazon Q Business application is configured.

Returns:



5928
5929
5930
5931
5932
5933
5934
5935
5936
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5928

class UpdateRetrieverRequest < Struct.new(
  :application_id,
  :retriever_id,
  :configuration,
  :display_name,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The name of your retriever.

Returns:

  • (String) 


5928
5929
5930
5931
5932
5933
5934
5935
5936
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5928

class UpdateRetrieverRequest < Struct.new(
  :application_id,
  :retriever_id,
  :configuration,
  :display_name,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#retriever_id ⇒ String

The identifier of your retriever.

Returns:

  • (String) 


5928
5929
5930
5931
5932
5933
5934
5935
5936
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5928

class UpdateRetrieverRequest < Struct.new(
  :application_id,
  :retriever_id,
  :configuration,
  :display_name,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

Returns:

  • (String) 


5928
5929
5930
5931
5932
5933
5934
5935
5936
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5928

class UpdateRetrieverRequest < Struct.new(
  :application_id,
  :retriever_id,
  :configuration,
  :display_name,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end