DynamoDB JSON parameter templates

dynamodb-params.js

var createTable = {
  TableName: 'STRING_VALUE', /* required */
  ProvisionedThroughput: { /* required */
    ReadCapacityUnits: 0, /* required */
    WriteCapacityUnits: 0 /* required */
  },
  KeySchema: [ /* required */
    {AttributeName: 'STRING_VALUE', KeyType: 'HASH | RANGE'}, /* required */
    /* more items */
  ],
  AttributeDefinitions: [ /* required */
    {AttributeName: 'STRING_VALUE', AttributeType: 'S | N | B'}, /* required */
    /* more items */
  ],
  GlobalSecondaryIndexes: [
    {
      IndexName: 'STRING_VALUE', /* required */
      KeySchema: [ /* required */
        {AttributeName: 'STRING_VALUE', KeyType: 'HASH | RANGE'}, /* required */
        /* more items */
      ],
      Projection: { /* required */
        NonKeyAttributes: ['STRING_VALUE',], /* more items */
        ProjectionType: 'ALL | KEYS_ONLY | INCLUDE'
      },
      ProvisionedThroughput: { /* required */
        ReadCapacityUnits: 0, /* required */
        WriteCapacityUnits: 0 /* required */
      }
    }, /* more items */
  ],
  LocalSecondaryIndexes: [
    {
      IndexName: 'STRING_VALUE', /* required */
      KeySchema: [ /* required */
        {AttributeName: 'STRING_VALUE', KeyType: 'HASH | RANGE'}, /* required */
        /* more items */
      ],
      Projection: { /* required */
        NonKeyAttributes: ['STRING_VALUE',],/* more items */
        ProjectionType: 'ALL | KEYS_ONLY | INCLUDE'
      }
    }, /* more items */
  ]
};

var putItem = {
  TableName: 'STRING_VALUE', /* required */
  Item: { /* required */
    someKey: {
      B: new Buffer('...') || 'STRING_VALUE',
      BS: [new Buffer('...') || 'STRING_VALUE',], /* more items */
      N: 'STRING_VALUE',
      NS: ['STRING_VALUE',], /* more items */
      S: 'STRING_VALUE',
      SS: ['STRING_VALUE',] /* more items */
    }, /* anotherKey: ... */
  },
  ConditionalOperator: 'AND | OR',
  Expected: {
    someKey: {
      AttributeValueList: [
        {
          B: new Buffer('...') || 'STRING_VALUE',
          BS: [new Buffer('...') || 'STRING_VALUE',], /* more items */
          N: 'STRING_VALUE',
          NS: ['STRING_VALUE',], /* more items */
          S: 'STRING_VALUE',
          SS: ['STRING_VALUE',] /* more items */
        }, /* more items */
      ],
      ComparisonOperator: 'EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH',
      Exists: true || false,
      Value: {
        B: new Buffer('...') || 'STRING_VALUE',
        BS: [new Buffer('...') || 'STRING_VALUE',], /* more items */
        N: 'STRING_VALUE',
        NS: ['STRING_VALUE',], /* more items */
        S: 'STRING_VALUE',
        SS: ['STRING_VALUE',] /* more items */
      }
    }, /* anotherKey: ... */
  },
  ReturnConsumedCapacity: 'INDEXES | TOTAL | NONE',
  ReturnItemCollectionMetrics: 'SIZE | NONE',
  ReturnValues: 'NONE | ALL_OLD | UPDATED_OLD | ALL_NEW | UPDATED_NEW'
};

var getItem = {
  TableName: 'STRING_VALUE', /* required */
  Key: { /* required */
    someKey: {
      B: new Buffer('...') || 'STRING_VALUE',
      BS: [new Buffer('...') || 'STRING_VALUE',], /* more items */
      N: 'STRING_VALUE',
      NS: ['STRING_VALUE',], /* more items */
      S: 'STRING_VALUE',
      SS: ['STRING_VALUE',] /* more items */
    }, /* anotherKey: ... */
  },
  AttributesToGet: ['STRING_VALUE',], /* more items */
  ConsistentRead: true || false,
  ReturnConsumedCapacity: 'INDEXES | TOTAL | NONE'
};

var query = {
  TableName: 'STRING_VALUE', /* required */
  KeyConditions: { /* required */
    someKey: {
      ComparisonOperator: 'EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH', /* required */
      AttributeValueList: [
        {
          B: new Buffer('...') || 'STRING_VALUE',
          BS: [new Buffer('...') || 'STRING_VALUE',], /* more items */
          N: 'STRING_VALUE',
          NS: ['STRING_VALUE',], /* more items */
          S: 'STRING_VALUE',
          SS: ['STRING_VALUE',] /* more items */
        }, /* more items */
      ]
    }, /* anotherKey: ... */
  },
  AttributesToGet: ['STRING_VALUE',], /* more items */
  ConditionalOperator: 'AND | OR',
  ConsistentRead: true || false,
  ExclusiveStartKey: {
    someKey: {
      B: new Buffer('...') || 'STRING_VALUE',
      BS: [new Buffer('...') || 'STRING_VALUE',], /* more items */
      N: 'STRING_VALUE',
      NS: ['STRING_VALUE',], /* more items */
      S: 'STRING_VALUE',
      SS: ['STRING_VALUE',] /* more items */
    }, /* anotherKey: ... */
  },
  IndexName: 'STRING_VALUE',
  Limit: 0,
  QueryFilter: {
    someKey: {
      ComparisonOperator: 'EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH', /* required */
      AttributeValueList: [
        {
          B: new Buffer('...') || 'STRING_VALUE',
          BS: [new Buffer('...') || 'STRING_VALUE',], /* more items */
          N: 'STRING_VALUE',
          NS: ['STRING_VALUE',], /* more items */
          S: 'STRING_VALUE',
          SS: ['STRING_VALUE',] /* more items */
        }, /* more items */
      ]
    }, /* anotherKey: ... */
  },
  ReturnConsumedCapacity: 'INDEXES | TOTAL | NONE',
  ScanIndexForward: true || false,
  Select: 'ALL_ATTRIBUTES | ALL_PROJECTED_ATTRIBUTES | SPECIFIC_ATTRIBUTES | COUNT'
};