# Retriever
<a name="API_Retriever"></a>

Summary information for the retriever used for your Amazon Q Business application.

## Contents
<a name="API_Retriever_Contents"></a>

 ** applicationId **   <a name="qbusiness-Type-Retriever-applicationId"></a>
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}`   
Required: No

 ** displayName **   <a name="qbusiness-Type-Retriever-displayName"></a>
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: No

 ** retrieverId **   <a name="qbusiness-Type-Retriever-retrieverId"></a>
The identifier of the retriever used by your Amazon Q Business application.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: No

 ** status **   <a name="qbusiness-Type-Retriever-status"></a>
The status of your retriever.  
Type: String  
Valid Values: `CREATING | ACTIVE | FAILED`   
Required: No

 ** type **   <a name="qbusiness-Type-Retriever-type"></a>
The type of your retriever.  
Type: String  
Valid Values: `NATIVE_INDEX | KENDRA_INDEX`   
Required: No

## See Also
<a name="API_Retriever_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/Retriever) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/Retriever) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/Retriever)