Skip to content

Get

Source code in docs_src/capo_dynamodb/types/get.py
class Get(TypedDict, closed=True):
    key: "capo_dynamodb.types.key.Key"
    """<p>A map of attribute names to <code>AttributeValue</code> objects that specifies the primary key of the item to retrieve.</p>"""
    table_name: "capo_dynamodb.types.table_arn.TableArn"
    """<p>The name of the table from which to retrieve the specified item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>"""
    projection_expression: NotRequired[
        "capo_dynamodb.types.projection_expression.ProjectionExpression"
    ]
    """<p>A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.</p>"""
    expression_attribute_names: NotRequired[
        "capo_dynamodb.types.expression_attribute_name_map.ExpressionAttributeNameMap"
    ]
    """<p>One or more substitution tokens for attribute names in the ProjectionExpression parameter.</p>"""

expression_attribute_names instance-attribute

expression_attribute_names: NotRequired[ExpressionAttributeNameMap]

One or more substitution tokens for attribute names in the ProjectionExpression parameter.

key instance-attribute

key: Key

A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

projection_expression instance-attribute

projection_expression: NotRequired[ProjectionExpression]

A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.

table_name instance-attribute

table_name: TableArn

The name of the table from which to retrieve the specified item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.