API ReferenceExport StorageS3s

Validate export storage

Validate a specific S3 export storage connection that was set up with IAM role access.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
projectintegerRequired
A unique integer value identifying this project.
role_arnstringRequired>=1 character
AWS RoleArn
aws_access_key_idstringOptional

AWS_ACCESS_KEY_ID

aws_secret_access_keystringOptional

AWS_SECRET_ACCESS_KEY

aws_session_tokenstringOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_idstringOptional
AWS SSE KMS Key ID
bucketstringOptional
S3 bucket name
can_delete_objectsbooleanOptional
Deletion from storage enabled
descriptionstringOptional
Cloud storage description
external_idstringOptional
AWS ExternalId
last_syncdatetimeOptional
Last sync finished time
last_sync_countintegerOptional>=0<=2147483647
Count of tasks synced last time
last_sync_jobstringOptional<=256 characters
Last sync job ID
legacy_authbooleanOptional
metaanyOptional
prefixstringOptional
S3 bucket prefix
regex_filterstringOptional
Cloud storage regex for filtering objects
region_namestringOptional
AWS Region
s3_endpointstringOptional
S3 Endpoint
statusenumOptional
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizablebooleanOptionalDefaults to true
titlestringOptional<=256 characters
Cloud storage title
tracebackstringOptional
Traceback report for the last failed sync
use_blob_urlsbooleanOptional
Interpret objects as BLOBs and generate URLs