create_retriever¶
Operation¶
create_retriever
¶
create_retriever(request: CreateRetrieverInput | CreateRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRetrieverInputDict]) -> CreateRetrieverOutput
Adds a retriever to your Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateRetrieverInput | CreateRetrieverInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateRetrieverInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateRetrieverOutput
|
An instance of |
create_retriever
async
¶
create_retriever(request: CreateRetrieverInput | CreateRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRetrieverInputDict]) -> CreateRetrieverOutput
Adds a retriever to your Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateRetrieverInput | CreateRetrieverInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateRetrieverInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateRetrieverOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateRetrieverInputDict
¶
Bases: TypedDict
Dictionary form of CreateRetrieverInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of your Amazon Q Business application.
client_token
instance-attribute
¶
client_token: str | None
A token that you provide to identify the request to create your Amazon Q Business application retriever.
This field is autopopulated if not provided.
configuration
instance-attribute
¶
configuration: Required[RetrieverConfiguration | RetrieverConfigurationDict]
Provides information on how the retriever used for your Amazon Q Business application is configured.
role_arn
instance-attribute
¶
role_arn: str | None
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
tags
instance-attribute
¶
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: _ . : / = + - @.
CreateRetrieverInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateRetrieverInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of your Amazon Q Business application.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A token that you provide to identify the request to create your Amazon Q Business application retriever.
This field is autopopulated if not provided.
configuration
class-attribute
instance-attribute
¶
configuration: RetrieverConfiguration | None = ...
Provides information on how the retriever used for your Amazon Q Business application is configured.
display_name
class-attribute
instance-attribute
¶
display_name: str | None = ...
The name of your retriever.
role_arn
class-attribute
instance-attribute
¶
role_arn: str | None = ...
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
tags
class-attribute
instance-attribute
¶
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: _ . : / = + - @.
Output¶
CreateRetrieverOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateRetrieverOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.