Class: Aws::QBusiness::Types::GetRetrieverResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The identifier of the Amazon Q Business application using the retriever.

Returns:

  • (String)


4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#configurationTypes::RetrieverConfiguration

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



4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The Unix timestamp when the retriever was created.

Returns:

  • (Time)


4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#display_nameString

The name of the retriever.

Returns:

  • (String)


4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#retriever_arnString

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

Returns:

  • (String)


4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#retriever_idString

The identifier of the retriever.

Returns:

  • (String)


4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the retriever.

Returns:

  • (String)


4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of the retriever.

Returns:

  • (String)


4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

The Unix timestamp when the retriever was last updated.

Returns:

  • (Time)


4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
# File 'lib/aws-sdk-qbusiness/types.rb', line 4264

class GetRetrieverResponse < Struct.new(
  :application_id,
  :retriever_id,
  :retriever_arn,
  :type,
  :status,
  :display_name,
  :configuration,
  :role_arn,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end