Before you start
- The Cloud Collector CloudFormation stack deployed against your Amazon Connect instance.
- An Operata API token with admin permissions. See Authentication.
- The list of CTR fields you want to allow or deny. The field names follow the CTR data model.
Steps
1. Read the active config
Confirm what the Cloud Collector is using today before you replace it. A404 means no config exists and the privacy-first default is in effect — the Cloud Collector ships only the mandatory CTR fields.
2. Decide allow-list or deny-list
One config per Operata account. The two shapes are mutually exclusive.- Use a deny-list (
BLACKLIST) to ship the full CTR minus the fields you name. Suits accounts that already vet what Amazon Connect emits. - Use an allow-list (
WHITELIST) to ship only the mandatory fields plus the fields you name. Suits accounts under tight data-egress controls.
3. Apply the new config
PUT /v1/config/json is a full replace, not a patch. Send every field you want active in one body.
200 OK with body REDACTION_CONFIG updated confirms the new policy is durable. A 400 with REDACTION_CONFIG not valid means the body failed validation — see Update redaction config for the body schema.
4. Wait for propagation
The Cloud Collector caches the active config and refreshes it on a 30-minute interval. Contacts that end inside the propagation window may still ship under the previous policy. For changes that must take effect immediately, stop the EventBridge pipe, wait for the refresh, then restart.Result
Place a test contact (see Send your first observation for the procedure), then read the contact back through the API. On an allow-list, only the mandatory fields plus the fields you named appear. On a deny-list, the named fields are absent from the response payload.Related
- Data redaction — the reference index for the config schema, mandatory fields, and propagation contract.
- Update redaction config — every parameter and error code on the
PUT. - Delete redaction config — remove the config and revert to the privacy-first default.
- Privacy and redaction — the model behind allow-list, deny-list, and edge filtering.