API Stability Long-Term

The testAwsS3SqsIngestFeed() GraphQL mutation tests whether the AWS Identity and Access Management (IAM) role is setup correctly and that there is a connection to the SQS queue.

Syntax

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

graphql
testAwsS3SqsIngestFeed(
     input: TestAwsS3SqsIngestFeed!
   ): boolean

The input contains data for testing an ingest feed that uses AWS S3 and SQS. See the Given Datatype section below for more details. There are no special returned datatypes, just boolean, returning a true or false result.

Example

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

Raw
graphql
mutation {
  testAwsS3SqsIngestFeed(input: 
    { repositoryName: "humio",
      authentication: { kind: IamRole, roleArn: "arn:aws_iam::1234:user/admin" },
      sqsUrl: "http://address.com/something",
      region: "us-west-2"
    } )
}
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 {
  testAwsS3SqsIngestFeed(input: 
    { repositoryName: \"humio\",
      authentication: { kind: IamRole, roleArn: \"arn:aws_iam::1234:user/admin\" },
      sqsUrl: \"http://address.com/something\",
      region: \"us-west-2\"
    } )
}"
}
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 {
  testAwsS3SqsIngestFeed(input: 
    { repositoryName: \"humio\",
      authentication: { kind: IamRole, roleArn: \"arn:aws_iam::1234:user/admin\" },
      sqsUrl: \"http://address.com/something\",
      region: \"us-west-2\"
    } )
}"
}
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 { ^
  testAwsS3SqsIngestFeed(input:  ^
    { repositoryName: \"humio\", ^
      authentication: { kind: IamRole, roleArn: \"arn:aws_iam::1234:user/admin\" }, ^
      sqsUrl: \"http://address.com/something\", ^
      region: \"us-west-2\" ^
    } ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  testAwsS3SqsIngestFeed(input: 
    { repositoryName: \"humio\",
      authentication: { kind: IamRole, roleArn: \"arn:aws_iam::1234:user/admin\" },
      sqsUrl: \"http://address.com/something\",
      region: \"us-west-2\"
    } )
}"
}'
    "$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 {
  testAwsS3SqsIngestFeed(input: 
    { repositoryName: \"humio\",
      authentication: { kind: IamRole, roleArn: \"arn:aws_iam::1234:user/admin\" },
      sqsUrl: \"http://address.com/something\",
      region: \"us-west-2\"
    } )
}";
$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 {
  testAwsS3SqsIngestFeed(input: 
    { repositoryName: \"humio\",
      authentication: { kind: IamRole, roleArn: \"arn:aws_iam::1234:user/admin\" },
      sqsUrl: \"http://address.com/something\",
      region: \"us-west-2\"
    } )
}"
}'''

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 {
  testAwsS3SqsIngestFeed(input: 
    { repositoryName: \"humio\",
      authentication: { kind: IamRole, roleArn: \"arn:aws_iam::1234:user/admin\" },
      sqsUrl: \"http://address.com/something\",
      region: \"us-west-2\"
    } )
}"
}
);


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

Given Datatype

For TestAwsS3SqsIngestFeed, there are a few parameters. Below is a list of them along with a description of each:

Table: TestAwsS3SqsIngestFeed

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: Sep 20, 2024
authenticationIngestFeedAwsAuthenticationInputyes Long-TermHow to authenticate to AWS. See IngestFeedAwsAuthenticationInput.
regionstringyes Long-TermThe AWS region in which to connect.
repositoryNameRepoOrViewNameyes Long-TermThe name of the repository of the ingest feed. RepoOrViewName is a scalar.
sqsUrlstringyes Long-TermThe AWS SQS queue URL.