Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
Parameters:
-
instance_id
(InstanceId)
–
The unique identifier for the Amazon Connect instance.
-
data_table_id
(DataTableId)
–
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
-
attribute_name
(DataTableName)
–
The name of the attribute to retrieve detailed information for.
Raises:
Source code in docs_src/capo_connect/_services/connect.py
| def describe_data_table_attribute(
self,
instance_id: "capo_connect.types.instance_id.InstanceId",
data_table_id: "capo_connect.types.data_table_id.DataTableId",
attribute_name: "capo_connect.types.data_table_name.DataTableName",
*,
config_overrides: Optional[ConnectClientConfig] = None,
) -> "capo_connect.types.describe_data_table_attribute_response.DescribeDataTableAttributeResponse":
"""<p>Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.</p>
Args:
instance_id: <p>The unique identifier for the Amazon Connect instance.</p>
data_table_id: <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias.</p>
attribute_name: <p>The name of the attribute to retrieve detailed information for.</p>
Raises:
capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_connect.types.describe_data_table_attribute_request.DescribeDataTableAttributeRequest]",
) -> OperationResponse[
"capo_connect.types.describe_data_table_attribute_response.DescribeDataTableAttributeResponse"
]:
import capo_connect._operations.amazon_connect_service.describe_data_table_attribute
output, http_response = (
capo_connect._operations.amazon_connect_service.describe_data_table_attribute.describe_data_table_attribute(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDataTableAttribute")
)
input_: capo_connect.types.describe_data_table_attribute_request.DescribeDataTableAttributeRequest = {
"instance_id": instance_id,
"data_table_id": data_table_id,
"attribute_name": attribute_name,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|