Studio Project workflows for Amazon S3 buckets and objects, access control, and lifecycle
Amazon Simple Storage Service (S3) is AWS's object storage service, providing scalable storage for buckets and objects with configurable access control, encryption, versioning, lifecycle, and replication.
This project provides an OpenAPI spec for automating against the S3 REST API via an Integration Model. The -latest spec is a curated subset covering common CRUD for storage automation — see OpenAPIs below.
| Asset | Description |
|---|---|
| OpenAPIs/ | Amazon S3 REST API OpenAPI spec — curated -latest plus the full dated version |
| Studio Projects/Amazon S3 | 14 workflows covering common CRUD automation |
| Requirement | Version |
|---|---|
| Itential Platform | 6.x |
| Amazon S3 | API version 2006-03-01 |
| Amazon S3 Integration Model | Required to build automation against the OpenAPI spec |
Import the OpenAPI spec from OpenAPIs/ as an Integration Model in Admin > Integrations, then create an integration pointing at your AWS account/region.
S3 authenticates requests with AWS Signature Version 4, signed using your AWS access key ID and secret access key:
Authorization: AWS4-HMAC-SHA256 Credential=<access-key-id>/<date>/<region>/s3/aws4_request, SignedHeaders=..., Signature=<signature> Generate an access key ID and secret access key in the AWS IAM console under your user → Security credentials → Access keys.
The instance's authentication/server properties should look like this once configured:
{
"authentication": {
"hmac": {
"accessKeyId": "<your-aws-access-key-id>",
"secretAccessKey": "<your-aws-secret-access-key>",
"sessionToken": ""
}
},
"server": {
"protocol": "https",
"host": "s3.us-east-1.amazonaws.com",
"base_path": ""
}
} | Spec | Version | Operations | Description |
|---|---|---|---|
amazon_s3-latest.json | latest (curated) | 54 | Trimmed to 54 of 99 upstream operations covering common CRUD for automation — see breakdown below |
amazon_s3-2006-03-01.json | 2006-03-01 | 99 | Full spec for the Amazon S3 API (2006-03-01). |
amazon_s3-latest.jsonActively-maintained spec (x-vendor-api-version: 2006-03-01). Trimmed to 54 of 99 upstream operations covering common CRUD for automation.
Resources included, by category:
Not included: bucket analytics/inventory/metrics/intelligent-tiering configurations, transfer acceleration, request payer, notification configuration, replication, static website hosting, object lock/legal-hold/retention, S3 Select, object attributes, torrent, and S3 Object Lambda's WriteGetObjectResponse. Pull the full spec below if you need one of these.
amazon_s3-2006-03-01.jsonFull spec for the Amazon S3 API (2006-03-01) (99 operations) — the entire upstream API surface as AWS defines it. See amazon_s3-latest.json above for the curated subset if you just need common CRUD automation.
Backed by the Amazon S3:latest Integration Model (see amazon_s3-latest.json above). The project contains 14 workflows organized into 5 folders, one atomic workflow per API operation, covering the common-CRUD subset of the curated spec.
| Folder | Workflows | Scope |
|---|---|---|
| Buckets | List Buckets, Create Bucket, Delete Bucket, List Objects | Bucket lifecycle and object listing |
| Objects | Get Object, Delete Object | Object CRUD |
| Bucket Policy | Get, Put, Delete Bucket Policy | Bucket policy management |
| Bucket Versioning | Get, Put Bucket Versioning | Versioning configuration |
| Bucket Tagging | Get, Put, Delete Bucket Tagging | Tagging management |
| Dependency | Notes |
|---|---|
Amazon S3:latest Integration Model | Import from amazon_s3-latest.json before importing the project |
Amazon S3 integration instance | Create in Admin > Integrations with the connection properties above. Workflows are wired to an integration instance named Amazon S3 — update the adapter_id value in each workflow task if yours is named differently |