Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateRetriever

Adds a retriever to your Amazon Q Business application.

Request Syntax


POST /applications/applicationId/retrievers HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configuration": { ... },
   "displayName": "string",
   "roleArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

applicationId

The identifier of your Amazon Q Business application.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

configuration

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

Type: RetrieverConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

displayName

The name of your retriever.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

roleArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

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: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

type

The type of retriever you are using.

Type: String

Valid Values: NATIVE_INDEX | KENDRA_INDEX

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "retrieverArn": "string",
   "retrieverId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

retrieverArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

retrieverId

The identifier of the retriever you are using.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

HTTP Status Code: 403

ConflictException

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

HTTP Status Code: 409

InternalServerException

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

HTTP Status Code: 500

ResourceNotFoundException

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded the set limits for your Amazon Q Business service.

HTTP Status Code: 402

ThrottlingException

The request was denied due to throttling. Reduce the number of requests and try again.

HTTP Status Code: 429

ValidationException

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

HTTP Status Code: 400