The s3ConfigureArchiving() GraphQL mutation is used to configure S3 archiving for a repository (e.g., bucket and region).

For more information on S3 storage, see the S3 Archiving for LogScale Cloud documentation page.

Syntax

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

graphql
s3ConfigureArchiving(
   repositoryName: string!
   bucket: string!
   region: string!
   format: S3ArchivingFormat!
   tagOrderInName: [string!]
): BooleanResultType!

Given and Returned Datatypes

The given datatype S3ArchivingFormat is an enumerated list: RAW, or NDJSON. The returned datatype BooleanResultType has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: BooleanResultType

ParameterTypeRequired[a]DefaultDescription
resultsbooleanyes Whether the mutation was performed or not.

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