get_data_accessor¶
Operation¶
get_data_accessor
¶
get_data_accessor(request: GetDataAccessorInput | GetDataAccessorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDataAccessorInputDict]) -> 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 |
|---|---|---|---|
request
|
GetDataAccessorInput | GetDataAccessorInputDict | 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[GetDataAccessorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDataAccessorOutput
|
An instance of |
get_data_accessor
async
¶
get_data_accessor(request: GetDataAccessorInput | GetDataAccessorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDataAccessorInputDict]) -> 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 |
|---|---|---|---|
request
|
GetDataAccessorInput | GetDataAccessorInputDict | 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[GetDataAccessorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDataAccessorOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetDataAccessorOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetDataAccessorOutput structure.
Attributes¶
action_configurations
class-attribute
instance-attribute
¶
action_configurations: list[ActionConfiguration] | None = ...
The 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 associated with this data accessor.
authentication_detail
class-attribute
instance-attribute
¶
authentication_detail: DataAccessorAuthenticationDetail | None = ...
The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.
created_at
class-attribute
instance-attribute
¶
created_at: datetime | None = ...
The timestamp when the data accessor was created.
data_accessor_arn
class-attribute
instance-attribute
¶
data_accessor_arn: str | None = ...
The Amazon Resource Name (ARN) of the data accessor.
data_accessor_id
class-attribute
instance-attribute
¶
data_accessor_id: str | None = ...
The unique identifier of the data accessor.
display_name
class-attribute
instance-attribute
¶
display_name: str | None = ...
The friendly name of the data accessor.
idc_application_arn
class-attribute
instance-attribute
¶
idc_application_arn: str | None = ...
The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor.
principal
class-attribute
instance-attribute
¶
principal: str | None = ...
The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
response_metadata
class-attribute
instance-attribute
¶
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.