/*******************************************************************************
* 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
{
///
/// Edits an existing item's attributes, or adds a new item to the table if it does not
/// already exist. You can put, delete, or add attribute values. You can also perform
/// a conditional update on an existing item (insert a new attribute name-value pair if
/// it doesn't exist, or replace an existing name-value pair if it has certain expected
/// attribute values).
///
///
///
/// You can also return the item's attribute values in the same UpdateItem
/// operation using the ReturnValues parameter.
///
///
[Cmdlet("Update", "DDBItem", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon DynamoDB UpdateItem API operation.", Operation = new[] {"UpdateItem"}, SelectReturnType = typeof(Amazon.DynamoDBv2.Model.UpdateItemResponse))]
[AWSCmdletOutput("System.String or Amazon.DynamoDBv2.Model.UpdateItemResponse",
"This cmdlet returns a collection of System.String objects.",
"The service call response (type Amazon.DynamoDBv2.Model.UpdateItemResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateDDBItemCmdlet : AmazonDynamoDBClientCmdlet, IExecutor
{
#region Parameter AttributeUpdate
///
///
/// This is a legacy parameter. Use UpdateExpression instead. For more information,
/// see AttributeUpdates
/// in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("AttributeUpdates")]
public System.Collections.Hashtable AttributeUpdate { get; set; }
#endregion
#region Parameter ConditionalOperator
///
///
/// This is a legacy parameter. Use ConditionExpression 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 ConditionExpression
///
///
/// A condition that must be satisfied in order for a conditional update to succeed.An expression can contain any of the following:- Functions:
attribute_exists | attribute_not_exists | attribute_type | contains
/// | begins_with | sizeThese function names are case-sensitive. - Comparison operators:
= | <> | < | > | <= | >= | BETWEEN |
/// IN - Logical operators:
AND | OR | NOT
For more information about condition expressions, see Specifying
/// Conditions in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ConditionExpression { get; set; }
#endregion
#region Parameter Expected
///
///
/// This is a legacy parameter. Use ConditionExpression instead. For more
/// information, see Expected
/// in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Collections.Hashtable Expected { 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 about 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 Condition
/// Expressions in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ExpressionAttributeValues")]
public System.Collections.Hashtable ExpressionAttributeValue { get; set; }
#endregion
#region Parameter Key
///
///
/// The primary key of the item to be updated. Each element consists of an attribute name
/// and a value for that attribute.For the primary key, you must provide all of the attributes. For example, with a simple
/// primary key, you only need to provide a value for the partition key. For a composite
/// primary key, you must provide values for both the partition key and the sort key.
///
///
#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.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.Collections.Hashtable Key { 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 ReturnItemCollectionMetric
///
///
/// Determines whether item collection metrics are returned. If set to SIZE,
/// the response includes statistics about item collections, if any, that were modified
/// during the operation are returned in the response. If set to NONE (the
/// default), no statistics are returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ReturnItemCollectionMetrics")]
[AWSConstantClassSource("Amazon.DynamoDBv2.ReturnItemCollectionMetrics")]
public Amazon.DynamoDBv2.ReturnItemCollectionMetrics ReturnItemCollectionMetric { get; set; }
#endregion
#region Parameter ReturnValue
///
///
/// Use ReturnValues if you want to get the item attributes as they appear
/// before or after they are successfully updated. For UpdateItem, the valid
/// values are:NONE - If ReturnValues is not specified, or if its value
/// is NONE, then nothing is returned. (This setting is the default for ReturnValues.)ALL_OLD - Returns all of the attributes of the item, as they appeared
/// before the UpdateItem operation.UPDATED_OLD - Returns only the updated attributes, as they appeared
/// before the UpdateItem operation.ALL_NEW - Returns all of the attributes of the item, as they appear
/// after the UpdateItem operation.UPDATED_NEW - Returns only the updated attributes, as they appear after
/// the UpdateItem operation.
There is no additional cost associated with requesting a return value aside from the
/// small network and processing overhead of receiving a larger response. No read capacity
/// units are consumed.The values returned are strongly consistent.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ReturnValues")]
[AWSConstantClassSource("Amazon.DynamoDBv2.ReturnValue")]
public Amazon.DynamoDBv2.ReturnValue ReturnValue { get; set; }
#endregion
#region Parameter ReturnValuesOnConditionCheckFailure
///
///
/// An optional parameter that returns the item attributes for an UpdateItem
/// operation that failed a condition check.There is no additional cost associated with requesting a return value aside from the
/// small network and processing overhead of receiving a larger response. No read capacity
/// units are consumed.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.DynamoDBv2.ReturnValuesOnConditionCheckFailure")]
public Amazon.DynamoDBv2.ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure { get; set; }
#endregion
#region Parameter TableName
///
///
/// The name of the table containing the item to update.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = 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 UpdateExpression
///
///
/// An expression that defines one or more attributes to be updated, the action to be
/// performed on them, and new values for them.The following action values are available for UpdateExpression.SET - Adds one or more attributes and values to an item. If any of these
/// attributes already exist, they are replaced by the new values. You can also use SET
/// to add or subtract from an attribute that is of type Number. For example: SET
/// myNum = myNum + :valSET supports the following functions:if_not_exists (path, operand) - if the item does not contain an attribute
/// at the specified path, then if_not_exists evaluates to operand; otherwise,
/// it evaluates to path. You can use this function to avoid overwriting an attribute
/// that may already be present in the item.list_append (operand, operand) - evaluates to a list with a new element
/// added to it. You can append the new element to the start or the end of the list by
/// reversing the order of the operands.
These function names are case-sensitive.REMOVE - Removes one or more attributes from an item.ADD - Adds the specified value to the item, if the attribute does not
/// already exist. If the attribute does exist, then the behavior of ADD
/// depends on the data type of the attribute:- If the existing attribute is a number, and if
Value is also a number,
/// then Value is mathematically added to the existing attribute. If Value
/// is a negative number, then it is subtracted from the existing attribute.If you use ADD to increment or decrement a number value for an item that
/// doesn't exist before the update, DynamoDB uses 0 as the initial value.Similarly, if you use ADD for an existing item to increment or decrement
/// an attribute value that doesn't exist before the update, DynamoDB uses 0
/// as the initial value. For example, suppose that the item you want to update doesn't
/// have an attribute named itemcount, but you decide to ADD
/// the number 3 to this attribute anyway. DynamoDB will create the itemcount
/// attribute, set its initial value to 0, and finally add 3
/// to it. The result will be a new itemcount attribute in the item, with
/// a value of 3. - If the existing data type is a set and if
Value is also a set, then Value
/// is added to the existing set. For example, if the attribute value is the set [1,2],
/// and the ADD action specified [3], then the final attribute
/// value is [1,2,3]. An error occurs if an ADD action is specified
/// for a set attribute and the attribute type specified does not match the existing set
/// type. Both sets must have the same primitive data type. For example, if the existing data
/// type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition,
/// ADD can only be used on top-level attributes, not nested attributes.DELETE - Deletes an element from a set.If a set of values is specified, then those values are subtracted from the old set.
/// For example, if the attribute value was the set [a,b,c] and the DELETE
/// action specifies [a,c], then the final attribute value is [b].
/// Specifying an empty set is an error.The DELETE action only supports set data types. In addition, DELETE
/// can only be used on top-level attributes, not nested attributes.
You can have many actions in a single expression, such as the following: SET
/// a=:value1, b=:value2 DELETE :value3, :value4, :value5For more information on update expressions, see Modifying
/// Items and Attributes in the Amazon DynamoDB Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String UpdateExpression { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DynamoDBv2.Model.UpdateItemResponse).
/// Specifying the name of a property of type Amazon.DynamoDBv2.Model.UpdateItemResponse 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; } = "Attributes";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the Key parameter.
/// The -PassThru parameter is deprecated, use -Select '^Key' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Key' 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
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.TableName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-DDBItem (UpdateItem)"))
{
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.Key;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.AttributeUpdate != null)
{
context.AttributeUpdate = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.AttributeUpdate.Keys)
{
context.AttributeUpdate.Add((String)hashKey, (AttributeValueUpdate)(this.AttributeUpdate[hashKey]));
}
}
context.ConditionalOperator = this.ConditionalOperator;
context.ConditionExpression = this.ConditionExpression;
if (this.Expected != null)
{
context.Expected = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Expected.Keys)
{
context.Expected.Add((String)hashKey, (ExpectedAttributeValue)(this.Expected[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]));
}
}
if (this.Key != null)
{
context.Key = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Key.Keys)
{
context.Key.Add((String)hashKey, (AttributeValue)(this.Key[hashKey]));
}
}
#if MODULAR
if (this.Key == null && ParameterWasBound(nameof(this.Key)))
{
WriteWarning("You are passing $null as a value for parameter Key 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
context.ReturnConsumedCapacity = this.ReturnConsumedCapacity;
context.ReturnItemCollectionMetric = this.ReturnItemCollectionMetric;
context.ReturnValue = this.ReturnValue;
context.ReturnValuesOnConditionCheckFailure = this.ReturnValuesOnConditionCheckFailure;
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
context.UpdateExpression = this.UpdateExpression;
// 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;
// create request
var request = new Amazon.DynamoDBv2.Model.UpdateItemRequest();
if (cmdletContext.AttributeUpdate != null)
{
request.AttributeUpdates = cmdletContext.AttributeUpdate;
}
if (cmdletContext.ConditionalOperator != null)
{
request.ConditionalOperator = cmdletContext.ConditionalOperator;
}
if (cmdletContext.ConditionExpression != null)
{
request.ConditionExpression = cmdletContext.ConditionExpression;
}
if (cmdletContext.Expected != null)
{
request.Expected = cmdletContext.Expected;
}
if (cmdletContext.ExpressionAttributeName != null)
{
request.ExpressionAttributeNames = cmdletContext.ExpressionAttributeName;
}
if (cmdletContext.ExpressionAttributeValue != null)
{
request.ExpressionAttributeValues = cmdletContext.ExpressionAttributeValue;
}
if (cmdletContext.Key != null)
{
request.Key = cmdletContext.Key;
}
if (cmdletContext.ReturnConsumedCapacity != null)
{
request.ReturnConsumedCapacity = cmdletContext.ReturnConsumedCapacity;
}
if (cmdletContext.ReturnItemCollectionMetric != null)
{
request.ReturnItemCollectionMetrics = cmdletContext.ReturnItemCollectionMetric;
}
if (cmdletContext.ReturnValue != null)
{
request.ReturnValues = cmdletContext.ReturnValue;
}
if (cmdletContext.ReturnValuesOnConditionCheckFailure != null)
{
request.ReturnValuesOnConditionCheckFailure = cmdletContext.ReturnValuesOnConditionCheckFailure;
}
if (cmdletContext.TableName != null)
{
request.TableName = cmdletContext.TableName;
}
if (cmdletContext.UpdateExpression != null)
{
request.UpdateExpression = cmdletContext.UpdateExpression;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.DynamoDBv2.Model.UpdateItemResponse CallAWSServiceOperation(IAmazonDynamoDB client, Amazon.DynamoDBv2.Model.UpdateItemRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon DynamoDB", "UpdateItem");
try
{
#if DESKTOP
return client.UpdateItem(request);
#elif CORECLR
return client.UpdateItemAsync(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 Dictionary AttributeUpdate { get; set; }
public Amazon.DynamoDBv2.ConditionalOperator ConditionalOperator { get; set; }
public System.String ConditionExpression { get; set; }
public Dictionary Expected { get; set; }
public Dictionary ExpressionAttributeName { get; set; }
public Dictionary ExpressionAttributeValue { get; set; }
public Dictionary Key { get; set; }
public Amazon.DynamoDBv2.ReturnConsumedCapacity ReturnConsumedCapacity { get; set; }
public Amazon.DynamoDBv2.ReturnItemCollectionMetrics ReturnItemCollectionMetric { get; set; }
public Amazon.DynamoDBv2.ReturnValue ReturnValue { get; set; }
public Amazon.DynamoDBv2.ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure { get; set; }
public System.String TableName { get; set; }
public System.String UpdateExpression { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Attributes;
}
}
}