list_data_table_primary_values ¶

def list_data_table_primary_values(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    data_table_id: "capo_connect.types.data_table_id.DataTableId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    record_ids: Optional["capo_connect.types.record_ids.RecordIds"] = None,
    primary_attribute_values: Optional[
        "capo_connect.types.primary_attribute_value_filters.PrimaryAttributeValueFilters"
    ] = 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_primary_values_response.ListDataTablePrimaryValuesResponse":
    """<p>Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.</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 primary values should be listed.</p>
        record_ids: <p>Optional list of specific record IDs to retrieve. Used for CloudFormation to effectively describe records by ID. If NextToken is provided, this parameter is ignored.</p>
        primary_attribute_values: <p>Optional filter to retrieve primary values matching specific criteria.</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 primary values 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.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.list_data_table_primary_values_request.ListDataTablePrimaryValuesRequest]",
    ) -> OperationResponse[
        "capo_connect.types.list_data_table_primary_values_response.ListDataTablePrimaryValuesResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_data_table_primary_values

        output, http_response = (
            capo_connect._operations.amazon_connect_service.list_data_table_primary_values.list_data_table_primary_values(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDataTablePrimaryValues")
    )
    input_: capo_connect.types.list_data_table_primary_values_request.ListDataTablePrimaryValuesRequest = {
        "instance_id": instance_id,
        "data_table_id": data_table_id,
    }
    if record_ids is not None:
        input_["record_ids"] = record_ids
    if primary_attribute_values is not None:
        input_["primary_attribute_values"] = primary_attribute_values
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output