testS3Action()

Summary

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

To create an Amazon S3 action, use the createS3Action() mutation. You can use the updateS3Action() to update one and the deleteActionV2() to delete an action.

Hide Query Example

Show Amazon S3 Actions Query

To get a list of Amazon S3 actions, you could use the repository() query like so:

graphql

query {
     repository(name: "humio")
        { id, name,
          actions { id, name, 
                    ... on S3Action { id, name } }
          }
   }

Stability Level Long-Term

Syntax

graphql

testS3Action(
     input: TestS3Action!
   ): TestResult!

For the input, you have to give the name of the view, a trigger name, the bucket name, and some other parameters. See the Input Parameters section for details.

For the results, you can get confirmation the test was succesful, and a message explaining the test results. See the Returned Values section for more.

Example

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
    }
  }
}

Input Parameters

For the input, you would provide the name of the view associated with the action to test, a trigger name — which can be a mock value for testing — the bucket name, and some other parameters. These are listed and explained in the table below:

Table: TestS3Action Input Datatype

Parameter	Type	Required	Default	Stability	Description
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Dec 29, 2025
awsRegion	string	yes		`Long-Term`	The Amazon AWS region. For options, see the Amazon S3 documentation.
bucketName	string	yes		`Long-Term`	The name of the bucket.
eventData	string	yes		`Long-Term`	JSON 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.
fileName	string	yes		`Long-Term`	The name of the file or files. You can use most message templates for this. For documentation on S3 action, see Action Type: S3.
name	string	yes		`Long-Term`	The name of the S3 action.
outputFormat	S3ActionEventOutputFormat	yes		`Long-Term`	The output format type for the result. See S3ActionEventOutputFormat.
outputMetadata	boolean	yes		`Long-Term`	Whether to output metadata for the result. Metadata will be output as a separate JSON file.
roleArn	string	yes		`Long-Term`	The ARN of the role to be assumed.
triggerName	string	yes		`Long-Term`	The name of the action. This is a mock value; the trigger doesn't have to exist.
useProxy	string		true	`Long-Term`	Whether the action should use the configured HTTP proxy to send requests.
viewName	RepoOrViewName	yes		`Long-Term`	The name of the view of the action. RepoOrViewName is a scalar.

Returned Values

The results will tell you if the test was succesful and it will provide a message explaining. This is described in the table below:

Table: TestResult Datatype

Parameter	Type	Required	Stability	Description
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 3, 2024
message	string	yes	`Long-Term`	A message explaining the test result.
success	boolean	yes	`Long-Term`	True if the test was a success, false otherwise.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

testS3Action()

Summary

Syntax

Example

Input Parameters

Returned Values

Enter search term

GraphQL Mutations

GraphQL API

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

testS3Action()

Summary

Related

Syntax

Example

Input Parameters

Returned Values

Enter search term