qbusiness/aws.sdk.kotlin.services.qbusiness.model/CreateRetrieverRequest

CreateRetrieverRequest

class CreateRetrieverRequest

Types

object Companion

Properties

val applicationId: String?

The identifier of your Amazon Q Business application.

val clientToken: String?

A token that you provide to identify the request to create your Amazon Q Business application retriever.

val configuration: RetrieverConfiguration?

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

val displayName: String?

The name of your retriever.

val roleArn: String?

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

val tags: List<Tag>?

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: _ . : / = + - @.

val type: RetrieverType?

The type of retriever you are using.

Functions

inline fun copy(block: CreateRetrieverRequest.Builder.() -> Unit = {}): CreateRetrieverRequest

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String