create_data_accessor
async
¶
create_data_accessor(
application_id: ApplicationId,
principal: PrincipalRoleArn,
action_configurations: ActionConfigurationList,
display_name: DataAccessorName,
*,
config_overrides: Optional[AsyncQBusinessClientConfig] = None,
client_token: Optional[ClientToken] = None,
authentication_detail: Optional[DataAccessorAuthenticationDetail] = None,
tags: Optional[Tags] = None,
) -> CreateDataAccessorResponse
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:
-
application_id(ApplicationId) –The unique identifier of the Amazon Q Business application.
-
principal(PrincipalRoleArn) –The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.
-
action_configurations(ActionConfigurationList) –A list of action configurations specifying the allowed actions and any associated filters.
-
client_token(Optional[ClientToken], default:None) –A unique, case-sensitive identifier you provide to ensure idempotency of the request.
-
display_name(DataAccessorName) –A friendly name for the data accessor.
-
authentication_detail(Optional[DataAccessorAuthenticationDetail], default:None) –The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.
-
tags(Optional[Tags], default:None) –The tags to associate with the data accessor.
Raises:
-
AccessDeniedException–You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
-
ConflictException–You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
-
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.
-
ResourceNotFoundException–The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
-
ServiceQuotaExceededException–You have exceeded the set limits for your Amazon Q Business service.
-
ThrottlingException–The request was denied due to throttling. Reduce the number of requests and try again.
-
ValidationException–The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_qbusiness/_services/async_q_business.py
4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 | |