Stability Level Long-Term
API Stability Long-Term

The testS3Action() GraphQL mutation is used to test an Amazon S3 action.

Syntax

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

graphql
testS3Action(
     input: TestS3Action!
   ): TestResult!

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

Raw
graphql
mutation {
  testS3Action(
    input: { 
    viewName: "humio",
    roleArn: "arn:aws_iam::1234:user/admin"
    name: "act-one",
    awsRegion: "us-west-2",
    bucketName: "pale-1",
    outputFormat: "CSV",
    outputMetadata: True,
    useProxy: False,
    triggerName: "fire",
    eventData: "[{\"#type\":\"kv\"}]"
    }
  ) { success }
}
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 {
  testS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    name: \"act-one\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False,
    triggerName: \"fire\",
    eventData: \"[{\\"#type\\":\\"kv\\"}]\"
    }
  ) { success }
}"
}
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 {
  testS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    name: \"act-one\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False,
    triggerName: \"fire\",
    eventData: \"[{\\"#type\\":\\"kv\\"}]\"
    }
  ) { success }
}"
}
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 { ^
  testS3Action( ^
    input: {  ^
    viewName: \"humio\", ^
    roleArn: \"arn:aws_iam::1234:user/admin\" ^
    name: \"act-one\", ^
    awsRegion: \"us-west-2\", ^
    bucketName: \"pale-1\", ^
    outputFormat: \"CSV\", ^
    outputMetadata: True, ^
    useProxy: False, ^
    triggerName: \"fire\", ^
    eventData: \"[{\\"#type\\":\\"kv\\"}]\" ^
    } ^
  ) { success } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  testS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    name: \"act-one\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False,
    triggerName: \"fire\",
    eventData: \"[{\\"#type\\":\\"kv\\"}]\"
    }
  ) { success }
}"
}'
    "$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 {
  testS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    name: \"act-one\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False,
    triggerName: \"fire\",
    eventData: \"[{\\"#type\\":\\"kv\\"}]\"
    }
  ) { success }
}";
$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 {
  testS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    name: \"act-one\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False,
    triggerName: \"fire\",
    eventData: \"[{\\"#type\\":\\"kv\\"}]\"
    }
  ) { success }
}"
}'''

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 {
  testS3Action(
    input: { 
    viewName: \"humio\",
    roleArn: \"arn:aws_iam::1234:user/admin\"
    name: \"act-one\",
    awsRegion: \"us-west-2\",
    bucketName: \"pale-1\",
    outputFormat: \"CSV\",
    outputMetadata: True,
    useProxy: False,
    triggerName: \"fire\",
    eventData: \"[{\\"#type\\":\\"kv\\"}]\"
    }
  ) { success }
}"
}
);


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": {
    "testS3Action": {
      "success": true
    }
  }
}

Given Datatypes

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

Table: TestS3Action

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 Amazon AWS region. For options, see the Amazon S3 documentation.
bucketNamestringyes Long-TermThe name of the bucket.
eventDatastringyes Long-TermJSON data representing zero or more events. One event can be supplied as a JSON object. Multiple events must be supplied as a list of JSON objects.
fileNamestringyes Long-TermThe name of the file or files. You can use most message templates for this. For documentation on S3 action, see ???.
namestringyes Long-TermThe name of the S3 action.
outputFormatS3ActionEventOutputFormatyes Long-TermThe output format type for the result. 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.
triggerNamestringyes Long-TermThe name of the action. This is a mock value; the trigger doesn't have to exist.
useProxystring trueLong-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 TestResult, there are a couple parameters that may be requested. Below is a list of them:

Table: TestResult

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: Oct 3, 2024
messagestringyes Long-TermA message explaining the test result.
successbooleanyes Long-TermTrue if the test was a success, false otherwise.