Skip to main content

Preparing to run the Amazon DynamoDB collector


The latest version of the Collector is 2.222. To view the release notes for this version and all previous versions, please go here.

Setting up pre-requisites for running the collector

Make sure that the machine from where you are running the collector meets the following hardware and software requirements.

Table 1.



Hardware (for on-premise runs only)

Note: The following specs are based upon running one collector process at a time. Please adjust the hardware if you are running multiple collectors at the same time.


8 GB


2 Ghz processor

Software (for on-premise runs only)


Click here to get Docker. specific objects (for both cloud and on-premise runs)


You must have a ddw-catalogs dataset set up to hold your catalog files when you are done running the collector.

If you are using Catalog Toolkit , follow these instructions to prepare the datasets for collectors.

Setting up authentication for cataloging Amazon DynamoDB

This section will walk you through the process of setting up an account with ListTables, ListStreams, DescribeTable, DescribeStream. permissions and AmazonDynamoDBReadOnlyAccess policy. It also covers the setting up a credentials profile file.

STEP 1: Creating a new user

To create a new user:

  1. Go to the AWS Portal.

  2. Navigate to IAM service. Under Users, click Add users to add a user. You can also select an existing user.

  3. On the next screen, on the Set permissions page set the following:

    1. Add user to new group/existing group which has the following permissions - ListTables, ListStreams, DescribeTable, DescribeStream.

    2. In, Permissions policies section, select AmazonDynamoDBReadOnlyAccess.

      Click Next.

  4. On the next screen, review details and click Add permissions or Create user.

STEP 2: Getting access key for the user

Refer the AWS documentation for more details on managing access keys.

To get access key for the user:

  1. Login to the AWS portal and navigate to IAM service.

  2. Under Users, select the user that plan to use for the collector.

  3. On the Security credentials tab, click Create access key.

  4. Select Application running outside AWS. Click Next.

  5. Add the optional Description tag. Click Create Access key.

  6. Note down the Access key ID and Secret access key. You will need this information for setting up the credentials file.

STEP 3: Set up credentials file

Skip this step if you already have the AWS CLI installed and credentials profiles file set up.

  1. Install the AWS CLI.

  2. From the command line, run aws configure. This stores the credentials to ~/.aws/credentials.