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

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::GetRetrieverResponse

Defined in:

gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

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

• #configuration ⇒ Types::RetrieverConfiguration

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

• #created_at ⇒ Time

  The Unix timestamp when the retriever was created.

• #display_name ⇒ String

  The name of the retriever.

• #retriever_arn ⇒ String

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

• #retriever_id ⇒ String

  The identifier of the retriever.

• #role_arn ⇒ String

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

• #status ⇒ String

  The status of the retriever.

• #type ⇒ String

  The type of the retriever.

• #updated_at ⇒ Time

  The Unix timestamp when the retriever was last updated.

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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

#configuration ⇒ Types::RetrieverConfiguration

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

Returns:

• (Types::RetrieverConfiguration)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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_at ⇒ Time

The Unix timestamp when the retriever was created.

Returns:

• (Time)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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_name ⇒ String

The name of the retriever.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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_id ⇒ String

The identifier of the retriever.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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

#status ⇒ String

The status of the retriever.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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

#type ⇒ String

The type of the retriever.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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_at ⇒ Time

The Unix timestamp when the retriever was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3531

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