Skip to content

describe_data_table async

describe_data_table(
    instance_id: InstanceId,
    data_table_id: DataTableId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> DescribeDataTableResponse

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "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. If no alias is provided, the default behavior is identical to providing the $LATEST alias.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def describe_data_table(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    data_table_id: "capo_connect.types.data_table_id.DataTableId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> "capo_connect.types.describe_data_table_response.DescribeDataTableResponse":
    """<p>Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "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. If no alias is provided, the default behavior is identical to providing the $LATEST alias.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.describe_data_table_request.DescribeDataTableRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.describe_data_table_response.DescribeDataTableResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.describe_data_table

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.describe_data_table.async_describe_data_table(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDataTable")
    )
    input_: capo_connect.types.describe_data_table_request.DescribeDataTableRequest = {
        "instance_id": instance_id,
        "data_table_id": data_table_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output