Amazonka.DynamoDB.DeleteItem

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.

Creating a Request

data DeleteItem

Represents the input of a DeleteItem operation.

See: newDeleteItem smart constructor.

Constructors

DeleteItem'

Fields

• conditionExpression :: Maybe Text

  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 in the Amazon DynamoDB Developer Guide.

• conditionalOperator :: Maybe ConditionalOperator

  This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

• expected :: Maybe (HashMap Text ExpectedAttributeValue)

  This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

• expressionAttributeNames :: Maybe (HashMap Text Text)

  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.

• expressionAttributeValues :: Maybe (HashMap Text AttributeValue)

  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 in the Amazon DynamoDB Developer Guide.

• returnConsumedCapacity :: Maybe ReturnConsumedCapacity
• returnItemCollectionMetrics :: Maybe 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.

• returnValues :: Maybe 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.

• tableName :: Text

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

• key :: HashMap Text AttributeValue

  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.

Instances

ToJSON DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Methods

toJSON :: DeleteItem -> Value

toEncoding :: DeleteItem -> Encoding

toJSONList :: [DeleteItem] -> Value

toEncodingList :: [DeleteItem] -> Encoding

ToHeaders DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Methods

toHeaders :: DeleteItem -> [Header]

ToPath DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Methods

toPath :: DeleteItem -> ByteString

ToQuery DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Methods

toQuery :: DeleteItem -> QueryString

AWSRequest DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Associated Types

type AWSResponse DeleteItem

Methods

request :: (Service -> Service) -> DeleteItem -> Request DeleteItem

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteItem -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteItem)))

Generic DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Associated Types

type Rep DeleteItem :: Type -> Type

Methods

from :: DeleteItem -> Rep DeleteItem x

to :: Rep DeleteItem x -> DeleteItem

Read DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Methods

readsPrec :: Int -> ReadS DeleteItem

readList :: ReadS [DeleteItem]

readPrec :: ReadPrec DeleteItem

readListPrec :: ReadPrec [DeleteItem]

Show DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Methods

showsPrec :: Int -> DeleteItem -> ShowS

show :: DeleteItem -> String

showList :: [DeleteItem] -> ShowS

NFData DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Methods

rnf :: DeleteItem -> ()

Eq DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Methods

(==) :: DeleteItem -> DeleteItem -> Bool

(/=) :: DeleteItem -> DeleteItem -> Bool

Hashable DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

Methods

hashWithSalt :: Int -> DeleteItem -> Int

hash :: DeleteItem -> Int

type AWSResponse DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

type AWSResponse DeleteItem = DeleteItemResponse

type Rep DeleteItem

Defined in Amazonka.DynamoDB.DeleteItem

type Rep DeleteItem = D1 ('MetaData "DeleteItem" "Amazonka.DynamoDB.DeleteItem" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "DeleteItem'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "conditionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "conditionalOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConditionalOperator))) :*: (S1 ('MetaSel ('Just "expected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ExpectedAttributeValue))) :*: (S1 ('MetaSel ('Just "expressionAttributeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "expressionAttributeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AttributeValue)))))) :*: ((S1 ('MetaSel ('Just "returnConsumedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReturnConsumedCapacity)) :*: S1 ('MetaSel ('Just "returnItemCollectionMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReturnItemCollectionMetrics))) :*: (S1 ('MetaSel ('Just "returnValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReturnValue)) :*: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text AttributeValue)))))))

newDeleteItem

Arguments

:: Text

DeleteItem

-> DeleteItem

Create a value of DeleteItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteItem, deleteItem_conditionExpression - 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 in the Amazon DynamoDB Developer Guide.

$sel:conditionalOperator:DeleteItem', deleteItem_conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

$sel:expected:DeleteItem', deleteItem_expected - This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

DeleteItem, deleteItem_expressionAttributeNames - 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.

DeleteItem, deleteItem_expressionAttributeValues - 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 in the Amazon DynamoDB Developer Guide.

$sel:returnConsumedCapacity:DeleteItem', deleteItem_returnConsumedCapacity - Undocumented member.

$sel:returnItemCollectionMetrics:DeleteItem', deleteItem_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.

$sel:returnValues:DeleteItem', deleteItem_returnValues - 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.

DeleteItem, deleteItem_tableName - The name of the table from which to delete the item.

DeleteItem, deleteItem_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.

Request Lenses

deleteItem_conditionExpression :: Lens' DeleteItem (Maybe Text)

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 in the Amazon DynamoDB Developer Guide.

deleteItem_conditionalOperator :: Lens' DeleteItem (Maybe ConditionalOperator)

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

deleteItem_expected :: Lens' DeleteItem (Maybe (HashMap Text ExpectedAttributeValue))

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

deleteItem_expressionAttributeNames :: Lens' DeleteItem (Maybe (HashMap Text Text))

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.

deleteItem_expressionAttributeValues :: Lens' DeleteItem (Maybe (HashMap Text AttributeValue))

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 in the Amazon DynamoDB Developer Guide.

deleteItem_returnConsumedCapacity :: Lens' DeleteItem (Maybe ReturnConsumedCapacity)

Undocumented member.

deleteItem_returnItemCollectionMetrics :: Lens' DeleteItem (Maybe 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.

deleteItem_returnValues :: Lens' DeleteItem (Maybe 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.

deleteItem_tableName :: Lens' DeleteItem Text

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

deleteItem_key :: Lens' DeleteItem (HashMap Text AttributeValue)

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.

Destructuring the Response

data DeleteItemResponse

Represents the output of a DeleteItem operation.

See: newDeleteItemResponse smart constructor.

Constructors

DeleteItemResponse'

Fields

• attributes :: Maybe (HashMap Text AttributeValue)

  A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

• consumedCapacity :: Maybe ConsumedCapacity

  The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Mode in the Amazon DynamoDB Developer Guide.

• itemCollectionMetrics :: Maybe ItemCollectionMetrics

  Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

  Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteItemResponse

Defined in Amazonka.DynamoDB.DeleteItem

Associated Types

type Rep DeleteItemResponse :: Type -> Type

Methods

from :: DeleteItemResponse -> Rep DeleteItemResponse x

to :: Rep DeleteItemResponse x -> DeleteItemResponse

Read DeleteItemResponse

Defined in Amazonka.DynamoDB.DeleteItem

Methods

readsPrec :: Int -> ReadS DeleteItemResponse

readList :: ReadS [DeleteItemResponse]

readPrec :: ReadPrec DeleteItemResponse

readListPrec :: ReadPrec [DeleteItemResponse]

Show DeleteItemResponse

Defined in Amazonka.DynamoDB.DeleteItem

Methods

showsPrec :: Int -> DeleteItemResponse -> ShowS

show :: DeleteItemResponse -> String

showList :: [DeleteItemResponse] -> ShowS

NFData DeleteItemResponse

Defined in Amazonka.DynamoDB.DeleteItem

Methods

rnf :: DeleteItemResponse -> ()

Eq DeleteItemResponse

Defined in Amazonka.DynamoDB.DeleteItem

Methods

(==) :: DeleteItemResponse -> DeleteItemResponse -> Bool

(/=) :: DeleteItemResponse -> DeleteItemResponse -> Bool

type Rep DeleteItemResponse

Defined in Amazonka.DynamoDB.DeleteItem

type Rep DeleteItemResponse = D1 ('MetaData "DeleteItemResponse" "Amazonka.DynamoDB.DeleteItem" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "DeleteItemResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AttributeValue))) :*: S1 ('MetaSel ('Just "consumedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConsumedCapacity))) :*: (S1 ('MetaSel ('Just "itemCollectionMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ItemCollectionMetrics)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDeleteItemResponse

Arguments

:: Int

$sel:httpStatus:DeleteItemResponse'

-> DeleteItemResponse

Create a value of DeleteItemResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributes:DeleteItemResponse', deleteItemResponse_attributes - A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

$sel:consumedCapacity:DeleteItemResponse', deleteItemResponse_consumedCapacity - The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Mode in the Amazon DynamoDB Developer Guide.

$sel:itemCollectionMetrics:DeleteItemResponse', deleteItemResponse_itemCollectionMetrics - Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

• ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

• SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

$sel:httpStatus:DeleteItemResponse', deleteItemResponse_httpStatus - The response's http status code.

Response Lenses

deleteItemResponse_attributes :: Lens' DeleteItemResponse (Maybe (HashMap Text AttributeValue))

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

deleteItemResponse_consumedCapacity :: Lens' DeleteItemResponse (Maybe ConsumedCapacity)

The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Mode in the Amazon DynamoDB Developer Guide.

deleteItemResponse_itemCollectionMetrics :: Lens' DeleteItemResponse (Maybe ItemCollectionMetrics)

Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

• ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

• SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

deleteItemResponse_httpStatus :: Lens' DeleteItemResponse Int

The response's http status code.