Command Reference¶
All commands must be run from the directory where the tool archive was extracted. To view available options for any command, run it with the --help flag.
| Command | Description | Prerequisites |
|---|---|---|
| bootstrap | Deploys CloudFormation stack with required infrastructure (S3, IAM, Customer Profiles domain, KMS). Must run before any export or import command. | None |
| preflight | Validates AWS environment, credentials, permissions, and quotas. No resources are created. | None |
| express-setup | Creates an Amazon Connect instance with required infrastructure (S3, Kinesis). | None |
| export-endpoints | Exports Pinpoint endpoints to S3. | bootstrap |
| import-endpoints | Transforms and ingests endpoint data into Customer Profiles. | bootstrap, export-endpoints |
| export-templates | Exports email, SMS, and voice templates to S3. | bootstrap |
| import-templates | Imports templates into Amazon Connect. Requires Q_MESSAGE_TEMPLATES knowledge base. | import-endpoints |
| export-segments | Exports DIMENSIONAL segment definitions to S3. | bootstrap |
| import-segments | Imports segment definitions into Customer Profiles. | import-endpoints |
| export-campaigns | Exports eligible campaigns to S3. | bootstrap |
| import-campaigns | Imports campaigns as Connect Outbound Campaigns. | import-templates, import-segments |
| export-journeys | Exports journeys as Contact Flow definitions to S3. | bootstrap |
| import-journeys | Imports Contact Flow definitions into Amazon Connect. | import-templates, import-segments |