API Stability Long-Term

The updateAwsS3SqsIngestFeed() GraphQL mutation is used to update an ingest feed which uses AWS S3 and SQS.

Syntax

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

updateAwsS3SqsIngestFeed(
     input: UpdateAwsS3SqsIngestFeed!
   ): IngestFeed!

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

Raw
graphql
mutation {
  updateAwsS3SqsIngestFeed( input:
    {
      repositoryName: "humio",
      id: "abc123",
      enabled: false
    }
  )
  { id }
}
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 {
  updateAwsS3SqsIngestFeed( input:
    {
      repositoryName: \"humio\",
      id: \"abc123\",
      enabled: false
    }
  )
  { id }
}"
}
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 {
  updateAwsS3SqsIngestFeed( input:
    {
      repositoryName: \"humio\",
      id: \"abc123\",
      enabled: false
    }
  )
  { id }
}"
}
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 { ^
  updateAwsS3SqsIngestFeed( input: ^
    { ^
      repositoryName: \"humio\", ^
      id: \"abc123\", ^
      enabled: false ^
    } ^
  ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateAwsS3SqsIngestFeed( input:
    {
      repositoryName: \"humio\",
      id: \"abc123\",
      enabled: false
    }
  )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  updateAwsS3SqsIngestFeed( input:
    {
      repositoryName: \"humio\",
      id: \"abc123\",
      enabled: false
    }
  )
  { id }
}"
}';
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 {
  updateAwsS3SqsIngestFeed( input:
    {
      repositoryName: \"humio\",
      id: \"abc123\",
      enabled: false
    }
  )
  { id }
}"
}'''

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 {
  updateAwsS3SqsIngestFeed( input:
    {
      repositoryName: \"humio\",
      id: \"abc123\",
      enabled: false
    }
  )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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
{
  "updateAwsS3SqsIngestFeed": {
    "id": "abc123"
    }
  }
}

The input contains data for updating an ingest feed which uses AWS S3 and SQS. The update is a delta update.

Given Datatypes

For UpdateAwsS3SqsIngestFeed, there are several parameters. Below is a list of them along with their a description of each:

Table: UpdateAwsS3SqsIngestFeed

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 23, 2024
authenticationIngestFeedAwsAuthenticationInputyes  How to authenticate with AWS. See IngestFeedAwsAuthenticationInput.
compressionIngestFeedCompressionyes  The compression scheme of the file. See IngestFeedCompression.
descriptionUpdateIngestFeedDescription   If the description should be cleared, supply an UpdateDescription object with no value or a null value. If the description should be changed, supply an UpdateDescription object with the desired value. See UpdateIngestFeedDescription.
enabledboolean   Whether ingest from the ingest feed is enabled.
idstringyes  The unique identifier of the ingest feed.
namestring   The name of the ingest feed.
parserstring   The unique identifier or name of the parser that should be used to parse the ingest feed. Parsers in packages can be referred to as packagescope/packagename:parsername.
preprocessingIngestFeedPreprocessingInput   The preprocessing to apply to an ingest feed before parsing. See IngestFeedPreprocessingInput.
regionstring   The AWS region in which to connect.
repositoryNameRepoOrViewNameyes  Name of the repository of the ingest feed. RepoOrViewName is a scalar.
sqsUrlstring   The AWS SQS queue URL.

Returned Datatypes

The returned datatype IngestFeed) has several parameters. Below is a list of them along with a description of each:

Table: IngestFeed

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 25, 2024
createdAtlongyes  Unix timestamp for when this feed was created.
descriptionstring   A description of the ingest feed.
enabledbooleanyes  Whether the ingest from the ingest feed is enabled.
executionInfoIngestFeedExecutionInfo   Details about how the ingest feed is running. See IngestFeedExecutionInfo.
idstringyes  The unique identifier of the ingest feed.
namestringyes  The name of the ingest feed.
parserParser   The parser used to parse the ingest feed. See Parser.
sourceIngestFeedSourceyes  The source from which the ingest feed will ingest. See IngestFeedSource.