Amazon WorkDocs

Connector Creation

To authorize or add an Amazon WorkDocs account as a Connector, follow these steps:

1. Find Your Amazon Region

In the AWS Console go to the WorkDocs service. In the top right-hand corner in between the account’s email address and the “Support” link, click the Region selector and note which region is highlighted.

Note Your Region

Use this table or the Amazon documentation page to get the Region Code for your WorkDocs installation.

Code Name
us-east-1 US East (N. Virginia)
us-east-2 US East (Ohio)
us-west-1 US West (N. California)
us-west-2 US West (Oregon)
eu-west-1 EU (Ireland)
eu-central-1 EU (Frankfurt)
ap-northeast-1 Asia Pacific (Tokyo)
ap-northeast-2 Asia Pacific (Seoul)
ap-southeast-1 Asia Pacific (Singapore)
ap-southeast-2 Asia Pacific (Sydney)
ap-south-1 Asia Pacific (Mumbai)
sa-east-1 South America (São Paulo)

2. Find Your Directory ID

WorkDocs is backed by Amazon’s Directory Service. Each WorkDocs installation will have a Directory Service instance. We will need the Directory ID for the WorkDocs installation in order to grant the user access to it.

  • Click the Services Menu in the AWS Console and select “Directory Service”.
  • Find the Directory Name that corresponds to your WorkDocs installation. If you created the WorkDocs installation with the default “Simple AD” the name should be something like “corp.workdocssitename.com”.
  • Note the Directory ID in the first column or click the item and copy the ID from the details page.

Details page:

Find Your Directory ID

3. Set Your IAM Access Policy

The user you will create to give us access to your WorkDocs installation will need to be granted full access. This is accomplished using an IAM Access Policy.

  • In the AWS Console select “IAM” from the Services menu
  • Click “Policies” in the left-hand column
  • Click “Create Policy”

Set Your IAM Access Policy

  • Click the “Select” button next to “Create Your Own Policy”
  • Enter a policy name (e.g. “WorkDocsFullAccess”) and description
  • Copy and paste the following into the “Policy Document” section:
  • Replace directory_id with the Directory ID noted earlier.
  • Click “Validate Policy”
  • Click “Create Policy”

Apply Policy

4. Create an IAM User

We need to create a user that will have access to WorkDocs in order to complete the migration. This user’s key and secret will be shared with Mover.

  • In the AWS Console select “IAM” from the Services menu
  • Click “Users” in the left hand column
  • Click “Create New User”
  • Enter a user name. E.g. “workdocs_mover_access”

Create User

  • Click “Create Users”
  • Click “Show User Security Credentials”
  • Note the “Access Key ID” and “Secret Access Key”. The “Secret Access Key” will not be shown anywhere in the AWS Console again, but a new key and secret can be generated if needed.

Access Key

  • Click “Close” or “Download Credentials” to save a CSV file with the key and secret of the user created.
  • Click on the new user in the list of users
  • Click the “Permissions” tab
  • Click “Attach Policy”
  • Find the Policy created earlier (“WorkDocsFullAccess” if you used the suggested name)
  • Click “Attach Policy”

Attach Policy

The user should now have full access to WorkDocs.

5. Authorize With Mover

  • Select Amazon WorkDocs from the Connector list in the Transfer Wizard.
  • Click Authorize a new Amazon WorkDocs account.
  • Name your Connector.
  • Enter your Access Key ID and Secret Access Key.
  • Enter your Region and Directory ID.
  • Click Authorize, and voila!

Authorizing Amazon WorkDocs with Mover

Troubleshooting

Whitelisting your region and AWS ID

  • As of March 9th, 2017, Amazon requires that all users of the WorkDocs API be manually whitelisted. Please email support@mover.io with your AWS ID and region and we will ask Amazon to whitelist your account for API access.
  • This requirement is anticipated to be removed in a few weeks.

Authorization: If you're having trouble creating or adding a Amazon WorkDocs connector, here are some things to try:

  • Double check that you're entering in your Access Key ID and Secret Key correctly - these are both long alphanumeric strings prone to mistakes if entered manually. If copy and pasting, ensure that your computer is accurately performing that task.
  • Hover over your existing Amazon WorkDocs integration in the Connector selection screen and select Reauthorize. This will take you through the Connector creation steps again in order to refresh the token/permissions that Mover has with your Amazon WorkDocs account.
  • Open up private browsing or incognito mode and try again.

Transfer from Amazon WorkDocs source: If you're having trouble transferring from Amazon WorkDocs:

  • Hit Rerun in the Activity Logs tab.
  • View your transfer log from the Activity Logs tab and see if there are any particular error messages you could act on.

Transfer to Amazon WorkDocs destination: If you're having trouble transferring into Amazon WorkDocs:

  • Hit Rerun in the Activity Logs tab.
  • View your transfer log from the Activity Logs tab and see if there are any particular error messages you could act on.