Container for the parameters to the CreateRetriever operation. Adds a retriever to your Amazon Q Business application.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.QBusiness.AmazonQBusinessRequest
Amazon.QBusiness.Model.CreateRetrieverRequest
Namespace: Amazon.QBusiness.Model
Assembly: AWSSDK.QBusiness.dll
Version: 3.x.y.z
Syntax
public class CreateRetrieverRequest : AmazonQBusinessRequest IAmazonWebServiceRequest
The CreateRetrieverRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateRetrieverRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ApplicationId | System.String |
Gets and sets the property ApplicationId. The identifier of your Amazon Q Business application. |
|
|
ClientToken | System.String |
Gets and sets the property ClientToken. A token that you provide to identify the request to create your Amazon Q Business application retriever. |
|
|
Configuration | Amazon.QBusiness.Model.RetrieverConfiguration |
Gets and sets the property Configuration. |
|
|
DisplayName | System.String |
Gets and sets the property DisplayName. The name of your retriever. |
|
|
RoleArn | System.String |
Gets and sets the property RoleArn. The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret. |
|
|
Tags | System.Collections.Generic.List<Amazon.QBusiness.Model.Tag> |
Gets and sets the property Tags. 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: _ . : / = + - @. |
|
|
Type | Amazon.QBusiness.RetrieverType |
Gets and sets the property Type. The type of retriever you are using. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5