Skip to content

list_data_table_attributes async

list_data_table_attributes(
    instance_id: InstanceId,
    data_table_id: DataTableId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    attribute_ids: Optional[AttributeIds] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResult1000] = None,
) -> ListDataTableAttributesResponse

Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.

Parameters:

  • instance_id (InstanceId) –

    The unique identifier for the Amazon Connect instance.

  • data_table_id (DataTableId) –

    The unique identifier for the data table whose attributes should be listed.

  • attribute_ids (Optional[AttributeIds], default: None ) –

    Optional list of specific attribute IDs to retrieve. Used for CloudFormation to effectively describe attributes by ID. If NextToken is provided, this parameter is ignored.

  • next_token (Optional[NextToken], default: None ) –

    Specify the pagination token from a previous request to retrieve the next page of results.

  • max_results (Optional[MaxResult1000], default: None ) –

    The maximum number of data table attributes to return in one page of results.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def list_data_table_attributes(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    data_table_id: "capo_connect.types.data_table_id.DataTableId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    attribute_ids: Optional["capo_connect.types.attribute_ids.AttributeIds"] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
    max_results: Optional["capo_connect.types.max_result1000.MaxResult1000"] = None,
) -> "capo_connect.types.list_data_table_attributes_response.ListDataTableAttributesResponse":
    """<p>Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.</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 whose attributes should be listed.</p>
        attribute_ids: <p>Optional list of specific attribute IDs to retrieve. Used for CloudFormation to effectively describe attributes by ID. If NextToken is provided, this parameter is ignored.</p>
        next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        max_results: <p>The maximum number of data table attributes to return in one page of results.</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.list_data_table_attributes_request.ListDataTableAttributesRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.list_data_table_attributes_response.ListDataTableAttributesResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_data_table_attributes

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDataTableAttributes")
    )
    input_: capo_connect.types.list_data_table_attributes_request.ListDataTableAttributesRequest = {
        "instance_id": instance_id,
        "data_table_id": data_table_id,
    }
    if attribute_ids is not None:
        input_["attribute_ids"] = attribute_ids
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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