Transformation:Create S3 Transformation

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

Create S3 Transformation

POST /object/transformation/s3

Required Roles

SYSTEM_ADMIN

Request Payload

<s3_transformation_object_param>
   <accessKeyId></accessKeyId>
   <secretAccessKey></secretAccessKey>
   <protocol></protocol>
   <protocolEndpoint></protocolEndpoint>
   <name></name>
   <description></description>
   <replication_group></replication_group>
   <namespace></namespace>
   <auto_mode></auto_mode>
   <encryption_enabled></encryption_enabled>
</s3_transformation_object_param>

{
  "accessKeyId": "",
  "secretAccessKey": "",
  "protocol": "",
  "protocolEndpoint": "",
  "name": "",
  "description": "",
  "replication_group": "",
  "namespace": "",
  "auto_mode": "",
  "encryption_enabled": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
s3_transformation_object_param
accessKeyId	User provided access key ID	String
secretAccessKey	User provided secret access key	String
protocol	User provided protocol	String
protocolEndpoint	User provided protocol endpoint. Format :	String
name	User provided name (not verified or unique)	String
description	User provided description	String
replication_group	Replication group for transformation. If bucket not provided by user, this rg will be used by transformation during bucket creation.	URI
namespace		String
auto_mode		Boolean
encryption_enabled	Encryption for namespace	Boolean

Response Body

Field	Description	Type	Notes
transformation
transformation_id	ID of this transformation	URI
current_phase	Optional. Current phase	String
phases			0-* Elements
phase_id	Optional. Phase id of transformation. Possible values: PreCheck, Enumeration, Indexing, Migration, Reconciliation, Deletion	String
status	Optional. Phase status. Possible values: Pending, InProgress, Succeeded, Failed, Canceled	String
source_ids	Optional. List of sources (profile and bucket mappings) for transformation	String	0-* Elements
namespace	Optional. Namespace for transformation. If namespace not provided by user, this namespace will be used by transformation during bucket creation.	String
replication_group	Optional. Replication group for transformation. If bucket not provided by user, this replication group will be used by transformation during bucket creation.	String
name	Optional. User provided name (not verified or unique)	String
description	Optional. User provided description.	String
storageDeviceInfo	Storage device info.
start_time	Optional. Transformation start time.	String
end_time	Optional. Transformation end time.	String
total_objects_for_migration	Optional. Total objects discovered for migration.	Long
total_objects_migrated	Optional. Total objects migrated.	Long
total_bytes_for_migration	Optional. Total bytes discovered for migration.	Long
total_bytes_migrated	Optional. Total bytes migrated.	Long
total_errors	Optional. Total unrecovered errors occurred during migration.	Long
total_mismatch_objects	Optional. Total mismatches after reconciliation.	Long
encryption_enabled	Optional. Namespace encryption.	Boolean