create_data_accessor¶
Operation¶
async
¶
create_data_accessor(input: CreateDataAccessorInput, plugins: list[Plugin] | None = None) -> CreateDataAccessorOutput
Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateDataAccessorInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
CreateDataAccessorOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateDataAccessorInput structure.
Attributes¶
class-attribute
instance-attribute
¶
action_configurations: list[ActionConfiguration] | None = None
A list of action configurations specifying the allowed actions and any associated filters.
class-attribute
instance-attribute
¶
application_id: str | None = None
The unique identifier of the Amazon Q Business application.
class-attribute
instance-attribute
¶
authentication_detail: DataAccessorAuthenticationDetail | None = None
The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.
class-attribute
instance-attribute
¶
client_token: str | None = None
A unique, case-sensitive identifier you provide to ensure idempotency of the request.
class-attribute
instance-attribute
¶
display_name: str | None = field(repr=False, default=None)
A friendly name for the data accessor.
class-attribute
instance-attribute
¶
principal: str | None = None
The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.
Output¶
dataclass
¶
Dataclass for CreateDataAccessorOutput structure.
Attributes¶
instance-attribute
¶
data_accessor_arn: str
The Amazon Resource Name (ARN) of the created data accessor.
instance-attribute
¶
data_accessor_id: str
The unique identifier of the created data accessor.
instance-attribute
¶
idc_application_arn: str
The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor.