How do we query on a secondary index of dynamodb using boto3?

Question

Is there a way at all to query on the global secondary index of dynamodb using boto3. I dont find any online tutorials or resources.

Answer 1

You need to provide an IndexName parameter for the query function.

This is the name of the index, which is usually different from the name of the index attribute (the name of the index has an -index suffix by default, although you can change it during table creation). For example, if your index attribute is called video_id, your index name is probably video_id-index.

import boto3 from boto3.dynamodb.conditions import Key dynamodb = boto3.resource('dynamodb') table = dynamodb.Table('videos') video_id = 25 response = table.query(     IndexName='video_id-index',     KeyConditionExpression=Key('video_id').eq(video_id) ) 

To check the index name, go to the Indexes tab of the table on the web interface of AWS. You'll need a value from the Name column.

Answer 2

For anyone using the boto3 client, below example should work:

import boto3      # for production client = boto3.client('dynamodb')  # for local development if running local dynamodb server client = boto3.client(    'dynamodb',    region_name='localhost',    endpoint_url='http://localhost:8000' )  resp = client.query(    TableName='UsersTabe',    IndexName='MySecondaryIndexName',    ExpressionAttributeValues={        ':v1': {            'S': '[email protected]',        },    },    KeyConditionExpression='emailField = :v1', )  # will always return list items = resp.get('Items')  first_item = items[0]