aws_sdk_dynamodb/operation/scan/_scan_input.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// <p>Represents the input of a <code>Scan</code> operation.</p>
4#[non_exhaustive]
5#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
6pub struct ScanInput {
7 /// <p>The name of the table containing the requested items or if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
8 /// <p>You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>
9 pub table_name: ::std::option::Option<::std::string::String>,
10 /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
11 pub index_name: ::std::option::Option<::std::string::String>,
12 /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
13 pub attributes_to_get: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
14 /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
15 pub limit: ::std::option::Option<i32>,
16 /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
17 /// <ul>
18 /// <li>
19 /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
20 /// <li>
21 /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
22 /// <li>
23 /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.</p></li>
24 /// <li>
25 /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>ProjectionExpression</code>. This return value is equivalent to specifying <code>ProjectionExpression</code> without specifying any value for <code>Select</code>.</p>
26 /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
27 /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
28 /// </ul>
29 /// <p>If neither <code>Select</code> nor <code>ProjectionExpression</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>ProjectionExpression</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>ProjectionExpression</code> without any value for <code>Select</code>.)</p><note>
30 /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
31 /// </note>
32 pub select: ::std::option::Option<crate::types::Select>,
33 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
34 pub scan_filter: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::Condition>>,
35 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
36 pub conditional_operator: ::std::option::Option<crate::types::ConditionalOperator>,
37 /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
38 /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
39 /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
40 pub exclusive_start_key: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
41 /// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
42 /// <ul>
43 /// <li>
44 /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
45 /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
46 /// <li>
47 /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
48 /// <li>
49 /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
50 /// </ul>
51 pub return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
52 /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
53 /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
54 /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
55 pub total_segments: ::std::option::Option<i32>,
56 /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
57 /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
58 /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
59 /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
60 /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
61 pub segment: ::std::option::Option<i32>,
62 /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
63 /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
64 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
65 pub projection_expression: ::std::option::Option<::std::string::String>,
66 /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
67 /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
68 /// </note>
69 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
70 pub filter_expression: ::std::option::Option<::std::string::String>,
71 /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
72 /// <ul>
73 /// <li>
74 /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
75 /// <li>
76 /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
77 /// <li>
78 /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
79 /// </ul>
80 /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
81 /// <ul>
82 /// <li>
83 /// <p><code>Percentile</code></p></li>
84 /// </ul>
85 /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
86 /// <ul>
87 /// <li>
88 /// <p><code>{"#P":"Percentile"}</code></p></li>
89 /// </ul>
90 /// <p>You could then use this substitution in an expression, as in this example:</p>
91 /// <ul>
92 /// <li>
93 /// <p><code>#P = :val</code></p></li>
94 /// </ul><note>
95 /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
96 /// </note>
97 /// <p>For more information on expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
98 pub expression_attribute_names: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
99 /// <p>One or more values that can be substituted in an expression.</p>
100 /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
101 /// <p><code>Available | Backordered | Discontinued</code></p>
102 /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
103 /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
104 /// <p>You could then use these values in an expression, such as this:</p>
105 /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
106 /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
107 pub expression_attribute_values: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
108 /// <p>A Boolean value that determines the read consistency model during the scan:</p>
109 /// <ul>
110 /// <li>
111 /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
112 /// <li>
113 /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
114 /// </ul>
115 /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
116 /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
117 pub consistent_read: ::std::option::Option<bool>,
118}
119impl ScanInput {
120 /// <p>The name of the table containing the requested items or if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
121 /// <p>You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>
122 pub fn table_name(&self) -> ::std::option::Option<&str> {
123 self.table_name.as_deref()
124 }
125 /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
126 pub fn index_name(&self) -> ::std::option::Option<&str> {
127 self.index_name.as_deref()
128 }
129 /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
130 ///
131 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.attributes_to_get.is_none()`.
132 pub fn attributes_to_get(&self) -> &[::std::string::String] {
133 self.attributes_to_get.as_deref().unwrap_or_default()
134 }
135 /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
136 pub fn limit(&self) -> ::std::option::Option<i32> {
137 self.limit
138 }
139 /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
140 /// <ul>
141 /// <li>
142 /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
143 /// <li>
144 /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
145 /// <li>
146 /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.</p></li>
147 /// <li>
148 /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>ProjectionExpression</code>. This return value is equivalent to specifying <code>ProjectionExpression</code> without specifying any value for <code>Select</code>.</p>
149 /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
150 /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
151 /// </ul>
152 /// <p>If neither <code>Select</code> nor <code>ProjectionExpression</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>ProjectionExpression</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>ProjectionExpression</code> without any value for <code>Select</code>.)</p><note>
153 /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
154 /// </note>
155 pub fn select(&self) -> ::std::option::Option<&crate::types::Select> {
156 self.select.as_ref()
157 }
158 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
159 pub fn scan_filter(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::Condition>> {
160 self.scan_filter.as_ref()
161 }
162 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
163 pub fn conditional_operator(&self) -> ::std::option::Option<&crate::types::ConditionalOperator> {
164 self.conditional_operator.as_ref()
165 }
166 /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
167 /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
168 /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
169 pub fn exclusive_start_key(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
170 self.exclusive_start_key.as_ref()
171 }
172 /// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
173 /// <ul>
174 /// <li>
175 /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
176 /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
177 /// <li>
178 /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
179 /// <li>
180 /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
181 /// </ul>
182 pub fn return_consumed_capacity(&self) -> ::std::option::Option<&crate::types::ReturnConsumedCapacity> {
183 self.return_consumed_capacity.as_ref()
184 }
185 /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
186 /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
187 /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
188 pub fn total_segments(&self) -> ::std::option::Option<i32> {
189 self.total_segments
190 }
191 /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
192 /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
193 /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
194 /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
195 /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
196 pub fn segment(&self) -> ::std::option::Option<i32> {
197 self.segment
198 }
199 /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
200 /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
201 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
202 pub fn projection_expression(&self) -> ::std::option::Option<&str> {
203 self.projection_expression.as_deref()
204 }
205 /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
206 /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
207 /// </note>
208 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
209 pub fn filter_expression(&self) -> ::std::option::Option<&str> {
210 self.filter_expression.as_deref()
211 }
212 /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
213 /// <ul>
214 /// <li>
215 /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
216 /// <li>
217 /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
218 /// <li>
219 /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
220 /// </ul>
221 /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
222 /// <ul>
223 /// <li>
224 /// <p><code>Percentile</code></p></li>
225 /// </ul>
226 /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
227 /// <ul>
228 /// <li>
229 /// <p><code>{"#P":"Percentile"}</code></p></li>
230 /// </ul>
231 /// <p>You could then use this substitution in an expression, as in this example:</p>
232 /// <ul>
233 /// <li>
234 /// <p><code>#P = :val</code></p></li>
235 /// </ul><note>
236 /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
237 /// </note>
238 /// <p>For more information on expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
239 pub fn expression_attribute_names(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
240 self.expression_attribute_names.as_ref()
241 }
242 /// <p>One or more values that can be substituted in an expression.</p>
243 /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
244 /// <p><code>Available | Backordered | Discontinued</code></p>
245 /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
246 /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
247 /// <p>You could then use these values in an expression, such as this:</p>
248 /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
249 /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
250 pub fn expression_attribute_values(
251 &self,
252 ) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
253 self.expression_attribute_values.as_ref()
254 }
255 /// <p>A Boolean value that determines the read consistency model during the scan:</p>
256 /// <ul>
257 /// <li>
258 /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
259 /// <li>
260 /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
261 /// </ul>
262 /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
263 /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
264 pub fn consistent_read(&self) -> ::std::option::Option<bool> {
265 self.consistent_read
266 }
267}
268impl ScanInput {
269 /// Creates a new builder-style object to manufacture [`ScanInput`](crate::operation::scan::ScanInput).
270 pub fn builder() -> crate::operation::scan::builders::ScanInputBuilder {
271 crate::operation::scan::builders::ScanInputBuilder::default()
272 }
273}
274
275/// A builder for [`ScanInput`](crate::operation::scan::ScanInput).
276#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
277#[non_exhaustive]
278pub struct ScanInputBuilder {
279 pub(crate) table_name: ::std::option::Option<::std::string::String>,
280 pub(crate) index_name: ::std::option::Option<::std::string::String>,
281 pub(crate) attributes_to_get: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
282 pub(crate) limit: ::std::option::Option<i32>,
283 pub(crate) select: ::std::option::Option<crate::types::Select>,
284 pub(crate) scan_filter: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::Condition>>,
285 pub(crate) conditional_operator: ::std::option::Option<crate::types::ConditionalOperator>,
286 pub(crate) exclusive_start_key: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
287 pub(crate) return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
288 pub(crate) total_segments: ::std::option::Option<i32>,
289 pub(crate) segment: ::std::option::Option<i32>,
290 pub(crate) projection_expression: ::std::option::Option<::std::string::String>,
291 pub(crate) filter_expression: ::std::option::Option<::std::string::String>,
292 pub(crate) expression_attribute_names: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
293 pub(crate) expression_attribute_values: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
294 pub(crate) consistent_read: ::std::option::Option<bool>,
295}
296impl ScanInputBuilder {
297 /// <p>The name of the table containing the requested items or if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
298 /// <p>You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>
299 /// This field is required.
300 pub fn table_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
301 self.table_name = ::std::option::Option::Some(input.into());
302 self
303 }
304 /// <p>The name of the table containing the requested items or if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
305 /// <p>You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>
306 pub fn set_table_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
307 self.table_name = input;
308 self
309 }
310 /// <p>The name of the table containing the requested items or if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
311 /// <p>You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>
312 pub fn get_table_name(&self) -> &::std::option::Option<::std::string::String> {
313 &self.table_name
314 }
315 /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
316 pub fn index_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
317 self.index_name = ::std::option::Option::Some(input.into());
318 self
319 }
320 /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
321 pub fn set_index_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
322 self.index_name = input;
323 self
324 }
325 /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
326 pub fn get_index_name(&self) -> &::std::option::Option<::std::string::String> {
327 &self.index_name
328 }
329 /// Appends an item to `attributes_to_get`.
330 ///
331 /// To override the contents of this collection use [`set_attributes_to_get`](Self::set_attributes_to_get).
332 ///
333 /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
334 pub fn attributes_to_get(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
335 let mut v = self.attributes_to_get.unwrap_or_default();
336 v.push(input.into());
337 self.attributes_to_get = ::std::option::Option::Some(v);
338 self
339 }
340 /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
341 pub fn set_attributes_to_get(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
342 self.attributes_to_get = input;
343 self
344 }
345 /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
346 pub fn get_attributes_to_get(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
347 &self.attributes_to_get
348 }
349 /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
350 pub fn limit(mut self, input: i32) -> Self {
351 self.limit = ::std::option::Option::Some(input);
352 self
353 }
354 /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
355 pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
356 self.limit = input;
357 self
358 }
359 /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
360 pub fn get_limit(&self) -> &::std::option::Option<i32> {
361 &self.limit
362 }
363 /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
364 /// <ul>
365 /// <li>
366 /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
367 /// <li>
368 /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
369 /// <li>
370 /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.</p></li>
371 /// <li>
372 /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>ProjectionExpression</code>. This return value is equivalent to specifying <code>ProjectionExpression</code> without specifying any value for <code>Select</code>.</p>
373 /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
374 /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
375 /// </ul>
376 /// <p>If neither <code>Select</code> nor <code>ProjectionExpression</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>ProjectionExpression</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>ProjectionExpression</code> without any value for <code>Select</code>.)</p><note>
377 /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
378 /// </note>
379 pub fn select(mut self, input: crate::types::Select) -> Self {
380 self.select = ::std::option::Option::Some(input);
381 self
382 }
383 /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
384 /// <ul>
385 /// <li>
386 /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
387 /// <li>
388 /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
389 /// <li>
390 /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.</p></li>
391 /// <li>
392 /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>ProjectionExpression</code>. This return value is equivalent to specifying <code>ProjectionExpression</code> without specifying any value for <code>Select</code>.</p>
393 /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
394 /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
395 /// </ul>
396 /// <p>If neither <code>Select</code> nor <code>ProjectionExpression</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>ProjectionExpression</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>ProjectionExpression</code> without any value for <code>Select</code>.)</p><note>
397 /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
398 /// </note>
399 pub fn set_select(mut self, input: ::std::option::Option<crate::types::Select>) -> Self {
400 self.select = input;
401 self
402 }
403 /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
404 /// <ul>
405 /// <li>
406 /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
407 /// <li>
408 /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
409 /// <li>
410 /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.</p></li>
411 /// <li>
412 /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>ProjectionExpression</code>. This return value is equivalent to specifying <code>ProjectionExpression</code> without specifying any value for <code>Select</code>.</p>
413 /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
414 /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
415 /// </ul>
416 /// <p>If neither <code>Select</code> nor <code>ProjectionExpression</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>ProjectionExpression</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>ProjectionExpression</code> without any value for <code>Select</code>.)</p><note>
417 /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
418 /// </note>
419 pub fn get_select(&self) -> &::std::option::Option<crate::types::Select> {
420 &self.select
421 }
422 /// Adds a key-value pair to `scan_filter`.
423 ///
424 /// To override the contents of this collection use [`set_scan_filter`](Self::set_scan_filter).
425 ///
426 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
427 pub fn scan_filter(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::Condition) -> Self {
428 let mut hash_map = self.scan_filter.unwrap_or_default();
429 hash_map.insert(k.into(), v);
430 self.scan_filter = ::std::option::Option::Some(hash_map);
431 self
432 }
433 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
434 pub fn set_scan_filter(
435 mut self,
436 input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::Condition>>,
437 ) -> Self {
438 self.scan_filter = input;
439 self
440 }
441 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
442 pub fn get_scan_filter(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::Condition>> {
443 &self.scan_filter
444 }
445 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
446 pub fn conditional_operator(mut self, input: crate::types::ConditionalOperator) -> Self {
447 self.conditional_operator = ::std::option::Option::Some(input);
448 self
449 }
450 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
451 pub fn set_conditional_operator(mut self, input: ::std::option::Option<crate::types::ConditionalOperator>) -> Self {
452 self.conditional_operator = input;
453 self
454 }
455 /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
456 pub fn get_conditional_operator(&self) -> &::std::option::Option<crate::types::ConditionalOperator> {
457 &self.conditional_operator
458 }
459 /// Adds a key-value pair to `exclusive_start_key`.
460 ///
461 /// To override the contents of this collection use [`set_exclusive_start_key`](Self::set_exclusive_start_key).
462 ///
463 /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
464 /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
465 /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
466 pub fn exclusive_start_key(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::AttributeValue) -> Self {
467 let mut hash_map = self.exclusive_start_key.unwrap_or_default();
468 hash_map.insert(k.into(), v);
469 self.exclusive_start_key = ::std::option::Option::Some(hash_map);
470 self
471 }
472 /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
473 /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
474 /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
475 pub fn set_exclusive_start_key(
476 mut self,
477 input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
478 ) -> Self {
479 self.exclusive_start_key = input;
480 self
481 }
482 /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
483 /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
484 /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
485 pub fn get_exclusive_start_key(
486 &self,
487 ) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
488 &self.exclusive_start_key
489 }
490 /// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
491 /// <ul>
492 /// <li>
493 /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
494 /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
495 /// <li>
496 /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
497 /// <li>
498 /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
499 /// </ul>
500 pub fn return_consumed_capacity(mut self, input: crate::types::ReturnConsumedCapacity) -> Self {
501 self.return_consumed_capacity = ::std::option::Option::Some(input);
502 self
503 }
504 /// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
505 /// <ul>
506 /// <li>
507 /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
508 /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
509 /// <li>
510 /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
511 /// <li>
512 /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
513 /// </ul>
514 pub fn set_return_consumed_capacity(mut self, input: ::std::option::Option<crate::types::ReturnConsumedCapacity>) -> Self {
515 self.return_consumed_capacity = input;
516 self
517 }
518 /// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
519 /// <ul>
520 /// <li>
521 /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
522 /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
523 /// <li>
524 /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
525 /// <li>
526 /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
527 /// </ul>
528 pub fn get_return_consumed_capacity(&self) -> &::std::option::Option<crate::types::ReturnConsumedCapacity> {
529 &self.return_consumed_capacity
530 }
531 /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
532 /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
533 /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
534 pub fn total_segments(mut self, input: i32) -> Self {
535 self.total_segments = ::std::option::Option::Some(input);
536 self
537 }
538 /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
539 /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
540 /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
541 pub fn set_total_segments(mut self, input: ::std::option::Option<i32>) -> Self {
542 self.total_segments = input;
543 self
544 }
545 /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
546 /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
547 /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
548 pub fn get_total_segments(&self) -> &::std::option::Option<i32> {
549 &self.total_segments
550 }
551 /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
552 /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
553 /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
554 /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
555 /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
556 pub fn segment(mut self, input: i32) -> Self {
557 self.segment = ::std::option::Option::Some(input);
558 self
559 }
560 /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
561 /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
562 /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
563 /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
564 /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
565 pub fn set_segment(mut self, input: ::std::option::Option<i32>) -> Self {
566 self.segment = input;
567 self
568 }
569 /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
570 /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
571 /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
572 /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
573 /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
574 pub fn get_segment(&self) -> &::std::option::Option<i32> {
575 &self.segment
576 }
577 /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
578 /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
579 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
580 pub fn projection_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
581 self.projection_expression = ::std::option::Option::Some(input.into());
582 self
583 }
584 /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
585 /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
586 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
587 pub fn set_projection_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
588 self.projection_expression = input;
589 self
590 }
591 /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
592 /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
593 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
594 pub fn get_projection_expression(&self) -> &::std::option::Option<::std::string::String> {
595 &self.projection_expression
596 }
597 /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
598 /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
599 /// </note>
600 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
601 pub fn filter_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
602 self.filter_expression = ::std::option::Option::Some(input.into());
603 self
604 }
605 /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
606 /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
607 /// </note>
608 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
609 pub fn set_filter_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
610 self.filter_expression = input;
611 self
612 }
613 /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
614 /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
615 /// </note>
616 /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
617 pub fn get_filter_expression(&self) -> &::std::option::Option<::std::string::String> {
618 &self.filter_expression
619 }
620 /// Adds a key-value pair to `expression_attribute_names`.
621 ///
622 /// To override the contents of this collection use [`set_expression_attribute_names`](Self::set_expression_attribute_names).
623 ///
624 /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
625 /// <ul>
626 /// <li>
627 /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
628 /// <li>
629 /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
630 /// <li>
631 /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
632 /// </ul>
633 /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
634 /// <ul>
635 /// <li>
636 /// <p><code>Percentile</code></p></li>
637 /// </ul>
638 /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
639 /// <ul>
640 /// <li>
641 /// <p><code>{"#P":"Percentile"}</code></p></li>
642 /// </ul>
643 /// <p>You could then use this substitution in an expression, as in this example:</p>
644 /// <ul>
645 /// <li>
646 /// <p><code>#P = :val</code></p></li>
647 /// </ul><note>
648 /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
649 /// </note>
650 /// <p>For more information on expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
651 pub fn expression_attribute_names(
652 mut self,
653 k: impl ::std::convert::Into<::std::string::String>,
654 v: impl ::std::convert::Into<::std::string::String>,
655 ) -> Self {
656 let mut hash_map = self.expression_attribute_names.unwrap_or_default();
657 hash_map.insert(k.into(), v.into());
658 self.expression_attribute_names = ::std::option::Option::Some(hash_map);
659 self
660 }
661 /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
662 /// <ul>
663 /// <li>
664 /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
665 /// <li>
666 /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
667 /// <li>
668 /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
669 /// </ul>
670 /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
671 /// <ul>
672 /// <li>
673 /// <p><code>Percentile</code></p></li>
674 /// </ul>
675 /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
676 /// <ul>
677 /// <li>
678 /// <p><code>{"#P":"Percentile"}</code></p></li>
679 /// </ul>
680 /// <p>You could then use this substitution in an expression, as in this example:</p>
681 /// <ul>
682 /// <li>
683 /// <p><code>#P = :val</code></p></li>
684 /// </ul><note>
685 /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
686 /// </note>
687 /// <p>For more information on expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
688 pub fn set_expression_attribute_names(
689 mut self,
690 input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
691 ) -> Self {
692 self.expression_attribute_names = input;
693 self
694 }
695 /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
696 /// <ul>
697 /// <li>
698 /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
699 /// <li>
700 /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
701 /// <li>
702 /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
703 /// </ul>
704 /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
705 /// <ul>
706 /// <li>
707 /// <p><code>Percentile</code></p></li>
708 /// </ul>
709 /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
710 /// <ul>
711 /// <li>
712 /// <p><code>{"#P":"Percentile"}</code></p></li>
713 /// </ul>
714 /// <p>You could then use this substitution in an expression, as in this example:</p>
715 /// <ul>
716 /// <li>
717 /// <p><code>#P = :val</code></p></li>
718 /// </ul><note>
719 /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
720 /// </note>
721 /// <p>For more information on expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
722 pub fn get_expression_attribute_names(
723 &self,
724 ) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
725 &self.expression_attribute_names
726 }
727 /// Adds a key-value pair to `expression_attribute_values`.
728 ///
729 /// To override the contents of this collection use [`set_expression_attribute_values`](Self::set_expression_attribute_values).
730 ///
731 /// <p>One or more values that can be substituted in an expression.</p>
732 /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
733 /// <p><code>Available | Backordered | Discontinued</code></p>
734 /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
735 /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
736 /// <p>You could then use these values in an expression, such as this:</p>
737 /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
738 /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
739 pub fn expression_attribute_values(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::AttributeValue) -> Self {
740 let mut hash_map = self.expression_attribute_values.unwrap_or_default();
741 hash_map.insert(k.into(), v);
742 self.expression_attribute_values = ::std::option::Option::Some(hash_map);
743 self
744 }
745 /// <p>One or more values that can be substituted in an expression.</p>
746 /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
747 /// <p><code>Available | Backordered | Discontinued</code></p>
748 /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
749 /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
750 /// <p>You could then use these values in an expression, such as this:</p>
751 /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
752 /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
753 pub fn set_expression_attribute_values(
754 mut self,
755 input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
756 ) -> Self {
757 self.expression_attribute_values = input;
758 self
759 }
760 /// <p>One or more values that can be substituted in an expression.</p>
761 /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
762 /// <p><code>Available | Backordered | Discontinued</code></p>
763 /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
764 /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
765 /// <p>You could then use these values in an expression, such as this:</p>
766 /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
767 /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
768 pub fn get_expression_attribute_values(
769 &self,
770 ) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
771 &self.expression_attribute_values
772 }
773 /// <p>A Boolean value that determines the read consistency model during the scan:</p>
774 /// <ul>
775 /// <li>
776 /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
777 /// <li>
778 /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
779 /// </ul>
780 /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
781 /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
782 pub fn consistent_read(mut self, input: bool) -> Self {
783 self.consistent_read = ::std::option::Option::Some(input);
784 self
785 }
786 /// <p>A Boolean value that determines the read consistency model during the scan:</p>
787 /// <ul>
788 /// <li>
789 /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
790 /// <li>
791 /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
792 /// </ul>
793 /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
794 /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
795 pub fn set_consistent_read(mut self, input: ::std::option::Option<bool>) -> Self {
796 self.consistent_read = input;
797 self
798 }
799 /// <p>A Boolean value that determines the read consistency model during the scan:</p>
800 /// <ul>
801 /// <li>
802 /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
803 /// <li>
804 /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
805 /// </ul>
806 /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
807 /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
808 pub fn get_consistent_read(&self) -> &::std::option::Option<bool> {
809 &self.consistent_read
810 }
811 /// Consumes the builder and constructs a [`ScanInput`](crate::operation::scan::ScanInput).
812 pub fn build(self) -> ::std::result::Result<crate::operation::scan::ScanInput, ::aws_smithy_types::error::operation::BuildError> {
813 ::std::result::Result::Ok(crate::operation::scan::ScanInput {
814 table_name: self.table_name,
815 index_name: self.index_name,
816 attributes_to_get: self.attributes_to_get,
817 limit: self.limit,
818 select: self.select,
819 scan_filter: self.scan_filter,
820 conditional_operator: self.conditional_operator,
821 exclusive_start_key: self.exclusive_start_key,
822 return_consumed_capacity: self.return_consumed_capacity,
823 total_segments: self.total_segments,
824 segment: self.segment,
825 projection_expression: self.projection_expression,
826 filter_expression: self.filter_expression,
827 expression_attribute_names: self.expression_attribute_names,
828 expression_attribute_values: self.expression_attribute_values,
829 consistent_read: self.consistent_read,
830 })
831 }
832}