Skip to content

Qbusiness  >  Operations  >  update_data_accessor

update_data_accessor

Operation

update_data_accessor async

update_data_accessor(input: UpdateDataAccessorInput, plugins: list[Plugin] | None = None) -> UpdateDataAccessorOutput

Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.

Parameters:

Name Type Description Default
input UpdateDataAccessorInput

An instance of UpdateDataAccessorInput.

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
UpdateDataAccessorOutput

An instance of UpdateDataAccessorOutput.

Input

UpdateDataAccessorInput dataclass

Dataclass for UpdateDataAccessorInput structure.

Attributes

action_configurations class-attribute instance-attribute
action_configurations: list[ActionConfiguration] | None = None

The updated list of action configurations specifying the allowed actions and any associated filters.

application_id class-attribute instance-attribute
application_id: str | None = None

The unique identifier of the Amazon Q Business application.

authentication_detail class-attribute instance-attribute
authentication_detail: DataAccessorAuthenticationDetail | None = None

The updated authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.

data_accessor_id class-attribute instance-attribute
data_accessor_id: str | None = None

The unique identifier of the data accessor to update.

display_name class-attribute instance-attribute
display_name: str | None = field(repr=False, default=None)

The updated friendly name for the data accessor.

Output

UpdateDataAccessorOutput dataclass

Dataclass for UpdateDataAccessorOutput structure.