Class: AWS.DynamoDB

/* This example reads multiple items from the Music table using a batch of three GetItem requests.  Only the AlbumTitle attribute is returned. */

 var params = {
  RequestItems: {
   "Music": {
     Keys: [
        {
       "Artist": {
         S: "No One You Know"
        }, 
       "SongTitle": {
         S: "Call Me Today"
        }
      }, 
        {
       "Artist": {
         S: "Acme Band"
        }, 
       "SongTitle": {
         S: "Happy Day"
        }
      }, 
        {
       "Artist": {
         S: "No One You Know"
        }, 
       "SongTitle": {
         S: "Scared of My Shadow"
        }
      }
     ], 
     ProjectionExpression: "AlbumTitle"
    }
  }
 };
 dynamodb.batchGetItem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Responses: {
     "Music": [
         {
        "AlbumTitle": {
          S: "Somewhat Famous"
         }
       }, 
         {
        "AlbumTitle": {
          S: "Blue Sky Blues"
         }
       }, 
         {
        "AlbumTitle": {
          S: "Louder Than Ever"
         }
       }
      ]
    }
   }
   */
 });

var params = {
  RequestItems: { /* required */
    '<TableArn>': {
      Keys: [ /* required */
        {
          '<AttributeName>': { /* AttributeValue */
            B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<AttributeName>': ... */
        },
        /* more items */
      ],
      AttributesToGet: [
        'STRING_VALUE',
        /* more items */
      ],
      ConsistentRead: true || false,
      ExpressionAttributeNames: {
        '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
        /* '<ExpressionAttributeNameVariable>': ... */
      },
      ProjectionExpression: 'STRING_VALUE'
    },
    /* '<TableArn>': ... */
  },
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE
};
dynamodb.batchGetItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RequestItems — (map<map>)

    A map of one or more table names or table ARNs and, for each table, a map that describes one or more items to retrieve from that table. Each table name or ARN can be used only once per BatchGetItem request.

    Each element in the map of items to retrieve consists of the following:

    • ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

    • ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:

      • To access an attribute whose name conflicts with a DynamoDB reserved word.

      • To create a placeholder for repeating occurrences of an attribute name in an expression.

      • To prevent special characters in an attribute name from being misinterpreted in an expression.

      Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

      • Percentile

      The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

      • {"#P":"Percentile"}

      You could then use this substitution in an expression, as in this example:

      • #P = :val

      Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

      For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.

    • ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

      If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.

      For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

    • Keys — required — (Array<map<map>>)

      The primary key attribute values that define the items and the attributes associated with the items.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • AttributesToGet — (Array<String>)

      This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

    • ConsistentRead — (Boolean)

      The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

    • ProjectionExpression — (String)

      A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.

      If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

      For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeNames — (map<String>)

      One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

      • To access an attribute whose name conflicts with a DynamoDB reserved word.

      • To create a placeholder for repeating occurrences of an attribute name in an expression.

      • To prevent special characters in an attribute name from being misinterpreted in an expression.

      Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

      • Percentile

      The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

      • {"#P":"Percentile"}

      You could then use this substitution in an expression, as in this example:

      • #P = :val

      Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

      For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

  • ReturnConsumedCapacity — (String)

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

    Possible values include:
    • "INDEXES"
    • "TOTAL"
    • "NONE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Responses — (map<Array<map<map>>>)

      A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • UnprocessedKeys — (map<map>)

      A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

      Each element consists of:

      • Keys - An array of primary key attribute values that define specific items in the table.

      • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

      • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

      If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

      • Keys — required — (Array<map<map>>)

        The primary key attribute values that define the items and the attributes associated with the items.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • AttributesToGet — (Array<String>)

        This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

      • ConsistentRead — (Boolean)

        The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

      • ProjectionExpression — (String)

        A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.

        If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

        For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

      • ExpressionAttributeNames — (map<String>)

        One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

        • To access an attribute whose name conflicts with a DynamoDB reserved word.

        • To create a placeholder for repeating occurrences of an attribute name in an expression.

        • To prevent special characters in an attribute name from being misinterpreted in an expression.

        Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

        • Percentile

        The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

        • {"#P":"Percentile"}

        You could then use this substitution in an expression, as in this example:

        • #P = :val

        Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

        For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • ConsumedCapacity — (Array<map>)

      The read capacity units consumed by the entire BatchGetItem operation.

      Each element consists of:

      • TableName - The table that consumed the provisioned throughput.

      • CapacityUnits - The total number of capacity units consumed.

      • TableName — (String)

        The name of the table that was affected by the operation. If you had specified the Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.

      • CapacityUnits — (Float)

        The total number of capacity units consumed by the operation.

      • ReadCapacityUnits — (Float)

        The total number of read capacity units consumed by the operation.

      • WriteCapacityUnits — (Float)

        The total number of write capacity units consumed by the operation.

      • Table — (map)

        The amount of throughput consumed on the table affected by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed on a table or an index.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed on a table or an index.

        • CapacityUnits — (Float)

          The total number of capacity units consumed on a table or an index.

      • LocalSecondaryIndexes — (map<map>)

        The amount of throughput consumed on each local index affected by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed on a table or an index.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed on a table or an index.

        • CapacityUnits — (Float)

          The total number of capacity units consumed on a table or an index.

      • GlobalSecondaryIndexes — (map<map>)

        The amount of throughput consumed on each global index affected by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed on a table or an index.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed on a table or an index.

        • CapacityUnits — (Float)

          The total number of capacity units consumed on a table or an index.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example adds three new items to the Music table using a batch of three PutItem requests. */

 var params = {
  RequestItems: {
   "Music": [
       {
      PutRequest: {
       Item: {
        "AlbumTitle": {
          S: "Somewhat Famous"
         }, 
        "Artist": {
          S: "No One You Know"
         }, 
        "SongTitle": {
          S: "Call Me Today"
         }
       }
      }
     }, 
       {
      PutRequest: {
       Item: {
        "AlbumTitle": {
          S: "Songs About Life"
         }, 
        "Artist": {
          S: "Acme Band"
         }, 
        "SongTitle": {
          S: "Happy Day"
         }
       }
      }
     }, 
       {
      PutRequest: {
       Item: {
        "AlbumTitle": {
          S: "Blue Sky Blues"
         }, 
        "Artist": {
          S: "No One You Know"
         }, 
        "SongTitle": {
          S: "Scared of My Shadow"
         }
       }
      }
     }
    ]
  }
 };
 dynamodb.batchWriteItem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  RequestItems: { /* required */
    '<TableArn>': [
      {
        DeleteRequest: {
          Key: { /* required */
            '<AttributeName>': { /* AttributeValue */
              B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BOOL: true || false,
              BS: [
                Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                /* more items */
              ],
              L: [
                /* recursive AttributeValue */,
                /* more items */
              ],
              M: {
                '<AttributeName>': /* recursive AttributeValue */,
                /* '<AttributeName>': ... */
              },
              N: 'STRING_VALUE',
              NS: [
                'STRING_VALUE',
                /* more items */
              ],
              NULL: true || false,
              S: 'STRING_VALUE',
              SS: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* '<AttributeName>': ... */
          }
        },
        PutRequest: {
          Item: { /* required */
            '<AttributeName>': { /* AttributeValue */
              B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BOOL: true || false,
              BS: [
                Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                /* more items */
              ],
              L: [
                /* recursive AttributeValue */,
                /* more items */
              ],
              M: {
                '<AttributeName>': /* recursive AttributeValue */,
                /* '<AttributeName>': ... */
              },
              N: 'STRING_VALUE',
              NS: [
                'STRING_VALUE',
                /* more items */
              ],
              NULL: true || false,
              S: 'STRING_VALUE',
              SS: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* '<AttributeName>': ... */
          }
        }
      },
      /* more items */
    ],
    /* '<TableArn>': ... */
  },
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE,
  ReturnItemCollectionMetrics: SIZE | NONE
};
dynamodb.batchWriteItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RequestItems — (map<Array<map>>)

    A map of one or more table names or table ARNs and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

    • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

      • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

    • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

      • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with a ValidationException exception.

        If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

    • PutRequest — (map)

      A request to perform a PutItem operation.

      • Item — required — (map<map>)

        A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

    • DeleteRequest — (map)

      A request to perform a DeleteItem operation.

      • Key — required — (map<map>)

        A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

  • ReturnConsumedCapacity — (String)

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

    Possible values include:
    • "INDEXES"
    • "TOTAL"
    • "NONE"
  • ReturnItemCollectionMetrics — (String)

    Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

    Possible values include:
    • "SIZE"
    • "NONE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UnprocessedItems — (map<Array<map>>)

      A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchWriteItem operation. For more information, see RequestItems in the Request Parameters section.

      Each UnprocessedItems entry consists of a table name or table ARN and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

      • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

        • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

      • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

        • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

          If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

      If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

      • PutRequest — (map)

        A request to perform a PutItem operation.

        • Item — required — (map<map>)

          A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

      • DeleteRequest — (map)

        A request to perform a DeleteItem operation.

        • Key — required — (map<map>)

          A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

    • ItemCollectionMetrics — (map<Array<map>>)

      A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

      Each entry consists of the following subelements:

      • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

      • SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

        The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

      • ItemCollectionKey — (map<map>)

        The partition key value of the item collection. This value is the same as the partition key value of the item.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • SizeEstimateRangeGB — (Array<Float>)

        An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

        The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

    • ConsumedCapacity — (Array<map>)

      The capacity units consumed by the entire BatchWriteItem operation.

      Each element consists of:

      • TableName - The table that consumed the provisioned throughput.

      • CapacityUnits - The total number of capacity units consumed.

      • TableName — (String)

        The name of the table that was affected by the operation. If you had specified the Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.

      • CapacityUnits — (Float)

        The total number of capacity units consumed by the operation.

      • ReadCapacityUnits — (Float)

        The total number of read capacity units consumed by the operation.

      • WriteCapacityUnits — (Float)

        The total number of write capacity units consumed by the operation.

      • Table — (map)

        The amount of throughput consumed on the table affected by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed on a table or an index.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed on a table or an index.

        • CapacityUnits — (Float)

          The total number of capacity units consumed on a table or an index.

      • LocalSecondaryIndexes — (map<map>)

        The amount of throughput consumed on each local index affected by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed on a table or an index.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed on a table or an index.

        • CapacityUnits — (Float)

          The total number of capacity units consumed on a table or an index.

      • GlobalSecondaryIndexes — (map<map>)

        The amount of throughput consumed on each global index affected by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed on a table or an index.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed on a table or an index.

        • CapacityUnits — (Float)

          The total number of capacity units consumed on a table or an index.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BackupName: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.createBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TableName — (String)

    The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • BackupName — (String)

    Specified name for the backup.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • BackupDetails — (map)

      Contains the details of the backup created for the table.

      • BackupArn — required — (String)

        ARN associated with the backup.

      • BackupName — required — (String)

        Name of the requested backup.

      • BackupSizeBytes — (Integer)

        Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      • BackupStatus — required — (String)

        Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

        Possible values include:
        • "CREATING"
        • "DELETED"
        • "AVAILABLE"
      • BackupType — required — (String)

        BackupType:

        • USER - You create and manage these using the on-demand backup feature.

        • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

        • AWS_BACKUP - On-demand backup created by you from Backup service.

        Possible values include:
        • "USER"
        • "SYSTEM"
        • "AWS_BACKUP"
      • BackupCreationDateTime — required — (Date)

        Time at which the backup was created. This is the request time of the backup.

      • BackupExpiryDateTime — (Date)

        Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GlobalTableName: 'STRING_VALUE', /* required */
  ReplicationGroup: [ /* required */
    {
      RegionName: 'STRING_VALUE'
    },
    /* more items */
  ]
};
dynamodb.createGlobalTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GlobalTableName — (String)

    The global table name.

  • ReplicationGroup — (Array<map>)

    The Regions where the global table needs to be created.

    • RegionName — (String)

      The Region where the replica needs to be created.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GlobalTableDescription — (map)

      Contains the details of the global table.

      • ReplicationGroup — (Array<map>)

        The Regions where the global table has replicas.

        • RegionName — (String)

          The name of the Region.

        • ReplicaStatus — (String)

          The current state of the replica:

          • CREATING - The replica is being created.

          • UPDATING - The replica is being updated.

          • DELETING - The replica is being deleted.

          • ACTIVE - The replica is ready for use.

          • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

            Note: If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

          • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

            Note: If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
          Possible values include:
          • "CREATING"
          • "CREATION_FAILED"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
          • "REGION_DISABLED"
          • "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
        • ReplicaStatusDescription — (String)

          Detailed information about the replica status.

        • ReplicaStatusPercentProgress — (String)

          Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

        • KMSMasterKeyId — (String)

          The KMS key of the replica that will be used for KMS encryption.

        • ProvisionedThroughputOverride — (map)

          Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

          • ReadCapacityUnits — (Integer)

            Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.

        • OnDemandThroughputOverride — (map)

          Overrides the maximum on-demand throughput settings for the specified replica table.

          • MaxReadRequestUnits — (Integer)

            Maximum number of read request units for the specified replica table.

        • GlobalSecondaryIndexes — (Array<map>)

          Replica-specific global secondary index settings.

          • IndexName — (String)

            The name of the global secondary index.

          • ProvisionedThroughputOverride — (map)

            If not described, uses the source table GSI's read capacity settings.

            • ReadCapacityUnits — (Integer)

              Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.

          • OnDemandThroughputOverride — (map)

            Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.

            • MaxReadRequestUnits — (Integer)

              Maximum number of read request units for the specified replica table.

        • ReplicaInaccessibleDateTime — (Date)

          The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

        • ReplicaTableClassSummary — (map)

          Contains details of the table class.

          • TableClass — (String)

            The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

            Possible values include:
            • "STANDARD"
            • "STANDARD_INFREQUENT_ACCESS"
          • LastUpdateDateTime — (Date)

            The date and time at which the table class was last updated.

      • GlobalTableArn — (String)

        The unique identifier of the global table.

      • CreationDateTime — (Date)

        The creation time of the global table.

      • GlobalTableStatus — (String)

        The current state of the global table:

        • CREATING - The global table is being created.

        • UPDATING - The global table is being updated.

        • DELETING - The global table is being deleted.

        • ACTIVE - The global table is ready for use.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
      • GlobalTableName — (String)

        The global table name.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example creates a table named Music. */

 var params = {
  AttributeDefinitions: [
     {
    AttributeName: "Artist", 
    AttributeType: "S"
   }, 
     {
    AttributeName: "SongTitle", 
    AttributeType: "S"
   }
  ], 
  KeySchema: [
     {
    AttributeName: "Artist", 
    KeyType: "HASH"
   }, 
     {
    AttributeName: "SongTitle", 
    KeyType: "RANGE"
   }
  ], 
  ProvisionedThroughput: {
   ReadCapacityUnits: 5, 
   WriteCapacityUnits: 5
  }, 
  TableName: "Music"
 };
 dynamodb.createTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TableDescription: {
     AttributeDefinitions: [
        {
       AttributeName: "Artist", 
       AttributeType: "S"
      }, 
        {
       AttributeName: "SongTitle", 
       AttributeType: "S"
      }
     ], 
     CreationDateTime: <Date Representation>, 
     ItemCount: 0, 
     KeySchema: [
        {
       AttributeName: "Artist", 
       KeyType: "HASH"
      }, 
        {
       AttributeName: "SongTitle", 
       KeyType: "RANGE"
      }
     ], 
     ProvisionedThroughput: {
      ReadCapacityUnits: 5, 
      WriteCapacityUnits: 5
     }, 
     TableName: "Music", 
     TableSizeBytes: 0, 
     TableStatus: "CREATING"
    }
   }
   */
 });

var params = {
  AttributeDefinitions: [ /* required */
    {
      AttributeName: 'STRING_VALUE', /* required */
      AttributeType: S | N | B /* required */
    },
    /* more items */
  ],
  KeySchema: [ /* required */
    {
      AttributeName: 'STRING_VALUE', /* required */
      KeyType: HASH | RANGE /* required */
    },
    /* more items */
  ],
  TableName: 'STRING_VALUE', /* required */
  BillingMode: PROVISIONED | PAY_PER_REQUEST,
  DeletionProtectionEnabled: true || false,
  GlobalSecondaryIndexes: [
    {
      IndexName: 'STRING_VALUE', /* required */
      KeySchema: [ /* required */
        {
          AttributeName: 'STRING_VALUE', /* required */
          KeyType: HASH | RANGE /* required */
        },
        /* more items */
      ],
      Projection: { /* required */
        NonKeyAttributes: [
          'STRING_VALUE',
          /* more items */
        ],
        ProjectionType: ALL | KEYS_ONLY | INCLUDE
      },
      OnDemandThroughput: {
        MaxReadRequestUnits: 'NUMBER_VALUE',
        MaxWriteRequestUnits: 'NUMBER_VALUE'
      },
      ProvisionedThroughput: {
        ReadCapacityUnits: 'NUMBER_VALUE', /* required */
        WriteCapacityUnits: 'NUMBER_VALUE' /* required */
      }
    },
    /* more items */
  ],
  LocalSecondaryIndexes: [
    {
      IndexName: 'STRING_VALUE', /* required */
      KeySchema: [ /* required */
        {
          AttributeName: 'STRING_VALUE', /* required */
          KeyType: HASH | RANGE /* required */
        },
        /* more items */
      ],
      Projection: { /* required */
        NonKeyAttributes: [
          'STRING_VALUE',
          /* more items */
        ],
        ProjectionType: ALL | KEYS_ONLY | INCLUDE
      }
    },
    /* more items */
  ],
  OnDemandThroughput: {
    MaxReadRequestUnits: 'NUMBER_VALUE',
    MaxWriteRequestUnits: 'NUMBER_VALUE'
  },
  ProvisionedThroughput: {
    ReadCapacityUnits: 'NUMBER_VALUE', /* required */
    WriteCapacityUnits: 'NUMBER_VALUE' /* required */
  },
  ResourcePolicy: 'STRING_VALUE',
  SSESpecification: {
    Enabled: true || false,
    KMSMasterKeyId: 'STRING_VALUE',
    SSEType: AES256 | KMS
  },
  StreamSpecification: {
    StreamEnabled: true || false, /* required */
    StreamViewType: NEW_IMAGE | OLD_IMAGE | NEW_AND_OLD_IMAGES | KEYS_ONLY
  },
  TableClass: STANDARD | STANDARD_INFREQUENT_ACCESS,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
dynamodb.createTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AttributeDefinitions — (Array<map>)

    An array of attributes that describe the key schema for the table and indexes.

    • AttributeName — required — (String)

      A name for the attribute.

    • AttributeType — required — (String)

      The data type for the attribute, where:

      • S - the attribute is of type String

      • N - the attribute is of type Number

      • B - the attribute is of type Binary

      Possible values include:
      • "S"
      • "N"
      • "B"
  • TableName — (String)

    The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

  • KeySchema — (Array<map>)

    Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

    Each KeySchemaElement in the array is composed of:

    • AttributeName - The name of this key attribute.

    • KeyType - The role that the key attribute will assume:

      • HASH - partition key

      • RANGE - sort key

    Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

    For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

    For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

    For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

    • AttributeName — required — (String)

      The name of a key attribute.

    • KeyType — required — (String)

      The role that this key attribute will assume:

      • HASH - partition key

      • RANGE - sort key

      Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
      Possible values include:
      • "HASH"
      • "RANGE"
  • LocalSecondaryIndexes — (Array<map>)

    One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

    Each local secondary index in the array includes the following:

    • IndexName - The name of the local secondary index. Must be unique only for this table.

    • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

    • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

      • ProjectionType - One of the following:

        • KEYS_ONLY - Only the index and primary keys are projected into the index.

        • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

        • ALL - All of the table attributes are projected into the index.

      • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

    • IndexName — required — (String)

      The name of the local secondary index. The name must be unique among all other indexes on this table.

    • KeySchema — required — (Array<map>)

      The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

      • HASH - partition key

      • RANGE - sort key

      Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
      • AttributeName — required — (String)

        The name of a key attribute.

      • KeyType — required — (String)

        The role that this key attribute will assume:

        • HASH - partition key

        • RANGE - sort key

        Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
        Possible values include:
        • "HASH"
        • "RANGE"
    • Projection — required — (map)

      Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

      • ProjectionType — (String)

        The set of attributes that are projected into the index:

        • KEYS_ONLY - Only the index and primary keys are projected into the index.

        • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

        • ALL - All of the table attributes are projected into the index.

        When using the DynamoDB console, ALL is selected by default.

        Possible values include:
        • "ALL"
        • "KEYS_ONLY"
        • "INCLUDE"
      • NonKeyAttributes — (Array<String>)

        Represents the non-key attribute names which will be projected into the index.

        For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • GlobalSecondaryIndexes — (Array<map>)

    One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

    • IndexName - The name of the global secondary index. Must be unique only for this table.

    • KeySchema - Specifies the key schema for the global secondary index.

    • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

      • ProjectionType - One of the following:

        • KEYS_ONLY - Only the index and primary keys are projected into the index.

        • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

        • ALL - All of the table attributes are projected into the index.

      • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

    • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

    • IndexName — required — (String)

      The name of the global secondary index. The name must be unique among all other indexes on this table.

    • KeySchema — required — (Array<map>)

      The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

      • HASH - partition key

      • RANGE - sort key

      Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
      • AttributeName — required — (String)

        The name of a key attribute.

      • KeyType — required — (String)

        The role that this key attribute will assume:

        • HASH - partition key

        • RANGE - sort key

        Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
        Possible values include:
        • "HASH"
        • "RANGE"
    • Projection — required — (map)

      Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

      • ProjectionType — (String)

        The set of attributes that are projected into the index:

        • KEYS_ONLY - Only the index and primary keys are projected into the index.

        • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

        • ALL - All of the table attributes are projected into the index.

        When using the DynamoDB console, ALL is selected by default.

        Possible values include:
        • "ALL"
        • "KEYS_ONLY"
        • "INCLUDE"
      • NonKeyAttributes — (Array<String>)

        Represents the non-key attribute names which will be projected into the index.

        For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

    • ProvisionedThroughput — (map)

      Represents the provisioned throughput settings for the specified global secondary index.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

      • ReadCapacityUnits — required — (Integer)

        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

      • WriteCapacityUnits — required — (Integer)

        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

    • OnDemandThroughput — (map)

      The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

      • MaxReadRequestUnits — (Integer)

        Maximum number of read request units for the specified table.

        To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

      • MaxWriteRequestUnits — (Integer)

        Maximum number of write request units for the specified table.

        To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

  • BillingMode — (String)

    Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

    • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

    • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

    Possible values include:
    • "PROVISIONED"
    • "PAY_PER_REQUEST"
  • ProvisionedThroughput — (map)

    Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

    If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

    For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

    • ReadCapacityUnits — required — (Integer)

      The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

      If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

    • WriteCapacityUnits — required — (Integer)

      The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

      If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

  • StreamSpecification — (map)

    The settings for DynamoDB Streams on the table. These settings consist of:

    • StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).

    • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

      • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

      • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

      • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

      • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

    • StreamEnabled — required — (Boolean)

      Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

    • StreamViewType — (String)

      When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

      • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

      • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

      • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

      • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

      Possible values include:
      • "NEW_IMAGE"
      • "OLD_IMAGE"
      • "NEW_AND_OLD_IMAGES"
      • "KEYS_ONLY"
  • SSESpecification — (map)

    Represents the settings used to enable server-side encryption.

    • Enabled — (Boolean)

      Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.

    • SSEType — (String)

      Server-side encryption type. The only supported value is:

      • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

      Possible values include:
      • "AES256"
      • "KMS"
    • KMSMasterKeyId — (String)

      The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.

  • Tags — (Array<map>)

    A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

    • Key — required — (String)

      The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

    • Value — required — (String)

      The value of the tag. Tag values are case-sensitive and can be null.

  • TableClass — (String)

    The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

    Possible values include:
    • "STANDARD"
    • "STANDARD_INFREQUENT_ACCESS"
  • DeletionProtectionEnabled — (Boolean)

    Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

  • ResourcePolicy — (String)

    An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

    When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

    The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

    Note: You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.
  • OnDemandThroughput — (map)

    Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

    • MaxReadRequestUnits — (Integer)

      Maximum number of read request units for the specified table.

      To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

    • MaxWriteRequestUnits — (Integer)

      Maximum number of write request units for the specified table.

      To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TableDescription — (map)

      Represents the properties of the table.

      • AttributeDefinitions — (Array<map>)

        An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

        Each AttributeDefinition object in this array is composed of:

        • AttributeName - The name of the attribute.

        • AttributeType - The data type for the attribute.

        • AttributeName — required — (String)

          A name for the attribute.

        • AttributeType — required — (String)

          The data type for the attribute, where:

          • S - the attribute is of type String

          • N - the attribute is of type Number

          • B - the attribute is of type Binary

          Possible values include:
          • "S"
          • "N"
          • "B"
      • TableName — (String)

        The name of the table.

      • KeySchema — (Array<map>)

        The primary key structure for the table. Each KeySchemaElement consists of:

        • AttributeName - The name of the attribute.

        • KeyType - The role of the attribute:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

        For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

        • AttributeName — required — (String)

          The name of a key attribute.

        • KeyType — required — (String)

          The role that this key attribute will assume:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
          Possible values include:
          • "HASH"
          • "RANGE"
      • TableStatus — (String)

        The current state of the table:

        • CREATING - The table is being created.

        • UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING.

        • DELETING - The table is being deleted.

        • ACTIVE - The table is ready for use.

        • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days.

        • ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.

        • ARCHIVED - The table has been archived. See the ArchivalReason for more information.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
        • "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
        • "ARCHIVING"
        • "ARCHIVED"
      • CreationDateTime — (Date)

        The date and time when the table was created, in UNIX epoch time format.

      • ProvisionedThroughput — (map)

        The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

        • LastIncreaseDateTime — (Date)

          The date and time of the last provisioned throughput increase for this table.

        • LastDecreaseDateTime — (Date)

          The date and time of the last provisioned throughput decrease for this table.

        • NumberOfDecreasesToday — (Integer)

          The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

        • ReadCapacityUnits — (Integer)

          The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

        • WriteCapacityUnits — (Integer)

          The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

      • TableSizeBytes — (Integer)

        The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      • ItemCount — (Integer)

        The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      • TableArn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies the table.

      • TableId — (String)

        Unique identifier for the table for which the backup was created.

      • BillingModeSummary — (map)

        Contains the details for the read/write capacity mode.

        • BillingMode — (String)

          Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

          • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

          • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

          Possible values include:
          • "PROVISIONED"
          • "PAY_PER_REQUEST"
        • LastUpdateToPayPerRequestDateTime — (Date)

          Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

      • LocalSecondaryIndexes — (Array<map>)

        Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

        • IndexName - The name of the local secondary index.

        • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

        • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

          • ProjectionType - One of the following:

            • KEYS_ONLY - Only the index and primary keys are projected into the index.

            • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

            • ALL - All of the table attributes are projected into the index.

          • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        If the table is in the DELETING state, no information about indexes will be returned.

        • IndexName — (String)

          Represents the name of the local secondary index.

        • KeySchema — (Array<map>)

          The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • Projection — (map)

          Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

          • ProjectionType — (String)

            The set of attributes that are projected into the index:

            • KEYS_ONLY - Only the index and primary keys are projected into the index.

            • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

            • ALL - All of the table attributes are projected into the index.

            When using the DynamoDB console, ALL is selected by default.

            Possible values include:
            • "ALL"
            • "KEYS_ONLY"
            • "INCLUDE"
          • NonKeyAttributes — (Array<String>)

            Represents the non-key attribute names which will be projected into the index.

            For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • IndexSizeBytes — (Integer)

          The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • IndexArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the index.

      • GlobalSecondaryIndexes — (Array<map>)

        The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

        • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (This attribute does not appear for indexes that were created during a CreateTable operation.)

        • IndexName - The name of the global secondary index.

        • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • IndexStatus - The current status of the global secondary index:

          • CREATING - The index is being created.

          • UPDATING - The index is being updated.

          • DELETING - The index is being deleted.

          • ACTIVE - The index is ready for use.

        • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

        • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

          • ProjectionType - One of the following:

            • KEYS_ONLY - Only the index and primary keys are projected into the index.

            • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

            • ALL - All of the table attributes are projected into the index.

          • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

        If the table is in the DELETING state, no information about indexes will be returned.

        • IndexName — (String)

          The name of the global secondary index.

        • KeySchema — (Array<map>)

          The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • Projection — (map)

          Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

          • ProjectionType — (String)

            The set of attributes that are projected into the index:

            • KEYS_ONLY - Only the index and primary keys are projected into the index.

            • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

            • ALL - All of the table attributes are projected into the index.

            When using the DynamoDB console, ALL is selected by default.

            Possible values include:
            • "ALL"
            • "KEYS_ONLY"
            • "INCLUDE"
          • NonKeyAttributes — (Array<String>)

            Represents the non-key attribute names which will be projected into the index.

            For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • IndexStatus — (String)

          The current state of the global secondary index:

          • CREATING - The index is being created.

          • UPDATING - The index is being updated.

          • DELETING - The index is being deleted.

          • ACTIVE - The index is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • Backfilling — (Boolean)

          Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

          You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false.

          Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
        • ProvisionedThroughput — (map)

          Represents the provisioned throughput settings for the specified global secondary index.

          For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • IndexSizeBytes — (Integer)

          The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • IndexArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the index.

        • OnDemandThroughput — (map)

          The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

          • MaxReadRequestUnits — (Integer)

            Maximum number of read request units for the specified table.

            To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

          • MaxWriteRequestUnits — (Integer)

            Maximum number of write request units for the specified table.

            To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

      • StreamSpecification — (map)

        The current DynamoDB Streams configuration for the table.

        • StreamEnabled — required — (Boolean)

          Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

        • StreamViewType — (String)

          When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

          • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

          • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

          • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

          • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

          Possible values include:
          • "NEW_IMAGE"
          • "OLD_IMAGE"
          • "NEW_AND_OLD_IMAGES"
          • "KEYS_ONLY"
      • LatestStreamLabel — (String)

        A timestamp, in ISO 8601 format, for this stream.

        Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

        • Amazon Web Services customer ID

        • Table name

        • StreamLabel

      • LatestStreamArn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

      • GlobalTableVersion — (String)

        Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.

      • Replicas — (Array<map>)

        Represents replicas of the table.

        • RegionName — (String)

          The name of the Region.

        • ReplicaStatus — (String)

          The current state of the replica:

          • CREATING - The replica is being created.

          • UPDATING - The replica is being updated.

          • DELETING - The replica is being deleted.

          • ACTIVE - The replica is ready for use.

          • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

            Note: If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

          • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

            Note: If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
          Possible values include:
          • "CREATING"
          • "CREATION_FAILED"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
          • "REGION_DISABLED"
          • "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
        • ReplicaStatusDescription — (String)

          Detailed information about the replica status.

        • ReplicaStatusPercentProgress — (String)

          Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

        • KMSMasterKeyId — (String)

          The KMS key of the replica that will be used for KMS encryption.

        • ProvisionedThroughputOverride — (map)

          Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

          • ReadCapacityUnits — (Integer)

            Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.

        • OnDemandThroughputOverride — (map)

          Overrides the maximum on-demand throughput settings for the specified replica table.

          • MaxReadRequestUnits — (Integer)

            Maximum number of read request units for the specified replica table.

        • GlobalSecondaryIndexes — (Array<map>)

          Replica-specific global secondary index settings.

          • IndexName — (String)

            The name of the global secondary index.

          • ProvisionedThroughputOverride — (map)

            If not described, uses the source table GSI's read capacity settings.

            • ReadCapacityUnits — (Integer)

              Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.

          • OnDemandThroughputOverride — (map)

            Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.

            • MaxReadRequestUnits — (Integer)

              Maximum number of read request units for the specified replica table.

        • ReplicaInaccessibleDateTime — (Date)

          The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

        • ReplicaTableClassSummary — (map)

          Contains details of the table class.

          • TableClass — (String)

            The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

            Possible values include:
            • "STANDARD"
            • "STANDARD_INFREQUENT_ACCESS"
          • LastUpdateDateTime — (Date)

            The date and time at which the table class was last updated.

      • RestoreSummary — (map)

        Contains details for the restore.

        • SourceBackupArn — (String)

          The Amazon Resource Name (ARN) of the backup from which the table was restored.

        • SourceTableArn — (String)

          The ARN of the source table of the backup that is being restored.

        • RestoreDateTime — required — (Date)

          Point in time or source backup time.

        • RestoreInProgress — required — (Boolean)

          Indicates if a restore is in progress or not.

      • SSEDescription — (map)

        The description of the server-side encryption status on the specified table.

        • Status — (String)

          Represents the current state of server-side encryption. The only supported values are:

          • ENABLED - Server-side encryption is enabled.

          • UPDATING - Server-side encryption is being updated.

          Possible values include:
          • "ENABLING"
          • "ENABLED"
          • "DISABLING"
          • "DISABLED"
          • "UPDATING"
        • SSEType — (String)

          Server-side encryption type. The only supported value is:

          • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

          Possible values include:
          • "AES256"
          • "KMS"
        • KMSMasterKeyArn — (String)

          The KMS key ARN used for the KMS encryption.

        • InaccessibleEncryptionDateTime — (Date)

          Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

      • ArchivalSummary — (map)

        Contains information about the table archive.

        • ArchivalDateTime — (Date)

          The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.

        • ArchivalReason — (String)

          The reason DynamoDB archived the table. Currently, the only possible value is:

          • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.

        • ArchivalBackupArn — (String)

          The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.

      • TableClassSummary — (map)

        Contains details of the table class.

        • TableClass — (String)

          The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

          Possible values include:
          • "STANDARD"
          • "STANDARD_INFREQUENT_ACCESS"
        • LastUpdateDateTime — (Date)

          The date and time at which the table class was last updated.

      • DeletionProtectionEnabled — (Boolean)

        Indicates whether deletion protection is enabled (true) or disabled (false) on the table.

      • OnDemandThroughput — (map)

        The maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

        • MaxReadRequestUnits — (Integer)

          Maximum number of read request units for the specified table.

          To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

        • MaxWriteRequestUnits — (Integer)

          Maximum number of write request units for the specified table.

          To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BackupArn: 'STRING_VALUE' /* required */
};
dynamodb.deleteBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • BackupArn — (String)

    The ARN associated with the backup.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • BackupDescription — (map)

      Contains the description of the backup created for the table.

      • BackupDetails — (map)

        Contains the details of the backup created for the table.

        • BackupArn — required — (String)

          ARN associated with the backup.

        • BackupName — required — (String)

          Name of the requested backup.

        • BackupSizeBytes — (Integer)

          Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • BackupStatus — required — (String)

          Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

          Possible values include:
          • "CREATING"
          • "DELETED"
          • "AVAILABLE"
        • BackupType — required — (String)

          BackupType:

          • USER - You create and manage these using the on-demand backup feature.

          • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

          • AWS_BACKUP - On-demand backup created by you from Backup service.

          Possible values include:
          • "USER"
          • "SYSTEM"
          • "AWS_BACKUP"
        • BackupCreationDateTime — required — (Date)

          Time at which the backup was created. This is the request time of the backup.

        • BackupExpiryDateTime — (Date)

          Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

      • SourceTableDetails — (map)

        Contains the details of the table when the backup was created.

        • TableName — required — (String)

          The name of the table for which the backup was created.

        • TableId — required — (String)

          Unique identifier for the table for which the backup was created.

        • TableArn — (String)

          ARN of the table for which backup was created.

        • TableSizeBytes — (Integer)

          Size of the table in bytes. Note that this is an approximate value.

        • KeySchema — required — (Array<map>)

          Schema of the table.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableCreationDateTime — required — (Date)

          Time when the source table was created.

        • ProvisionedThroughput — required — (map)

          Read IOPs and Write IOPS on the table when the backup was created.

          • ReadCapacityUnits — required — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

            If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • WriteCapacityUnits — required — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

            If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

        • OnDemandThroughput — (map)

          Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

          • MaxReadRequestUnits — (Integer)

            Maximum number of read request units for the specified table.

            To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

          • MaxWriteRequestUnits — (Integer)

            Maximum number of write request units for the specified table.

            To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

        • ItemCount — (Integer)

          Number of items in the table. Note that this is an approximate value.

        • BillingMode — (String)

          Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

          • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

          • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

          Possible values include:
          • "PROVISIONED"
          • "PAY_PER_REQUEST"
      • SourceTableFeatureDetails — (map)

        Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

        • LocalSecondaryIndexes — (Array<map>)

          Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

              • ALL - All of the table attributes are projected into the index.

              When using the DynamoDB console, ALL is selected by default.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • GlobalSecondaryIndexes — (Array<map>)

          Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the table at the time of backup.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

              • ALL - All of the table attributes are projected into the index.

              When using the DynamoDB console, ALL is selected by default.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            • ReadCapacityUnits — required — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

              If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

            • WriteCapacityUnits — required — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

              If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • OnDemandThroughput — (map)

            Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

            • MaxReadRequestUnits — (Integer)

              Maximum number of read request units for the specified table.

              To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

            • MaxWriteRequestUnits — (Integer)

              Maximum number of write request units for the specified table.

              To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

        • StreamDescription — (map)

          Stream settings on the table when the backup was created.

          • StreamEnabled — required — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • TimeToLiveDescription — (map)

          Time to Live settings on the table when the backup was created.

          • TimeToLiveStatus — (String)

            The TTL status for the table.

            Possible values include:
            • "ENABLING"
            • "DISABLING"
            • "ENABLED"
            • "DISABLED"
          • AttributeName — (String)

            The name of the TTL attribute for items in the table.

        • SSEDescription — (map)

          The description of the server-side encryption status on the table when the backup was created.

          • Status — (String)

            Represents the current state of server-side encryption. The only supported values are:

            • ENABLED - Server-side encryption is enabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type. The only supported value is:

            • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS key ARN used for the KMS encryption.

          • InaccessibleEncryptionDateTime — (Date)

            Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes an item from the Music table. */

 var params = {
  Key: {
   "Artist": {
     S: "No One You Know"
    }, 
   "SongTitle": {
     S: "Scared of My Shadow"
    }
  }, 
  TableName: "Music"
 };
 dynamodb.deleteItem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ConsumedCapacity: {
     CapacityUnits: 1, 
     TableName: "Music"
    }
   }
   */
 });

var params = {
  Key: { /* required */
    '<AttributeName>': { /* AttributeValue */
      B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  TableName: 'STRING_VALUE', /* required */
  ConditionExpression: 'STRING_VALUE',
  ConditionalOperator: AND | OR,
  Expected: {
    '<AttributeName>': {
      AttributeValueList: [
        { /* AttributeValue */
          B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BOOL: true || false,
          BS: [
            Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            '<AttributeName>': /* recursive AttributeValue */,
            /* '<AttributeName>': ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          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: { /* AttributeValue */
        B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        BOOL: true || false,
        BS: [
          Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          /* more items */
        ],
        L: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        M: {
          '<AttributeName>': /* recursive AttributeValue */,
          /* '<AttributeName>': ... */
        },
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        NULL: true || false,
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* '<AttributeName>': ... */
  },
  ExpressionAttributeNames: {
    '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
    /* '<ExpressionAttributeNameVariable>': ... */
  },
  ExpressionAttributeValues: {
    '<ExpressionAttributeValueVariable>': { /* AttributeValue */
      B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<ExpressionAttributeValueVariable>': ... */
  },
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE,
  ReturnItemCollectionMetrics: SIZE | NONE,
  ReturnValues: NONE | ALL_OLD | UPDATED_OLD | ALL_NEW | UPDATED_NEW,
  ReturnValuesOnConditionCheckFailure: ALL_OLD | NONE
};
dynamodb.deleteItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TableName — (String)

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

  • Key — (map<map>)

    A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

    For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

    • S — (String)

      An attribute of type String. For example:

      "S": "Hello"

    • N — (String)

      An attribute of type Number. For example:

      "N": "123.45"

      Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

    • B — (Buffer, Typed Array, Blob, String)

      An attribute of type Binary. For example:

      "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

    • SS — (Array<String>)

      An attribute of type String Set. For example:

      "SS": ["Giraffe", "Hippo" ,"Zebra"]

    • NS — (Array<String>)

      An attribute of type Number Set. For example:

      "NS": ["42.2", "-19", "7.5", "3.14"]

      Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

    • BS — (Array<Buffer, Typed Array, Blob, String>)

      An attribute of type Binary Set. For example:

      "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

    • M — (map<map>)

      An attribute of type Map. For example:

      "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

    • L — (Array<map>)

      An attribute of type List. For example:

      "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

    • NULL — (Boolean)

      An attribute of type Null. For example:

      "NULL": true

    • BOOL — (Boolean)

      An attribute of type Boolean. For example:

      "BOOL": true

  • Expected — (map<map>)

    This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

    • Value — (map)

      Represents the data for the expected attribute.

      Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

      For more information, see Data Types in the Amazon DynamoDB Developer Guide.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • Exists — (Boolean)

      Causes DynamoDB to evaluate the value before attempting a conditional operation:

      • If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException.

      • If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException.

      The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

      DynamoDB returns a ValidationException if:

      • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

      • Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

    • ComparisonOperator — (String)

      A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

      The following comparison operators are available:

      EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

      The following are descriptions of each comparison operator.

      • EQ : Equal. EQ is supported for all data types, including lists and maps.

        AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

      • NE : Not equal. NE is supported for all data types, including lists and maps.

        AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

      • LE : Less than or equal.

        AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

      • LT : Less than.

        AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

      • GE : Greater than or equal.

        AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

      • GT : Greater than.

        AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

      • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

        Note: This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

      • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

        Note: This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

      • CONTAINS : Checks for a subsequence, or value in a set.

        AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

        CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

      • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

        AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

        NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

      • BEGINS_WITH : Checks for a prefix.

        AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

      • IN : Checks for matching elements in a list.

        AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

      • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

        AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

      Possible values include:
      • "EQ"
      • "NE"
      • "IN"
      • "LE"
      • "LT"
      • "GE"
      • "GT"
      • "BETWEEN"
      • "NOT_NULL"
      • "NULL"
      • "CONTAINS"
      • "NOT_CONTAINS"
      • "BEGINS_WITH"
    • AttributeValueList — (Array<map>)

      One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

      For type Number, value comparisons are numeric.

      String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

      For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

      For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

  • ConditionalOperator — (String)

    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

    Possible values include:
    • "AND"
    • "OR"
  • ReturnValues — (String)

    Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

    • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

    • ALL_OLD - The content of the old item is returned.

    There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

    Note: The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.
    Possible values include:
    • "NONE"
    • "ALL_OLD"
    • "UPDATED_OLD"
    • "ALL_NEW"
    • "UPDATED_NEW"
  • ReturnConsumedCapacity — (String)

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

    Possible values include:
    • "INDEXES"
    • "TOTAL"
    • "NONE"
  • ReturnItemCollectionMetrics — (String)

    Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

    Possible values include:
    • "SIZE"
    • "NONE"
  • ConditionExpression — (String)

    A condition that must be satisfied in order for a conditional DeleteItem to succeed.

    An expression can contain any of the following:

    • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

      These function names are case-sensitive.

    • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

    • Logical operators: AND | OR | NOT

    For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

  • ExpressionAttributeNames — (map<String>)

    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • Percentile

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

    • {"#P":"Percentile"}

    You could then use this substitution in an expression, as in this example:

    • #P = :val

    Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

  • ExpressionAttributeValues — (map<map>)

    One or more values that can be substituted in an expression.

    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

    Available | Backordered | Discontinued

    You would first need to specify ExpressionAttributeValues as follows:

    { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

    You could then use these values in an expression, such as this:

    ProductStatus IN (:avail, :back, :disc)

    For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

    • S — (String)

      An attribute of type String. For example:

      "S": "Hello"

    • N — (String)

      An attribute of type Number. For example:

      "N": "123.45"

      Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

    • B — (Buffer, Typed Array, Blob, String)

      An attribute of type Binary. For example:

      "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

    • SS — (Array<String>)

      An attribute of type String Set. For example:

      "SS": ["Giraffe", "Hippo" ,"Zebra"]

    • NS — (Array<String>)

      An attribute of type Number Set. For example:

      "NS": ["42.2", "-19", "7.5", "3.14"]

      Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

    • BS — (Array<Buffer, Typed Array, Blob, String>)

      An attribute of type Binary Set. For example:

      "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

    • M — (map<map>)

      An attribute of type Map. For example:

      "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

    • L — (Array<map>)

      An attribute of type List. For example:

      "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

    • NULL — (Boolean)

      An attribute of type Null. For example:

      "NULL": true

    • BOOL — (Boolean)

      An attribute of type Boolean. For example:

      "BOOL": true

  • ReturnValuesOnConditionCheckFailure — (String)

    An optional parameter that returns the item attributes for a DeleteItem operation that failed a condition check.

    There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

    Possible values include:
    • "ALL_OLD"
    • "NONE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Attributes — (map<map>)

      A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • ConsumedCapacity — (map)

      The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide.

      • TableName — (String)

        The name of the table that was affected by the operation. If you had specified the Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.

      • CapacityUnits — (Float)

        The total number of capacity units consumed by the operation.

      • ReadCapacityUnits — (Float)

        The total number of read capacity units consumed by the operation.

      • WriteCapacityUnits — (Float)

        The total number of write capacity units consumed by the operation.

      • Table — (map)

        The amount of throughput consumed on the table affected by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed on a table or an index.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed on a table or an index.

        • CapacityUnits — (Float)

          The total number of capacity units consumed on a table or an index.

      • LocalSecondaryIndexes — (map<map>)

        The amount of throughput consumed on each local index affected by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed on a table or an index.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed on a table or an index.

        • CapacityUnits — (Float)

          The total number of capacity units consumed on a table or an index.

      • GlobalSecondaryIndexes — (map<map>)

        The amount of throughput consumed on each global index affected by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed on a table or an index.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed on a table or an index.

        • CapacityUnits — (Float)

          The total number of capacity units consumed on a table or an index.

    • ItemCollectionMetrics — (map)

      Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

      Each ItemCollectionMetrics element consists of:

      • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

      • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

        The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

      • ItemCollectionKey — (map<map>)

        The partition key value of the item collection. This value is the same as the partition key value of the item.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • SizeEstimateRangeGB — (Array<Float>)

        An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

        The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  ExpectedRevisionId: 'STRING_VALUE'
};
dynamodb.deleteResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be removed. The resources you can specify include tables and streams. If you remove the policy of a table, it will also remove the permissions for the table's indexes defined in that policy document. This is because index permissions are defined in the table's policy.

  • ExpectedRevisionId — (String)

    A string value that you can use to conditionally delete your policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, the request will fail and return a PolicyNotFoundException.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RevisionId — (String)

      A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

      This value will be empty if you make a request against a resource without a policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the Music table. */

 var params = {
  TableName: "Music"
 };
 dynamodb.deleteTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TableDescription: {
     ItemCount: 0, 
     ProvisionedThroughput: {
      NumberOfDecreasesToday: 1, 
      ReadCapacityUnits: 5, 
      WriteCapacityUnits: 5
     }, 
     TableName: "Music", 
     TableSizeBytes: 0, 
     TableStatus: "DELETING"
    }
   }
   */
 });

var params = {
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.deleteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TableName — (String)

    The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TableDescription — (map)

      Represents the properties of a table.

      • AttributeDefinitions — (Array<map>)

        An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

        Each AttributeDefinition object in this array is composed of:

        • AttributeName - The name of the attribute.

        • AttributeType - The data type for the attribute.

        • AttributeName — required — (String)

          A name for the attribute.

        • AttributeType — required — (String)

          The data type for the attribute, where:

          • S - the attribute is of type String

          • N - the attribute is of type Number

          • B - the attribute is of type Binary

          Possible values include:
          • "S"
          • "N"
          • "B"
      • TableName — (String)

        The name of the table.

      • KeySchema — (Array<map>)

        The primary key structure for the table. Each KeySchemaElement consists of:

        • AttributeName - The name of the attribute.

        • KeyType - The role of the attribute:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

        For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

        • AttributeName — required — (String)

          The name of a key attribute.

        • KeyType — required — (String)

          The role that this key attribute will assume:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
          Possible values include:
          • "HASH"
          • "RANGE"
      • TableStatus — (String)

        The current state of the table:

        • CREATING - The table is being created.

        • UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING.

        • DELETING - The table is being deleted.

        • ACTIVE - The table is ready for use.

        • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days.

        • ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.

        • ARCHIVED - The table has been archived. See the ArchivalReason for more information.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
        • "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
        • "ARCHIVING"
        • "ARCHIVED"
      • CreationDateTime — (Date)

        The date and time when the table was created, in UNIX epoch time format.

      • ProvisionedThroughput — (map)

        The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

        • LastIncreaseDateTime — (Date)

          The date and time of the last provisioned throughput increase for this table.

        • LastDecreaseDateTime — (Date)

          The date and time of the last provisioned throughput decrease for this table.

        • NumberOfDecreasesToday — (Integer)

          The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

        • ReadCapacityUnits — (Integer)

          The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

        • WriteCapacityUnits — (Integer)

          The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

      • TableSizeBytes — (Integer)

        The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      • ItemCount — (Integer)

        The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      • TableArn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies the table.

      • TableId — (String)

        Unique identifier for the table for which the backup was created.

      • BillingModeSummary — (map)

        Contains the details for the read/write capacity mode.

        • BillingMode — (String)

          Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

          • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

          • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

          Possible values include:
          • "PROVISIONED"
          • "PAY_PER_REQUEST"
        • LastUpdateToPayPerRequestDateTime — (Date)

          Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

      • LocalSecondaryIndexes — (Array<map>)

        Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

        • IndexName - The name of the local secondary index.

        • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

        • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

          • ProjectionType - One of the following:

            • KEYS_ONLY - Only the index and primary keys are projected into the index.

            • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

            • ALL - All of the table attributes are projected into the index.

          • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        If the table is in the DELETING state, no information about indexes will be returned.

        • IndexName — (String)

          Represents the name of the local secondary index.

        • KeySchema — (Array<map>)

          The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • Projection — (map)

          Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

          • ProjectionType — (String)

            The set of attributes that are projected into the index:

            • KEYS_ONLY - Only the index and primary keys are projected into the index.

            • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

            • ALL - All of the table attributes are projected into the index.

            When using the DynamoDB console, ALL is selected by default.

            Possible values include:
            • "ALL"
            • "KEYS_ONLY"
            • "INCLUDE"
          • NonKeyAttributes — (Array<String>)

            Represents the non-key attribute names which will be projected into the index.

            For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • IndexSizeBytes — (Integer)

          The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • IndexArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the index.

      • GlobalSecondaryIndexes — (Array<map>)

        The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

        • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (This attribute does not appear for indexes that were created during a CreateTable operation.)

        • IndexName - The name of the global secondary index.

        • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • IndexStatus - The current status of the global secondary index:

          • CREATING - The index is being created.

          • UPDATING - The index is being updated.

          • DELETING - The index is being deleted.

          • ACTIVE - The index is ready for use.

        • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

        • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

          • ProjectionType - One of the following:

            • KEYS_ONLY - Only the index and primary keys are projected into the index.

            • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

            • ALL - All of the table attributes are projected into the index.

          • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

        If the table is in the DELETING state, no information about indexes will be returned.

        • IndexName — (String)

          The name of the global secondary index.

        • KeySchema — (Array<map>)

          The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • Projection — (map)

          Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

          • ProjectionType — (String)

            The set of attributes that are projected into the index:

            • KEYS_ONLY - Only the index and primary keys are projected into the index.

            • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

            • ALL - All of the table attributes are projected into the index.

            When using the DynamoDB console, ALL is selected by default.

            Possible values include:
            • "ALL"
            • "KEYS_ONLY"
            • "INCLUDE"
          • NonKeyAttributes — (Array<String>)

            Represents the non-key attribute names which will be projected into the index.

            For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • IndexStatus — (String)

          The current state of the global secondary index:

          • CREATING - The index is being created.

          • UPDATING - The index is being updated.

          • DELETING - The index is being deleted.

          • ACTIVE - The index is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • Backfilling — (Boolean)

          Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

          You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false.

          Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
        • ProvisionedThroughput — (map)

          Represents the provisioned throughput settings for the specified global secondary index.

          For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • IndexSizeBytes — (Integer)

          The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • IndexArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the index.

        • OnDemandThroughput — (map)

          The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

          • MaxReadRequestUnits — (Integer)

            Maximum number of read request units for the specified table.

            To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

          • MaxWriteRequestUnits — (Integer)

            Maximum number of write request units for the specified table.

            To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

      • StreamSpecification — (map)

        The current DynamoDB Streams configuration for the table.

        • StreamEnabled — required — (Boolean)

          Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

        • StreamViewType — (String)

          When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

          • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

          • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

          • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

          • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

          Possible values include:
          • "NEW_IMAGE"
          • "OLD_IMAGE"
          • "NEW_AND_OLD_IMAGES"
          • "KEYS_ONLY"
      • LatestStreamLabel — (String)

        A timestamp, in ISO 8601 format, for this stream.

        Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

        • Amazon Web Services customer ID

        • Table name

        • StreamLabel

      • LatestStreamArn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

      • GlobalTableVersion — (String)

        Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.

      • Replicas — (Array<map>)

        Represents replicas of the table.

        • RegionName — (String)

          The name of the Region.

        • ReplicaStatus — (String)

          The current state of the replica:

          • CREATING - The replica is being created.

          • UPDATING - The replica is being updated.

          • DELETING - The replica is being deleted.

          • ACTIVE - The replica is ready for use.

          • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

            Note: If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

          • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

            Note: If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
          Possible values include:
          • "CREATING"
          • "CREATION_FAILED"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
          • "REGION_DISABLED"
          • "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
        • ReplicaStatusDescription — (String)

          Detailed information about the replica status.

        • ReplicaStatusPercentProgress — (String)

          Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

        • KMSMasterKeyId — (String)

          The KMS key of the replica that will be used for KMS encryption.

        • ProvisionedThroughputOverride — (map)

          Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

          • ReadCapacityUnits — (Integer)

            Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.

        • OnDemandThroughputOverride — (map)

          Overrides the maximum on-demand throughput settings for the specified replica table.

          • MaxReadRequestUnits — (Integer)

            Maximum number of read request units for the specified replica table.

        • GlobalSecondaryIndexes — (Array<map>)

          Replica-specific global secondary index settings.

          • IndexName — (String)

            The name of the global secondary index.

          • ProvisionedThroughputOverride — (map)

            If not described, uses the source table GSI's read capacity settings.

            • ReadCapacityUnits — (Integer)

              Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.

          • OnDemandThroughputOverride — (map)

            Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.

            • MaxReadRequestUnits — (Integer)

              Maximum number of read request units for the specified replica table.

        • ReplicaInaccessibleDateTime — (Date)

          The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

        • ReplicaTableClassSummary — (map)

          Contains details of the table class.

          • TableClass — (String)

            The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

            Possible values include:
            • "STANDARD"
            • "STANDARD_INFREQUENT_ACCESS"
          • LastUpdateDateTime — (Date)

            The date and time at which the table class was last updated.

      • RestoreSummary — (map)

        Contains details for the restore.

        • SourceBackupArn — (String)

          The Amazon Resource Name (ARN) of the backup from which the table was restored.

        • SourceTableArn — (String)

          The ARN of the source table of the backup that is being restored.

        • RestoreDateTime — required — (Date)

          Point in time or source backup time.

        • RestoreInProgress — required — (Boolean)

          Indicates if a restore is in progress or not.

      • SSEDescription — (map)

        The description of the server-side encryption status on the specified table.

        • Status — (String)

          Represents the current state of server-side encryption. The only supported values are:

          • ENABLED - Server-side encryption is enabled.

          • UPDATING - Server-side encryption is being updated.

          Possible values include:
          • "ENABLING"
          • "ENABLED"
          • "DISABLING"
          • "DISABLED"
          • "UPDATING"
        • SSEType — (String)

          Server-side encryption type. The only supported value is:

          • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

          Possible values include:
          • "AES256"
          • "KMS"
        • KMSMasterKeyArn — (String)

          The KMS key ARN used for the KMS encryption.

        • InaccessibleEncryptionDateTime — (Date)

          Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

      • ArchivalSummary — (map)

        Contains information about the table archive.

        • ArchivalDateTime — (Date)

          The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.

        • ArchivalReason — (String)

          The reason DynamoDB archived the table. Currently, the only possible value is:

          • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.

        • ArchivalBackupArn — (String)

          The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.

      • TableClassSummary — (map)

        Contains details of the table class.

        • TableClass — (String)

          The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

          Possible values include:
          • "STANDARD"
          • "STANDARD_INFREQUENT_ACCESS"
        • LastUpdateDateTime — (Date)

          The date and time at which the table class was last updated.

      • DeletionProtectionEnabled — (Boolean)

        Indicates whether deletion protection is enabled (true) or disabled (false) on the table.

      • OnDemandThroughput — (map)

        The maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

        • MaxReadRequestUnits — (Integer)

          Maximum number of read request units for the specified table.

          To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

        • MaxWriteRequestUnits — (Integer)

          Maximum number of write request units for the specified table.

          To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BackupArn: 'STRING_VALUE' /* required */
};
dynamodb.describeBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • BackupArn — (String)

    The Amazon Resource Name (ARN) associated with the backup.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • BackupDescription — (map)

      Contains the description of the backup created for the table.

      • BackupDetails — (map)

        Contains the details of the backup created for the table.

        • BackupArn — required — (String)

          ARN associated with the backup.

        • BackupName — required — (String)

          Name of the requested backup.

        • BackupSizeBytes — (Integer)

          Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • BackupStatus — required — (String)

          Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

          Possible values include:
          • "CREATING"
          • "DELETED"
          • "AVAILABLE"
        • BackupType — required — (String)

          BackupType:

          • USER - You create and manage these using the on-demand backup feature.

          • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

          • AWS_BACKUP - On-demand backup created by you from Backup service.

          Possible values include:
          • "USER"
          • "SYSTEM"
          • "AWS_BACKUP"
        • BackupCreationDateTime — required — (Date)

          Time at which the backup was created. This is the request time of the backup.

        • BackupExpiryDateTime — (Date)

          Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

      • SourceTableDetails — (map)

        Contains the details of the table when the backup was created.

        • TableName — required — (String)

          The name of the table for which the backup was created.

        • TableId — required — (String)

          Unique identifier for the table for which the backup was created.

        • TableArn — (String)

          ARN of the table for which backup was created.

        • TableSizeBytes — (Integer)

          Size of the table in bytes. Note that this is an approximate value.

        • KeySchema — required — (Array<map>)

          Schema of the table.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableCreationDateTime — required — (Date)

          Time when the source table was created.

        • ProvisionedThroughput — required — (map)

          Read IOPs and Write IOPS on the table when the backup was created.

          • ReadCapacityUnits — required — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

            If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • WriteCapacityUnits — required — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

            If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

        • OnDemandThroughput — (map)

          Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

          • MaxReadRequestUnits — (Integer)

            Maximum number of read request units for the specified table.

            To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

          • MaxWriteRequestUnits — (Integer)

            Maximum number of write request units for the specified table.

            To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

        • ItemCount — (Integer)

          Number of items in the table. Note that this is an approximate value.

        • BillingMode — (String)

          Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

          • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

          • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

          Possible values include:
          • "PROVISIONED"
          • "PAY_PER_REQUEST"
      • SourceTableFeatureDetails — (map)

        Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

        • LocalSecondaryIndexes — (Array<map>)

          Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

              • ALL - All of the table attributes are projected into the index.

              When using the DynamoDB console, ALL is selected by default.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • GlobalSecondaryIndexes — (Array<map>)

          Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the table at the time of backup.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

              • ALL - All of the table attributes are projected into the index.

              When using the DynamoDB console, ALL is selected by default.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            • ReadCapacityUnits — required — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

              If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

            • WriteCapacityUnits — required — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

              If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • OnDemandThroughput — (map)

            Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

            • MaxReadRequestUnits — (Integer)

              Maximum number of read request units for the specified table.

              To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

            • MaxWriteRequestUnits — (Integer)

              Maximum number of write request units for the specified table.

              To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

        • StreamDescription — (map)

          Stream settings on the table when the backup was created.

          • StreamEnabled — required — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • TimeToLiveDescription — (map)

          Time to Live settings on the table when the backup was created.

          • TimeToLiveStatus — (String)

            The TTL status for the table.

            Possible values include:
            • "ENABLING"
            • "DISABLING"
            • "ENABLED"
            • "DISABLED"
          • AttributeName — (String)

            The name of the TTL attribute for items in the table.

        • SSEDescription — (map)

          The description of the server-side encryption status on the table when the backup was created.

          • Status — (String)

            Represents the current state of server-side encryption. The only supported values are:

            • ENABLED - Server-side encryption is enabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type. The only supported value is:

            • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS key ARN used for the KMS encryption.

          • InaccessibleEncryptionDateTime — (Date)

            Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.