API ReferenceImport StorageS3s

Create import storage

Create S3 import storage 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
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
presignbooleanOptionalDefaults to true
presign_ttlintegerOptional>=0<=32767

Presigned URLs TTL (in minutes)

recursive_scanbooleanOptional
Perform recursive scan over the bucket content
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

Response

created_atdatetime
Creation time
idinteger
projectinteger
A unique integer value identifying this project.
role_arnstring
AWS RoleArn
typestringDefaults to s3s
aws_access_key_idstring or null

AWS_ACCESS_KEY_ID

aws_secret_access_keystring or null

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring or null

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring or null
AWS SSE KMS Key ID
bucketstring or null
S3 bucket name
descriptionstring or null
Cloud storage description
external_idstring or null
AWS ExternalId
last_syncdatetime or null
Last sync finished time
last_sync_countinteger or null>=0<=2147483647
Count of tasks synced last time
last_sync_jobstring or null<=256 characters
Last sync job ID
legacy_authboolean or null
metaany or null
prefixstring or null
S3 bucket prefix
presignboolean or nullDefaults to true
presign_ttlinteger or null>=0<=32767

Presigned URLs TTL (in minutes)

recursive_scanboolean or null
Perform recursive scan over the bucket content
regex_filterstring or null
Cloud storage regex for filtering objects
region_namestring or null
AWS Region
s3_endpointstring or null
S3 Endpoint
statusenum or null
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizableboolean or nullDefaults to true
titlestring or null<=256 characters
Cloud storage title
tracebackstring or null
Traceback report for the last failed sync
use_blob_urlsboolean or null
Interpret objects as BLOBs and generate URLs