GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::DynamoDB::DeleteItem(3) User Contributed Perl Documentation Paws::DynamoDB::DeleteItem(3)

Paws::DynamoDB::DeleteItem - Arguments for method DeleteItem on Paws::DynamoDB

This class represents the parameters used for calling the method DeleteItem on the Amazon DynamoDB service. Use the attributes of this class as arguments to method DeleteItem.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteItem.

    my $dynamodb = Paws->service('DynamoDB');
    # To delete an item
    # This example deletes an item from the Music table.
    my $DeleteItemOutput = $dynamodb->DeleteItem(
      'Key' => {
        'Artist' => {
          'S' => 'No One You Know'
        },
        'SongTitle' => {
          'S' => 'Scared of My Shadow'
        }
      },
      'TableName' => 'Music'
    );
    # Results:
    my $ConsumedCapacity = $DeleteItemOutput->ConsumedCapacity;
    # Returns a L<Paws::DynamoDB::DeleteItemOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/dynamodb/DeleteItem>

This is a legacy parameter. Use "ConditionExpression" instead. For more information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the Amazon DynamoDB Developer Guide.

Valid values are: "AND", "OR"

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 | size"

    These function names are case-sensitive.

  • Comparison operators: "= | <> | < | > | <= | >= | BETWEEN | IN"
  • Logical operators: "AND | OR | NOT"

For more information about condition expressions, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the Amazon DynamoDB Developer Guide.

This is a legacy parameter. Use "ConditionExpression" instead. For more information, see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) in the Amazon DynamoDB Developer Guide.

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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) 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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the Amazon DynamoDB Developer Guide.

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 | Discontinued"

You 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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the Amazon DynamoDB Developer Guide.

REQUIRED Key => Paws::DynamoDB::Key

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 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.

Valid values are: "INDEXES", "TOTAL", "NONE"

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.

Valid values are: "SIZE", "NONE"

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.

The "ReturnValues" parameter is used by several DynamoDB operations; however, "DeleteItem" does not recognize any values other than "NONE" or "ALL_OLD".

Valid values are: "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW"

REQUIRED TableName => Str

The name of the table from which to delete the item.

This class forms part of Paws, documenting arguments for method DeleteItem in Paws::DynamoDB

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.