aws_sdk_connect/client/
list_data_table_values.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListDataTableValues`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`instance_id(impl Into<String>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::set_instance_id):<br>required: **true**<br><p>The unique identifier for the Amazon Connect instance.</p><br>
8    ///   - [`data_table_id(impl Into<String>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::data_table_id) / [`set_data_table_id(Option<String>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::set_data_table_id):<br>required: **true**<br><p>The unique identifier for the data table whose values should be listed.</p><br>
9    ///   - [`record_ids(impl Into<String>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::record_ids) / [`set_record_ids(Option<Vec::<String>>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::set_record_ids):<br>required: **false**<br><p>Optional list of specific record IDs to retrieve values for.</p><br>
10    ///   - [`primary_attribute_values(PrimaryAttributeValueFilter)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::primary_attribute_values) / [`set_primary_attribute_values(Option<Vec::<PrimaryAttributeValueFilter>>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::set_primary_attribute_values):<br>required: **false**<br><p>Optional filter to retrieve values for records matching specific primary attribute criteria.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::set_next_token):<br>required: **false**<br><p>Specify the pagination token from a previous request to retrieve the next page of results.</p><br>
12    ///   - [`max_results(i32)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of data table values to return in one page of results.</p><br>
13    /// - On success, responds with [`ListDataTableValuesOutput`](crate::operation::list_data_table_values::ListDataTableValuesOutput) with field(s):
14    ///   - [`next_token(Option<String>)`](crate::operation::list_data_table_values::ListDataTableValuesOutput::next_token): <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
15    ///   - [`values(Vec::<DataTableValueSummary>)`](crate::operation::list_data_table_values::ListDataTableValuesOutput::values): <p>A list of data table values with their associated metadata, lock versions, and modification details.</p>
16    /// - On failure, responds with [`SdkError<ListDataTableValuesError>`](crate::operation::list_data_table_values::ListDataTableValuesError)
17    pub fn list_data_table_values(&self) -> crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder {
18        crate::operation::list_data_table_values::builders::ListDataTableValuesFluentBuilder::new(self.handle.clone())
19    }
20}