@mcma/aws-dynamodb/dist/lib/dynamo-db-table-description.d.ts

Node module with code for using DynamoDB as the backing data storage for MCMA API handlers and workers.

import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
export interface DynamoDbTableDescription {
    tableName: string;
    keyNames: KeyNames;
    localSecondaryIndexes: LocalSecondaryIndexDescription[];
    globalSecondaryIndexes: GlobalSecondaryIndexDescription[];
}
export interface KeyNames {
    partition: string;
    sort?: string;
}
export interface LocalSecondaryIndexDescription {
    name: string;
    sortKeyName: string;
}
export interface GlobalSecondaryIndexDescription {
    name: string;
    keyNames: KeyNames;
}
export declare function getTableDescription(dynamoDBClient: DynamoDBClient, tableName: string): Promise<DynamoDbTableDescription>;