aws_sdk_connect/client/
list_data_table_primary_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 [`ListDataTablePrimaryValues`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`instance_id(impl Into<String>)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::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_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::data_table_id) / [`set_data_table_id(Option<String>)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::set_data_table_id):<br>required: **true**<br><p>The unique identifier for the data table whose primary values should be listed.</p><br>
9    ///   - [`record_ids(impl Into<String>)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::record_ids) / [`set_record_ids(Option<Vec::<String>>)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::set_record_ids):<br>required: **false**<br><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><br>
10    ///   - [`primary_attribute_values(PrimaryAttributeValueFilter)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::primary_attribute_values) / [`set_primary_attribute_values(Option<Vec::<PrimaryAttributeValueFilter>>)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::set_primary_attribute_values):<br>required: **false**<br><p>Optional filter to retrieve primary values matching specific criteria.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::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_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of data table primary values to return in one page of results.</p><br>
13    /// - On success, responds with [`ListDataTablePrimaryValuesOutput`](crate::operation::list_data_table_primary_values::ListDataTablePrimaryValuesOutput) with field(s):
14    ///   - [`next_token(Option<String>)`](crate::operation::list_data_table_primary_values::ListDataTablePrimaryValuesOutput::next_token): <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
15    ///   - [`primary_values_list(Vec::<RecordPrimaryValue>)`](crate::operation::list_data_table_primary_values::ListDataTablePrimaryValuesOutput::primary_values_list): <p>A list of primary value combinations with their record IDs and modification metadata.</p>
16    /// - On failure, responds with [`SdkError<ListDataTablePrimaryValuesError>`](crate::operation::list_data_table_primary_values::ListDataTablePrimaryValuesError)
17    pub fn list_data_table_primary_values(
18        &self,
19    ) -> crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder {
20        crate::operation::list_data_table_primary_values::builders::ListDataTablePrimaryValuesFluentBuilder::new(self.handle.clone())
21    }
22}