AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon DynamoDB DeleteItem API operation.

Syntax

Remove-DDBItem
-Key <Hashtable>
-ConditionalOperator <ConditionalOperator>
-ConditionExpression <String>
-Expected <Hashtable>
-ExpressionAttributeName <Hashtable>
-ExpressionAttributeValue <Hashtable>
-ReturnConsumedCapacity <ReturnConsumedCapacity>
-ReturnItemCollectionMetric <ReturnItemCollectionMetrics>
-ReturnValue <ReturnValue>
-ReturnValuesOnConditionCheckFailure <ReturnValuesOnConditionCheckFailure>
-TableName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDynamoDBConfig>

Description

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter. Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

Parameters

-ClientConfig <AmazonDynamoDBConfig>
Amazon.PowerShell.Cmdlets.DDB.AmazonDynamoDBClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConditionalOperator <ConditionalOperator>
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConditionExpression <String>
A condition that must be satisfied in order for a conditional DeleteItem 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 Condition Expressions in the Amazon DynamoDB Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Expected <Hashtable>
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExpressionAttributeName <Hashtable>
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:
  • Percentile
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:
  • {"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
  • #P = :val
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExpressionAttributeNames
-ExpressionAttributeValue <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExpressionAttributeValues
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Key <Hashtable>
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.For the primary key, you must provide all of the key 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.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReturnConsumedCapacity <ReturnConsumedCapacity>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReturnItemCollectionMetric <ReturnItemCollectionMetrics>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReturnItemCollectionMetrics
-ReturnValue <ReturnValue>
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
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 ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReturnValues
-ReturnValuesOnConditionCheckFailure <ReturnValuesOnConditionCheckFailure>
An optional parameter that returns the item attributes for a DeleteItem 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.DeleteItemResponse). Specifying the name of a property of type Amazon.DynamoDBv2.Model.DeleteItemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableName <String>
The name of the table from which to delete the item.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.DynamoDBv2.Model.DeleteItemResponse
This cmdlet returns a collection of System.String objects. The service call response (type Amazon.DynamoDBv2.Model.DeleteItemResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

$key = @{
    SongTitle = 'Somewhere Down The Road'
    Artist = 'No One You Know'
} | ConvertTo-DDBItem

Remove-DDBItem -TableName 'Music' -Key $key -Confirm:$false
    
Removes the DynamoDB item that matches the provided key.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z