Stability Level Long-Term
API Stability Long-Term

The updateS3Action() GraphQL mutation is used to update an Amazon S3 action.

Syntax

Below is the syntax for the updateS3Action() mutation field:

graphql
updateS3Action(
      input: UpdateS3Action!
   ): S3Action!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  updateS3Action(
    input: { 
    viewName: "humio",
    roleArn: "arn:aws_iam::1234:user/admin"
    id: "abc123",
    name: "act-one",
    labels: "[]",
    awsRegion: "us-west-2",
    bucketName: "pale-1",
    fileName: "file-1",
    outputFormat: "CSV",
    outputMetadata: True,
    useProxy: False
    }
  ) { id, isAllowedToRun }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    id: \"abc123\",
    name: \"act-one\",
    labels: \"[]\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    fileName: \"file-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False
    }
  ) { id, isAllowedToRun }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    id: \"abc123\",
    name: \"act-one\",
    labels: \"[]\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    fileName: \"file-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False
    }
  ) { id, isAllowedToRun }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateS3Action( ^
    input: {  ^
    viewName: \"humio\", ^
    roleArn: \"arn:aws_iam::1234:user/admin\" ^
    id: \"abc123\", ^
    name: \"act-one\", ^
    labels: \"[]\", ^
    awsRegion: \"us-west-2\", ^
    bucketName: \"pale-1\", ^
    fileName: \"file-1\", ^
    outputFormat: \"CSV\", ^
    outputMetadata: True, ^
    useProxy: False ^
    } ^
  ) { id, isAllowedToRun } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    id: \"abc123\",
    name: \"act-one\",
    labels: \"[]\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    fileName: \"file-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False
    }
  ) { id, isAllowedToRun }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updateS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    id: \"abc123\",
    name: \"act-one\",
    labels: \"[]\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    fileName: \"file-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False
    }
  ) { id, isAllowedToRun }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    id: \"abc123\",
    name: \"act-one\",
    labels: \"[]\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    fileName: \"file-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False
    }
  ) { id, isAllowedToRun }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    id: \"abc123\",
    name: \"act-one\",
    labels: \"[]\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    fileName: \"file-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False
    }
  ) { id, isAllowedToRun }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateS3Action": {
      "id": "abc123",
      "isAllowedToRun": true
    }
  }
}

Given Datatypes

For the UpdateS3Action given datatype, there are a few parameters. Below is a list of them, along with a description of each.

Table: UpdateS3Action

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
awsRegionstringyes Long-TermThe AWS region of the S3 action. For options see the Amazon S3 documentation.
bucketNamestringyes Long-TermThe name of the S3 bucket.
fileNamestringyes Long-TermThe name of the file or files. You can use most message templates for this. For documentation on S3 action, see ???.
idstringyes Long-TermThe unique identifier of the action.
labels[string]yes Long-TermLabels to categorize the action. There can be at most ten labels, with a maximum length of sixty characters per label.
namestringyes Long-TermThe name of the S3 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.
roleArnstringyes Long-TermThe ARN of the role to be assumed.
useProxybooleanyes Long-TermWhether the action should use the configured HTTP proxy to send requests.
viewNameRepoOrViewNameyes Long-TermThe name of the view of the action. RepoOrViewName is a scalar.

Returned Datatypes

For S3Action, there are several parameters that may be requested. Below is a list of them:

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.