Skip to content

list_data_accessors

Operation

list_data_accessors

list_data_accessors(request: ListDataAccessorsInput | ListDataAccessorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDataAccessorsInputDict]) -> ListDataAccessorsOutput

Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

Parameters:

Name Type Description Default
request ListDataAccessorsInput | ListDataAccessorsInputDict | 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[ListDataAccessorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDataAccessorsOutput

An instance of ListDataAccessorsOutput.

list_data_accessors async

list_data_accessors(request: ListDataAccessorsInput | ListDataAccessorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDataAccessorsInputDict]) -> ListDataAccessorsOutput

Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

Parameters:

Name Type Description Default
request ListDataAccessorsInput | ListDataAccessorsInputDict | 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[ListDataAccessorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDataAccessorsOutput

An instance of ListDataAccessorsOutput.

Input

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

ListDataAccessorsInputDict

Bases: TypedDict

Dictionary form of ListDataAccessorsInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The unique identifier of the Amazon Q Business application.

max_results instance-attribute
max_results: int | None

The maximum number of results to return in a single call.

next_token instance-attribute
next_token: str | None

The token for the next set of results. (You received this token from a previous call.)

ListDataAccessorsInput dataclass

Bases: _SerdeShape

Dataclass for ListDataAccessorsInput structure.

Attributes

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

The unique identifier of the Amazon Q Business application.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return in a single call.

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

The token for the next set of results. (You received this token from a previous call.)

Output

ListDataAccessorsOutput dataclass

Bases: _SerdeShape

Dataclass for ListDataAccessorsOutput structure.

Attributes

data_accessors class-attribute instance-attribute
data_accessors: list[DataAccessor] | None = ...

The list of data accessors.

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

The token to use to retrieve the next set of results, if there are any.

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.