GetRetrieverResult

data class GetRetrieverResult(val configuration: Either<RetrieverConfiguration0Properties, RetrieverConfiguration1Properties>? = null, val createdAt: String? = null, val displayName: String? = null, val retrieverArn: String? = null, val retrieverId: String? = null, val roleArn: String? = null, val status: RetrieverStatus? = null, val tags: List<Tag>? = null, val updatedAt: String? = null)

Constructors

Link copied to clipboard
constructor(configuration: Either<RetrieverConfiguration0Properties, RetrieverConfiguration1Properties>? = null, createdAt: String? = null, displayName: String? = null, retrieverArn: String? = null, retrieverId: String? = null, roleArn: String? = null, status: RetrieverStatus? = null, tags: List<Tag>? = null, updatedAt: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard
val createdAt: String? = null

The Unix timestamp when the retriever was created.

Link copied to clipboard
val displayName: String? = null

The name of your retriever.

Link copied to clipboard
val retrieverArn: String? = null

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

Link copied to clipboard
val retrieverId: String? = null

The identifier of the retriever used by your Amazon Q Business application.

Link copied to clipboard
val roleArn: String? = null

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

Link copied to clipboard
val status: RetrieverStatus? = null

The status of your retriever.

Link copied to clipboard
val tags: List<Tag>? = null

A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Link copied to clipboard
val updatedAt: String? = null

The Unix timestamp when the retriever was last updated.