dynamodb describe-table

describe dynamodb table

Description

Describe dynamodb table metadata

Synopsis

dynamodb describe-table
    [--site <site>]
    [--region <region>]
    <name>

Arguments

`site` - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

`region` - (string)

     AWS region for the service
     Example: --region "region-1"
     Default: _None_      Attributes: optional

`name` - (string)

     The name of the table
     Example: "name-1"
     Default: _None_      Attributes: required

Examples

Input:

x=! dynamodb describe-table "testtable1"

Output:

{
  "name": "testtable1",
  "region": "us-east-1",
  "provisionedThroughput": {
    "writeCapacityUnits": "1",
    "readCapacityUnits": "1"
  },
  "status": "ACTIVE",
  "billingMode": "PROVISIONED",
  "keySchemas": [
    {
      "attributeName": "testpk1",
      "type": "HASH"
    },
    {
      "attributeName": "testsk1",
      "type": "RANGE"
    }
  ],
  "attributeDefinitions": [
    {
      "attributeName": "testpk1",
      "attributeType": "S"
    },
    {
      "attributeName": "testsk1",
      "attributeType": "S"
    }
  ]
}

Input:

! dynamodb describe-table "testtable1"

Output:

NAME            REGION          STATUS 
testtable1      us-east-1       ACTIVE

Access Control

To use this command, you need access to the following:

Field	Value
Action	"read"
Service Type	"dynamodb"
Service Instance
Namespace
Object Type	"table"
Object ID	name

Please see Access Control for details.