Skip to main content

Integration guideSeal API and Scripts

AWS

Send selected Seal records to AWS for storage, analysis or further processing.

Illustration of a seal beside a laptop showing a data table and an evidence binder linked by a red thread.

Seal to AWSSeal API and Scripts

Seal sends
Selected Seal records and reports
Source of truth
Agreed when scoped
Set up
Scoped with your team
Neil › Transfer reconciliation
draft

Check which released records reached the archive this month.

Neil

  • Once the connection is configured, I’ll use the records it provides and cite each one. Anything it doesn’t supply stays listed as missing.
Reads
Selected Seal records and reports
Returns
  • Records sent, destinations and failed transfers
  • Missing or unmatched information
  • Next steps for your team to review
Illustrative work with AWS: a request to Neil, the source it reads and the draft it returns for your review.

1What’s connected.

Send selected Seal records or reports to your AWS environment, such as Amazon S3, for storage or further analysis. A Script triggered by a Seal event or schedule can call the AWS services you approve. Agree the records, destination, credentials and failure handling before relying on the transfer.

Connection setup and permissions

Use Seal’s APIs or scripting engine for a connection tailored to your process. Agree the data mapping, access and direction of transfer before implementation.

2Write Seal records and reports to Amazon S3.

Route

A Script calls PutObject to add an object to a bucket. S3 never stores part of an object: a success response means the whole object was added.⁠¹

Record identity

The object key identifies an object uniquely within its bucket, so name the key after the Seal record and its version.⁠² S3 calculates a checksum and checks it against the value the client sends before storing the object; CRC64NVME is the default algorithm. With Content-MD5 supplied, S3 rejects an upload whose content does not match.⁠³¹

Revisions

Versioning is off by default, and without it a write to the same key replaces the object.⁠⁴⁵ With versioning on, an overwrite becomes a new version, PutObject returns its version ID and the earlier version can be restored.⁠⁴¹ Object Lock keeps versions write-once for a set period or indefinitely. It needs versioning, and in compliance mode no user, the root user included, can overwrite or delete a locked version.⁠⁶

When it fails

A second run would replace a stored report
With If-None-Match, PutObject writes only when the key does not exist and otherwise returns 412.⁠¹ Send records that must never be replaced with that header, and treat a 412 as a duplicate to look into rather than an error to retry.
Two writes conflict
A conflicting concurrent operation returns 409 ConditionalRequestConflict, and AWS says to retry.⁠¹ Retry with the same object and checksum, and log the attempt against the Seal record.

Check one record

Send one approved report from Seal to a versioned test bucket. Compare the stored checksum with the one the Script calculated. Send a revised report under the same key and confirm both versions are listed, each traceable to its Seal record version.

3Start with the job.

Tell us what Neil needs to do and which records it needs. We’ll confirm the interface, permissions and implementation scope with your team.

Discuss this connection →

4Before it goes live.

Access and any write-back

Define which records are in scope and whose permissions apply. Whether the connection writes back at all is a separate decision, with its own mapping and approval.

Verification and release

Review the configured connection for its intended use. Keep the requirements, checks and evidence with the change, and approve the release through your team’s controls.

Read the assurance detail →

References

  1. 1Amazon S3 API: PutObject.
  2. 2Amazon S3: object keys.
  3. 3Amazon S3: checking object integrity.
  4. 4Amazon S3: versioning.
  5. 5Amazon S3: conditional writes.
  6. 6Amazon S3: Object Lock.