/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;
namespace Amazon.PowerShell.Cmdlets.DDB
{
///
/// You must provide the name of the partition key attribute and a single value for that
/// attribute. Query returns all items with that partition key value. Optionally,
/// you can provide a sort key attribute and use a comparison operator to refine the search
/// results.
///
///
///
/// Use the KeyConditionExpression parameter to provide a specific value
/// for the partition key. The Query operation will return all of the items
/// from the table or index with that partition key value. You can optionally narrow the
/// scope of the Query operation by specifying a sort key value and a comparison
/// operator in KeyConditionExpression. To further refine the Query
/// results, you can optionally provide a FilterExpression. A FilterExpression
/// determines which items within the results should be returned to you. All of the other
/// results are discarded.
///
/// A Query operation always returns a result set. If no matching items
/// are found, the result set will be empty. Queries that do not return results consume
/// the minimum number of read capacity units for that type of read operation.
///
/// DynamoDB calculates the number of read capacity units consumed based on item size,
/// not on the amount of data that is returned to an application. The number of capacity
/// units consumed will be the same whether you request all of the attributes (the default
/// behavior) or just some of them (using a projection expression). The number will also
/// be the same whether or not you use a FilterExpression.
/// Query results are always sorted by the sort key value. If the data type
/// of the sort key is Number, the results are returned in numeric order; otherwise, the
/// results are returned in order of UTF-8 bytes. By default, the sort order is ascending.
/// To reverse the order, set the ScanIndexForward parameter to false.
///
/// A single Query operation will read up to the maximum number of items
/// set (if using the Limit parameter) or a maximum of 1 MB of data and then
/// apply any filtering to the results using FilterExpression. If LastEvaluatedKey
/// is present in the response, you will need to paginate the result set. For more information,
/// see Paginating
/// the Results in the Amazon DynamoDB Developer Guide.
/// FilterExpression is applied after a Query finishes, but
/// before the results are returned. A FilterExpression cannot contain partition
/// key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.
///
///
/// A Query operation can return an empty result set and a LastEvaluatedKey
/// if all the items read for the page of results are filtered out.
///
/// You can query a table, a local secondary index, or a global secondary index. For a
/// query on a table or on a local secondary index, you can set the ConsistentRead
/// parameter to true and obtain a strongly consistent result. Global secondary
/// indexes support eventually consistent reads only, so do not specify ConsistentRead
/// when querying a global secondary index.
///
This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.
///
[Cmdlet("Invoke", "DDBQuery", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.Collections.Generic.Dictionary")]
[AWSCmdlet("Calls the Amazon DynamoDB Query API operation.", Operation = new[] {"Query"}, SelectReturnType = typeof(Amazon.DynamoDBv2.Model.QueryResponse))]
[AWSCmdletOutput("System.Collections.Generic.Dictionary or Amazon.DynamoDBv2.Model.QueryResponse",
"This cmdlet returns a collection of Dictionary objects.",
"The service call response (type Amazon.DynamoDBv2.Model.QueryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class InvokeDDBQueryCmdlet : AmazonDynamoDBClientCmdlet, IExecutor
{
#region Parameter AttributesToGet
///
///
/// This is a legacy parameter. Use ProjectionExpression instead. For more
/// information, see AttributesToGet
/// in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String[] AttributesToGet { get; set; }
#endregion
#region Parameter ConditionalOperator
///
///
/// This is a legacy parameter. Use FilterExpression instead. For more information,
/// see ConditionalOperator
/// in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.DynamoDBv2.ConditionalOperator")]
public Amazon.DynamoDBv2.ConditionalOperator ConditionalOperator { get; set; }
#endregion
#region Parameter ConsistentRead
///
///
/// Determines the read consistency model: If set to true, then the operation
/// uses strongly consistent reads; otherwise, the operation uses eventually consistent
/// reads.Strongly consistent reads are not supported on global secondary indexes. If you query
/// a global secondary index with ConsistentRead set to true,
/// you will receive a ValidationException.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? ConsistentRead { get; set; }
#endregion
#region Parameter ExpressionAttributeName
///
///
/// One or more substitution tokens for attribute names in an expression. The following
/// are some use cases for using ExpressionAttributeNames:- To access an attribute whose name conflicts with a DynamoDB reserved word.
- To create a placeholder for repeating occurrences of an attribute name in an expression.
- To prevent special characters in an attribute name from being misinterpreted in an
/// expression.
Use the # character in an expression to dereference an attribute name. For
/// example, consider the following attribute name: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 Reserved
/// Words in the Amazon DynamoDB Developer Guide). To work around this, you
/// could specify the following for ExpressionAttributeNames:You could then use this substitution in an expression, as in this example:Tokens that begin with the : character are expression attribute values,
/// which are placeholders for the actual value at runtime.For more information on expression attribute names, see Specifying
/// Item Attributes in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ExpressionAttributeNames")]
public System.Collections.Hashtable ExpressionAttributeName { get; set; }
#endregion
#region Parameter ExpressionAttributeValue
///
///
/// One or more values that can be substituted in an expression.Use the : (colon) character in an expression to dereference an attribute value.
/// For example, suppose that you wanted to check whether the value of the ProductStatus
/// attribute was one of the following: Available | Backordered | DiscontinuedYou would first need to specify ExpressionAttributeValues as follows:{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
/// }You could then use these values in an expression, such as this:ProductStatus IN (:avail, :back, :disc)For more information on expression attribute values, see Specifying
/// Conditions in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ExpressionAttributeValues")]
public System.Collections.Hashtable ExpressionAttributeValue { get; set; }
#endregion
#region Parameter FilterExpression
///
///
/// A string that contains conditions that DynamoDB applies after the Query
/// operation, but before the data is returned to you. Items that do not satisfy the FilterExpression
/// criteria are not returned.A FilterExpression does not allow key attributes. You cannot define a
/// filter expression based on a partition key or a sort key.A FilterExpression is applied after the items have already been read;
/// the process of filtering does not consume any additional read capacity units.For more information, see Filter
/// Expressions in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FilterExpression { get; set; }
#endregion
#region Parameter IndexName
///
///
/// The name of an index to query. This index can be any local secondary index or global
/// secondary index on the table. Note that if you use the IndexName parameter,
/// you must also provide TableName.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String IndexName { get; set; }
#endregion
#region Parameter KeyConditionExpression
///
///
/// The condition that specifies the key values for items to be retrieved by the Query
/// action.The condition must perform an equality test on a single partition key value.The condition can optionally perform one of several comparison tests on a single sort
/// key value. This allows Query to retrieve one item with a given partition
/// key value and sort key value, or several items that have the same partition key value
/// but different sort key values.The partition key equality test is required, and must be specified in the following
/// format:partitionKeyName=:partitionkeyvalIf you also want to provide a condition for the sort key, it must be combined using
/// AND with the condition for the sort key. Following is an example, using
/// the = comparison operator for the sort key:partitionKeyName=:partitionkeyvalANDsortKeyName=:sortkeyvalValid comparisons for the sort key condition are as follows:sortKeyName=:sortkeyval - true if the sort
/// key value is equal to :sortkeyval.sortKeyName<:sortkeyval - true if the
/// sort key value is less than :sortkeyval.sortKeyName<=:sortkeyval - true if the
/// sort key value is less than or equal to :sortkeyval.sortKeyName>:sortkeyval - true if the
/// sort key value is greater than :sortkeyval.sortKeyName>= :sortkeyval - true if the
/// sort key value is greater than or equal to :sortkeyval.sortKeyNameBETWEEN:sortkeyval1AND:sortkeyval2 - true if the sort key value is greater than or equal to
/// :sortkeyval1, and less than or equal to :sortkeyval2.begins_with (sortKeyName, :sortkeyval)
/// - true if the sort key value begins with a particular operand. (You cannot use this
/// function with a sort key that is of type Number.) Note that the function name begins_with
/// is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as
/// :partitionval and :sortval with actual values at runtime.You can optionally use the ExpressionAttributeNames parameter to replace
/// the names of the partition key and sort key with placeholder tokens. This option might
/// be necessary if an attribute name conflicts with a DynamoDB reserved word. For example,
/// the following KeyConditionExpression parameter causes an error because
/// Size is a reserved word:To work around this, define a placeholder (such a #S) to represent the
/// attribute name Size. KeyConditionExpression then is as follows:For a list of reserved words, see Reserved
/// Words in the Amazon DynamoDB Developer Guide.For more information on ExpressionAttributeNames and ExpressionAttributeValues,
/// see Using
/// Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer
/// Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KeyConditionExpression { get; set; }
#endregion
#region Parameter KeyCondition
///
///
/// This is a legacy parameter. Use KeyConditionExpression instead. For more
/// information, see KeyConditions
/// in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("KeyConditions")]
public System.Collections.Hashtable KeyCondition { get; set; }
#endregion
#region Parameter ProjectionExpression
///
///
/// A string that identifies one or more attributes to retrieve from the table. These
/// attributes can include scalars, sets, or elements of a JSON document. The attributes
/// in the expression must be separated by commas.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.For more information, see Accessing
/// Item Attributes in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ProjectionExpression { get; set; }
#endregion
#region Parameter QueryFilter
///
///
/// This is a legacy parameter. Use FilterExpression instead. For more information,
/// see QueryFilter
/// in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Collections.Hashtable QueryFilter { get; set; }
#endregion
#region Parameter ReturnConsumedCapacity
///
///
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.DynamoDBv2.ReturnConsumedCapacity")]
public Amazon.DynamoDBv2.ReturnConsumedCapacity ReturnConsumedCapacity { get; set; }
#endregion
#region Parameter ScanIndexForward
///
///
/// Specifies the order for index traversal: If true (default), the traversal
/// is performed in ascending order; if false, the traversal is performed
/// in descending order. Items with the same partition key value are stored in sorted order by sort key. If
/// the sort key data type is Number, the results are stored in numeric order. For type
/// String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB
/// treats each byte of the binary data as unsigned.If ScanIndexForward is true, DynamoDB returns the results
/// in the order in which they are stored (by sort key value). This is the default behavior.
/// If ScanIndexForward is false, DynamoDB reads the results
/// in reverse order by sort key value, and then returns the results to the client.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? ScanIndexForward { get; set; }
#endregion
#region Parameter SelectItem
///
///
/// 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.ALL_ATTRIBUTES - 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.ALL_PROJECTED_ATTRIBUTES - 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 ALL_ATTRIBUTES.COUNT - 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.SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression.
/// This return value is equivalent to specifying ProjectionExpression without
/// specifying any value for Select.If you query or scan a local secondary index and request only attributes that are
/// projected into that index, the operation will read 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.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.
If neither Select nor ProjectionExpression are specified,
/// DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES
/// when accessing an index. You cannot use both Select and ProjectionExpression
/// together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES.
/// (This usage is equivalent to specifying ProjectionExpression without
/// any value for Select.)If you use the ProjectionExpression parameter, then the value for Select
/// can only be SPECIFIC_ATTRIBUTES. Any other value for Select
/// will return an error.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.DynamoDBv2.Select")]
public Amazon.DynamoDBv2.Select SelectItem { get; set; }
#endregion
#region Parameter TableName
///
///
/// The name of the table containing the requested items.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String TableName { get; set; }
#endregion
#region Parameter ExclusiveStartKey
///
///
/// The primary key of the first item that this operation will evaluate. Use the value
/// that was returned for LastEvaluatedKey in the previous operation.The data type for ExclusiveStartKey must be String, Number, or Binary.
/// No set data types are allowed.
///
///
///
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
///
In order to manually control output pagination, use '-ExclusiveStartKey $null' for the first call and '-ExclusiveStartKey $AWSHistory.LastServiceResponse.LastEvaluatedKey' for subsequent calls.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("NextToken")]
public System.Collections.Hashtable ExclusiveStartKey { get; set; }
#endregion
#region Parameter Limit
///
///
/// 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 LastEvaluatedKey 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 LastEvaluatedKey to apply in a subsequent
/// operation to continue the operation. For more information, see Query
/// and Scan in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Limit { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Items'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DynamoDBv2.Model.QueryResponse).
/// Specifying the name of a property of type Amazon.DynamoDBv2.Model.QueryResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "Items";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the TableName parameter.
/// The -PassThru parameter is deprecated, use -Select '^TableName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^TableName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
#region Parameter NoAutoIteration
///
/// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple
/// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of ExclusiveStartKey
/// as the start point.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter NoAutoIteration { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.TableName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Invoke-DDBQuery (Query)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.TableName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.AttributesToGet != null)
{
context.AttributesToGet = new List(this.AttributesToGet);
}
context.ConditionalOperator = this.ConditionalOperator;
context.ConsistentRead = this.ConsistentRead;
if (this.ExclusiveStartKey != null)
{
context.ExclusiveStartKey = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.ExclusiveStartKey.Keys)
{
context.ExclusiveStartKey.Add((String)hashKey, (AttributeValue)(this.ExclusiveStartKey[hashKey]));
}
}
if (this.ExpressionAttributeName != null)
{
context.ExpressionAttributeName = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.ExpressionAttributeName.Keys)
{
context.ExpressionAttributeName.Add((String)hashKey, (String)(this.ExpressionAttributeName[hashKey]));
}
}
if (this.ExpressionAttributeValue != null)
{
context.ExpressionAttributeValue = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.ExpressionAttributeValue.Keys)
{
context.ExpressionAttributeValue.Add((String)hashKey, (AttributeValue)(this.ExpressionAttributeValue[hashKey]));
}
}
context.FilterExpression = this.FilterExpression;
context.IndexName = this.IndexName;
context.KeyConditionExpression = this.KeyConditionExpression;
if (this.KeyCondition != null)
{
context.KeyCondition = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.KeyCondition.Keys)
{
context.KeyCondition.Add((String)hashKey, (Condition)(this.KeyCondition[hashKey]));
}
}
context.Limit = this.Limit;
context.ProjectionExpression = this.ProjectionExpression;
if (this.QueryFilter != null)
{
context.QueryFilter = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.QueryFilter.Keys)
{
context.QueryFilter.Add((String)hashKey, (Condition)(this.QueryFilter[hashKey]));
}
}
context.ReturnConsumedCapacity = this.ReturnConsumedCapacity;
context.ScanIndexForward = this.ScanIndexForward;
context.SelectItem = this.SelectItem;
context.TableName = this.TableName;
#if MODULAR
if (this.TableName == null && ParameterWasBound(nameof(this.TableName)))
{
WriteWarning("You are passing $null as a value for parameter TableName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// create request and set iteration invariants
var request = new Amazon.DynamoDBv2.Model.QueryRequest();
if (cmdletContext.AttributesToGet != null)
{
request.AttributesToGet = cmdletContext.AttributesToGet;
}
if (cmdletContext.ConditionalOperator != null)
{
request.ConditionalOperator = cmdletContext.ConditionalOperator;
}
if (cmdletContext.ConsistentRead != null)
{
request.ConsistentRead = cmdletContext.ConsistentRead.Value;
}
if (cmdletContext.ExpressionAttributeName != null)
{
request.ExpressionAttributeNames = cmdletContext.ExpressionAttributeName;
}
if (cmdletContext.ExpressionAttributeValue != null)
{
request.ExpressionAttributeValues = cmdletContext.ExpressionAttributeValue;
}
if (cmdletContext.FilterExpression != null)
{
request.FilterExpression = cmdletContext.FilterExpression;
}
if (cmdletContext.IndexName != null)
{
request.IndexName = cmdletContext.IndexName;
}
if (cmdletContext.KeyConditionExpression != null)
{
request.KeyConditionExpression = cmdletContext.KeyConditionExpression;
}
if (cmdletContext.KeyCondition != null)
{
request.KeyConditions = cmdletContext.KeyCondition;
}
if (cmdletContext.Limit != null)
{
request.Limit = cmdletContext.Limit.Value;
}
if (cmdletContext.ProjectionExpression != null)
{
request.ProjectionExpression = cmdletContext.ProjectionExpression;
}
if (cmdletContext.QueryFilter != null)
{
request.QueryFilter = cmdletContext.QueryFilter;
}
if (cmdletContext.ReturnConsumedCapacity != null)
{
request.ReturnConsumedCapacity = cmdletContext.ReturnConsumedCapacity;
}
if (cmdletContext.ScanIndexForward != null)
{
request.ScanIndexForward = cmdletContext.ScanIndexForward.Value;
}
if (cmdletContext.SelectItem != null)
{
request.Select = cmdletContext.SelectItem;
}
if (cmdletContext.TableName != null)
{
request.TableName = cmdletContext.TableName;
}
// Initialize loop variant and commence piping
var _nextToken = cmdletContext.ExclusiveStartKey;
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.ExclusiveStartKey));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.ExclusiveStartKey = _nextToken;
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
_nextToken = response.LastEvaluatedKey;
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return null;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.DynamoDBv2.Model.QueryResponse CallAWSServiceOperation(IAmazonDynamoDB client, Amazon.DynamoDBv2.Model.QueryRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon DynamoDB", "Query");
try
{
#if DESKTOP
return client.Query(request);
#elif CORECLR
return client.QueryAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public List AttributesToGet { get; set; }
public Amazon.DynamoDBv2.ConditionalOperator ConditionalOperator { get; set; }
public System.Boolean? ConsistentRead { get; set; }
public Dictionary ExclusiveStartKey { get; set; }
public Dictionary ExpressionAttributeName { get; set; }
public Dictionary ExpressionAttributeValue { get; set; }
public System.String FilterExpression { get; set; }
public System.String IndexName { get; set; }
public System.String KeyConditionExpression { get; set; }
public Dictionary KeyCondition { get; set; }
public System.Int32? Limit { get; set; }
public System.String ProjectionExpression { get; set; }
public Dictionary QueryFilter { get; set; }
public Amazon.DynamoDBv2.ReturnConsumedCapacity ReturnConsumedCapacity { get; set; }
public System.Boolean? ScanIndexForward { get; set; }
public Amazon.DynamoDBv2.Select SelectItem { get; set; }
public System.String TableName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Items;
}
}
}