Skip to content

update_data_accessor

Operation

update_data_accessor

update_data_accessor(request: UpdateDataAccessorInput | UpdateDataAccessorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDataAccessorInputDict]) -> 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
request UpdateDataAccessorInput | UpdateDataAccessorInputDict | 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[UpdateDataAccessorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDataAccessorOutput

An instance of UpdateDataAccessorOutput.

update_data_accessor async

update_data_accessor(request: UpdateDataAccessorInput | UpdateDataAccessorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDataAccessorInputDict]) -> 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
request UpdateDataAccessorInput | UpdateDataAccessorInputDict | 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[UpdateDataAccessorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDataAccessorOutput

An instance of UpdateDataAccessorOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateDataAccessorInputDict

Bases: TypedDict

Dictionary form of UpdateDataAccessorInput.

Attributes

action_configurations instance-attribute

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

application_id instance-attribute
application_id: Required[str]

The unique identifier of the Amazon Q Business application.

authentication_detail instance-attribute

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 instance-attribute
data_accessor_id: Required[str]

The unique identifier of the data accessor to update.

display_name instance-attribute
display_name: str | None

The updated friendly name for the data accessor.

UpdateDataAccessorInput dataclass

Bases: _SerdeShape

Dataclass for UpdateDataAccessorInput structure.

Attributes

action_configurations class-attribute instance-attribute
action_configurations: list[ActionConfiguration] | 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 = ...

The unique identifier of the Amazon Q Business application.

authentication_detail class-attribute instance-attribute
authentication_detail: DataAccessorAuthenticationDetail | 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 = ...

The unique identifier of the data accessor to update.

display_name class-attribute instance-attribute
display_name: str | None = ...

The updated friendly name for the data accessor.

Output

UpdateDataAccessorOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateDataAccessorOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.