get_data_accessor¶
Operation¶
async
¶
get_data_accessor(input: GetDataAccessorInput, plugins: list[Plugin] | None = None) -> GetDataAccessorOutput
Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetDataAccessorInput
|
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 |
|---|---|
GetDataAccessorOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetDataAccessorInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The unique identifier of the Amazon Q Business application.
class-attribute
instance-attribute
¶
data_accessor_id: str | None = None
The unique identifier of the data accessor to retrieve.
Output¶
dataclass
¶
Dataclass for GetDataAccessorOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
action_configurations: list[ActionConfiguration] | None = None
The 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 associated with this data accessor.
class-attribute
instance-attribute
¶
authentication_detail: DataAccessorAuthenticationDetail | None = None
The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.
class-attribute
instance-attribute
¶
created_at: datetime | None = None
The timestamp when the data accessor was created.
class-attribute
instance-attribute
¶
data_accessor_arn: str | None = None
The Amazon Resource Name (ARN) of the data accessor.
class-attribute
instance-attribute
¶
data_accessor_id: str | None = None
The unique identifier of the data accessor.
class-attribute
instance-attribute
¶
display_name: str | None = field(repr=False, default=None)
The friendly name of the data accessor.
class-attribute
instance-attribute
¶
idc_application_arn: str | None = None
The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor.
class-attribute
instance-attribute
¶
principal: str | None = None
The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
class-attribute
instance-attribute
¶
updated_at: datetime | None = None
The timestamp when the data accessor was last updated.