The s3EnableArchiving() GraphQL mutation may be used to enable an archiving job for a repository in LogScale.

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

Syntax

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

graphql
s3EnableArchiving(
      repositoryName: string!
   ): BooleanResultType!

Returned Datatypes

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.