package Paws::DynamoDB::DeleteItem; use Moose; has ConditionalOperator => (is => 'ro', isa => 'Str'); has ConditionExpression => (is => 'ro', isa => 'Str'); has Expected => (is => 'ro', isa => 'Paws::DynamoDB::ExpectedAttributeMap'); has ExpressionAttributeNames => (is => 'ro', isa => 'Paws::DynamoDB::ExpressionAttributeNameMap'); has ExpressionAttributeValues => (is => 'ro', isa => 'Paws::DynamoDB::ExpressionAttributeValueMap'); has Key => (is => 'ro', isa => 'Paws::DynamoDB::Key', required => 1); has ReturnConsumedCapacity => (is => 'ro', isa => 'Str'); has ReturnItemCollectionMetrics => (is => 'ro', isa => 'Str'); has ReturnValues => (is => 'ro', isa => 'Str'); has TableName => (is => 'ro', isa => 'Str', required => 1); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteItem'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::DeleteItemOutput'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::DynamoDB::DeleteItem - Arguments for method DeleteItem on L =head1 DESCRIPTION This class represents the parameters used for calling the method DeleteItem on the L 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. =head1 SYNOPSIS 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 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 L =head1 ATTRIBUTES =head2 ConditionalOperator => Str This is a legacy parameter. Use C instead. For more information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the I. Valid values are: C<"AND">, C<"OR"> =head2 ConditionExpression => Str A condition that must be satisfied in order for a conditional C to succeed. An expression can contain any of the following: =over =item * Functions: C These function names are case-sensitive. =item * Comparison operators: C<= | EE | E | E | E= | E= | BETWEEN | IN> =item * Logical operators: C =back For more information about condition expressions, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the I. =head2 Expected => L This is a legacy parameter. Use C instead. For more information, see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) in the I. =head2 ExpressionAttributeNames => L One or more substitution tokens for attribute names in an expression. The following are some use cases for using C: =over =item * To access an attribute whose name conflicts with a DynamoDB reserved word. =item * To create a placeholder for repeating occurrences of an attribute name in an expression. =item * To prevent special characters in an attribute name from being misinterpreted in an expression. =back Use the B<#> character in an expression to dereference an attribute name. For example, consider the following attribute name: =over =item * C =back 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 I). To work around this, you could specify the following for C: =over =item * C<{"#P":"Percentile"}> =back You could then use this substitution in an expression, as in this example: =over =item * C<#P = :val> =back Tokens that begin with the B<:> character are I, 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 I. =head2 ExpressionAttributeValues => L One or more values that can be substituted in an expression. Use the B<:> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the I attribute was one of the following: C You would first need to specify C as follows: C<{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }> You could then use these values in an expression, such as this: C For more information on expression attribute values, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the I. =head2 B Key => L A map of attribute names to C 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. =head2 ReturnConsumedCapacity => Str Valid values are: C<"INDEXES">, C<"TOTAL">, C<"NONE"> =head2 ReturnItemCollectionMetrics => Str Determines whether item collection metrics are returned. If set to C, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to C (the default), no statistics are returned. Valid values are: C<"SIZE">, C<"NONE"> =head2 ReturnValues => Str Use C if you want to get the item attributes as they appeared before they were deleted. For C, the valid values are: =over =item * C - If C is not specified, or if its value is C, then nothing is returned. (This setting is the default for C.) =item * C - The content of the old item is returned. =back The C parameter is used by several DynamoDB operations; however, C does not recognize any values other than C or C. Valid values are: C<"NONE">, C<"ALL_OLD">, C<"UPDATED_OLD">, C<"ALL_NEW">, C<"UPDATED_NEW"> =head2 B TableName => Str The name of the table from which to delete the item. =head1 SEE ALSO This class forms part of L, documenting arguments for method DeleteItem in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut