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

GetRetriever

Gets information about an existing retriever used by an Amazon Q Business application.

Request Syntax


GET /applications/applicationId/retrievers/retrieverId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

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

Length Constraints: Fixed length of 36.

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

Required: Yes

retrieverId

The identifier of the retriever.

Length Constraints: Fixed length of 36.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "configuration": { ... },
   "createdAt": number,
   "displayName": "string",
   "retrieverArn": "string",
   "retrieverId": "string",
   "roleArn": "string",
   "status": "string",
   "type": "string",
   "updatedAt": number
}

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.

applicationId

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

Type: String

Length Constraints: Fixed length of 36.

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

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.

createdAt

The Unix timestamp when the retriever was created.

Type: Timestamp

displayName

The name of the retriever.

Type: String

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

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

retrieverArn

The Amazon Resource Name (ARN) of the IAM role associated with the 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.

Type: String

Length Constraints: Fixed length of 36.

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

roleArn

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

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}$

status

The status of the retriever.

Type: String

Valid Values: CREATING | ACTIVE | FAILED

type

The type of the retriever.

Type: String

Valid Values: NATIVE_INDEX | KENDRA_INDEX

updatedAt

The Unix timestamp when the retriever was last updated.

Type: Timestamp

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

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

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