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

ParameterTypeRequired[a]DefaultDescription
repositoryNameRepoOrViewNameyes Name of the repository of the ingest feed. This is a scalar.
idstringyes The unique identifier of the ingest feed.
namestring  The name of the ingest feed.
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.
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".
authenticationIngestFeedAwsAuthenticationInputyes How to authenticate to AWS. (see IngestFeedAwsAuthenticationInput Table).
sqsUrlstringyes The AWS SQS queue URL.
regionstringyes The AWS region in which to connect.
enabledbooleanyes Whether ingest from the ingest feed is enabled.
preprocessingIngestFeedPreprocessingInputyes The preprocessing to apply to an ingest feed before parsing (see IngestFeedPreprocessingInput Table).
compressionIngestFeedCompressionyes Compression scheme of the file (see IngestFeedCompression Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


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

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier of the ingest feed.
namestringyes The name of the ingest feed.
descriptionstring  A description of the ingest feed.
parserParser  The parser used to parse the ingest feed.
enabledbooleanyes Whether the ingest from the ingest feed is enabled.
sourceIngestFeedSourceyes The source from which the ingest feed will ingest (see IngestFeedSource Table).
createdAtlongyes Unix timestamp for when this feed was created.
executionInfoIngestFeedExecutionInfo  Details about how the ingest feed is running. (see IngestFeedExecutionInfo Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.