Pausing traffic to EZID

EZID

Occasionally it will be necessary to pause communications with EZID, our DOI registration service. This is typically required when the system is down for maintenance.

The POST /dmps endpoint used to create a new DMP ID, the PUT /dmps/{dmp_id} to update an existing DMP ID and DELETE /dmps/{dmp_id} to tombstone a DMP ID will remain operational while the traffic to EZID is paused.

Note that any new DMP IDs that are created during a pause will not have a resolvable DOI until the integration is unpaused and the records impacted by the pause are re-processed.

To pause the traffic you need only update a single SSM variable: aws ssm put-parameter --name /uc3/dmp/hub/[env]/EzidPaused --overwrite --type String --value true

Once paused, the email address defined in the SSM parameter for /uc3/dmp/hub/[env]/AdminEmail will begin to receive emails for any DMP IDs that should be sending traffic to EZID. For example:

DETAILS: {"message":"EZID Paused","event_details":{"PK":"DMP#doi.org/10.12345/ABC123","SK":"VERSION#latest","dmphub_provenance_id":"PROVENANCE#dmptool","dmproadmap_links":{"get":"https://api/v2/plans/1234567890"}}}

To unpause the traffic you must:

• Set the above SSM parameter back to false
• Review any emails received and reprocess them by running the following script located in this repo under the src/scripts directory: ezid_sync.sh [env] [doi] for example ezid_sync.sh prd doi.org/10.12345/ABC123