S3Action is a datatype for an Amazon S3 action.

Table: S3Action

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Dec 29, 2025
allowedActions[AssetAction]yes Short-TermThe allowed asset actions. See AssetAction.
awsRegionstringyes Long-TermThe AWS region used. For options, see the Amazon S3 documentation.
bucketNamestringyes Long-TermThe name of the bucket.
createdInfoAssetCommitMetadata  Long-TermAny metadata related to the creation of the action. See AssetCommitMetadata.
displayNamestringyes Long-TermThe display name of the action.
fileNamestringyes Long-TermThe name of the file or files. You can use most message templates. For documentation on S3 action, see ???.
idstringyes Long-TermThe unique identifier of the action.
isAllowedToRunbooleanyes Long-TermFalse if this type of action is disabled because of a security policy, true otherwise.
labels[string]  PreviewAny labels to categorize the action.
modifiedInfoAssetCommitMetadata  Long-TermAny metadata related to the latest modification of the action. See AssetCommitMetadata.
namestringyes Long-TermThe name of the action.
outputFormatS3ActionEventOutputFormatyes Long-TermThe output format type for the results. See S3ActionEventOutputFormat.
outputMetadatabooleanyes Long-TermWhether to output metadata for the result. Metadata will be output as a separate JSON file.
packagePackageInstallation  Long-TermThe package, if any, of which the action is part. See PackageInstallation.
packageIdVersionedPackageSpecifier  Long-TermThe unique identifier of the package used, if any. VersionedPackageSpecifier is a scalar.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes Long-TermTrue if this action is used by triggers, where the query is run by the organization. The OrganizationOwnedQueries permission is required to edit the action if set to true.
resourcestringyes Short-TermThe resource identifier for this action.
roleArnstringyes Long-TermThe ARN of the role to be assumed.
useProxybooleanyes Long-TermWhether the action should use the configured HTTP proxy to send requests.
yamlTemplateYAMLyes Long-TermA template that can be used to recreate the action. YAML is a scalar.