IntegrationsAwsActions
List S3 objects
List objects in one general-purpose bucket with optional prefix and delimiter. Requires s3:ListBucket.
s3.objects.list · AWS · v1
Details
Scopes
s3:ListBucket
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
bucket | string | Yes | minLength 3; maxLength 63; pattern ^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$ |
region | string | No | enum us-east-1 | us-east-2 | us-west-1 | us-west-2 | af-south-1 | ap-east-1 | ap-east-2 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-southeast-4 | ap-southeast-5 | ap-southeast-6 | ap-southeast-7 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ca-central-1 | ca-west-1 | eu-central-1 | eu-central-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-north-1 | eu-south-1 | eu-south-2 | il-central-1 | me-central-1 | me-south-1 | mx-central-1 | sa-east-1 |
prefix | string | No | minLength 1; maxLength 1024 |
delimiter | string | No | minLength 1; maxLength 16 |
page_size | integer | No | minimum 1; maximum 1000 |
cursor | string | No | minLength 1; maxLength 16384; pattern ^(?!.*://)[^\x00-\x1f\x7f]+$ |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
objects | array<object> | Yes | maxItems 1000 |
objects[] | object | Yes | additionalProperties false |
objects[].key | string | Yes | minLength 1; maxLength 1024 |
objects[].size_bytes | integer | Yes | minimum 0 |
objects[].etag | string | No | minLength 1; maxLength 256 |
objects[].last_modified_at | string | No | minLength 1; maxLength 64 |
objects[].storage_class | string | No | minLength 1; maxLength 64 |
common_prefixes | array<string> | Yes | maxItems 1000 |
common_prefixes[] | string | Yes | minLength 1; maxLength 1024 |
next_cursor | string | No | minLength 1; maxLength 16384; pattern ^(?!.*://)[^\x00-\x1f\x7f]+$ |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"bucket": {
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$"
},
"region": {
"type": "string",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"af-south-1",
"ap-east-1",
"ap-east-2",
"ap-south-1",
"ap-south-2",
"ap-southeast-1",
"ap-southeast-2",
"ap-southeast-3",
"ap-southeast-4",
"ap-southeast-5",
"ap-southeast-6",
"ap-southeast-7",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ca-central-1",
"ca-west-1",
"eu-central-1",
"eu-central-2",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-north-1",
"eu-south-1",
"eu-south-2",
"il-central-1",
"me-central-1",
"me-south-1",
"mx-central-1",
"sa-east-1"
]
},
"prefix": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"delimiter": {
"type": "string",
"minLength": 1,
"maxLength": 16
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 16384,
"pattern": "^(?!.*://)[^\\x00-\\x1f\\x7f]+$"
}
},
"required": [
"bucket"
]
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"objects": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"key": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"size_bytes": {
"type": "integer",
"minimum": 0
},
"etag": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"last_modified_at": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"storage_class": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"key",
"size_bytes"
]
},
"maxItems": 1000
},
"common_prefixes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"maxItems": 1000
},
"next_cursor": {
"type": "string",
"minLength": 1,
"maxLength": 16384,
"pattern": "^(?!.*://)[^\\x00-\\x1f\\x7f]+$"
}
},
"required": [
"objects",
"common_prefixes"
]
}