Integrations

Schedule export to S3

Provide a record ID, format, and bucket information to asynchronously export to an S3 bucket by creating an access point. This utility creates a separate task to carry out the export action, regardless of whether the Call external API automation in which this utility is used is running synchronously or asynchronously.

ScheduleExportToS3: function (_sRecordID, _sFormat, _sRecipients, _oBucketInformation)
+ _oBucketInformation.BucketName:
+ _oBucketInformation.AWSRegion:
+ _oBucketInformation.Path:
+ _oBucketInformation.CredentialType:
+ _oBucketInformation.KMSEncryptionKeyID:
+ _oBucketInformation.CannedACL:
+ _oBucketInformation.AccessKeyID:
+ _oBucketInformation.SecretAccessKey:
+ _oBucketInformation.RoleARN:

This utility doesn’t use a success or failure callback attribute in the request parameter.

📘

Note

This utility is available beginning in Orange Logic Milan.

Request parameter

This parameter is identical to the request parameter of the Export to S3 utility.

Response parameter

Structure 
{
  "Response": {
    "Results": [
     {
        "AP_RecordID": "X2KAP000000166033" // empty if failed
      }
    ],
    "Message": "Schedule Export to S3 success for asset <recordid> and bucket <bucketname>”
  },
  "HTTPCode": -1,
  "Code": <SUCCESS | FAIL>
}
Example 
var response = Utils.ScheduleExportToS3(
        // Record ID
        '2Y8V7CB92PR',
        // Format
        'TRX',
        // Email for receiving response email, separate by ,
        [],
        // Bucket information
        {
            BucketName: 'testBucket', // Required
            AWSRegion: 'ap-southeast-2', // Required
            Path: '2Y8V7CB92PR.mp4', // Required
            CredentialType: 'IAMUser', // Required. (IAMUser | STSDefault | Passthrough)
            AccessKeyID: '[Secrets.2Y8VTW5MLW9-AccessKeyID]',
            SecretAccessKey: '[Secrets.2Y8VTW5MDC8-SecretAccessKey]',
            KMSEncryptionKeyID: '',
            CannedACL: '',
        }
    );
Example response 
{
  "Response": {
    "Results": [
      {
        "AP_RecordID": "X2KAP000000166033" // empty if failed
      }
    ],
    "Message": "Schedule Export to S3 success for asset <recordid> and bucket <bucketname>"
  },
  "HTTPCode": -1,
  "Code": "SUCCESS"
}

Updated 13 days ago