API Stability Short-Term

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 documentation page.

Syntax

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

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

Given Datatypes

The given datatype S3ArchivingFormat is an enumerated list. Its values are listed here:

Table: S3ArchivingFormat

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: May 9, 2025
NDJSON   Short-TermThe format for archival storage in AWS S3 is newline delimited JSON.
RAW   Short-TermThe format for archival storage of segments in AWS S3 is raw.

Returned Datatypes

The returned datatype BooleanResultType has its one parameter. It's described below:

Table: BooleanResultType

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 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.