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!

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

Given Datatypes

For the input updateAwsS3SqsIngestFeed(), there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: UpdateAwsS3SqsIngestFeed

ParameterTypeRequiredDefaultDescription
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 its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: IngestFeed

ParameterTypeRequiredDefaultDescription
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.
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.