DynamoDBAction ¶

class DynamoDBAction(TypedDict, closed=True):
    hash_key_type: NotRequired["capo_iot_events.types.dynamo_key_type.DynamoKeyType"]
    """<p>The data type for the hash key (also called the partition key). You can specify the following values:</p> <ul> <li> <p> <code>'STRING'</code> - The hash key is a string.</p> </li> <li> <p> <code>'NUMBER'</code> - The hash key is a number.</p> </li> </ul> <p>If you don't specify <code>hashKeyType</code>, the default value is <code>'STRING'</code>.</p>"""
    hash_key_field: "capo_iot_events.types.dynamo_key_field.DynamoKeyField"
    """<p>The name of the hash key (also called the partition key). The <code>hashKeyField</code> value must match the partition key of the target DynamoDB table.</p>"""
    hash_key_value: "capo_iot_events.types.dynamo_key_value.DynamoKeyValue"
    """<p>The value of the hash key (also called the partition key).</p>"""
    range_key_type: NotRequired["capo_iot_events.types.dynamo_key_type.DynamoKeyType"]
    """<p>The data type for the range key (also called the sort key), You can specify the following values:</p> <ul> <li> <p> <code>'STRING'</code> - The range key is a string.</p> </li> <li> <p> <code>'NUMBER'</code> - The range key is number.</p> </li> </ul> <p>If you don't specify <code>rangeKeyField</code>, the default value is <code>'STRING'</code>.</p>"""
    range_key_field: NotRequired[
        "capo_iot_events.types.dynamo_key_field.DynamoKeyField"
    ]
    """<p>The name of the range key (also called the sort key). The <code>rangeKeyField</code> value must match the sort key of the target DynamoDB table. </p>"""
    range_key_value: NotRequired[
        "capo_iot_events.types.dynamo_key_value.DynamoKeyValue"
    ]
    """<p>The value of the range key (also called the sort key).</p>"""
    operation: NotRequired["capo_iot_events.types.dynamo_operation.DynamoOperation"]
    """<p>The type of operation to perform. You can specify the following values: </p> <ul> <li> <p> <code>'INSERT'</code> - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.</p> </li> <li> <p> <code>'UPDATE'</code> - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.</p> </li> <li> <p> <code>'DELETE'</code> - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.</p> </li> </ul> <p>If you don't specify this parameter, AWS IoT Events triggers the <code>'INSERT'</code> operation.</p>"""
    payload_field: NotRequired["capo_iot_events.types.dynamo_key_field.DynamoKeyField"]
    """<p>The name of the DynamoDB column that receives the action payload.</p> <p>If you don't specify this parameter, the name of the DynamoDB column is <code>payload</code>.</p>"""
    table_name: "capo_iot_events.types.dynamo_table_name.DynamoTableName"
    """<p>The name of the DynamoDB table. The <code>tableName</code> value must match the table name of the target DynamoDB table. </p>"""
    payload: NotRequired["capo_iot_events.types.payload.Payload"]