Skip to content Skip to navigation Skip to topbar

On this page

External S3 Compositions

URI Schemes

These are the URI schemes for the Composition Settings REST API and the supported methods:

/v1/CompositionSettings/Default
- GET: Retrieves current Composition Settings.
- POST: Updates the Composition Settings.

Composition Settings instance resource

The Default CompositionSettings resource holds the default composition settings for the given Twilio account (or project). Its configuration will be applied to all Recording Compositions created in such account (or project).

Base URL

The Compositions Settings default resource is located at the following Base URL:

1https://video.twilio.com/v1/CompositionSettings/Default
2

Resource Properties

A CompositionSettings resource has the following properties:

Property nameTypeRequiredDescriptionChild properties

account_sidSID<AC>

Optional

Not PII

The SID of the Account that created the CompositionSettings resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

friendly_namestring

Optional

Not PII

The string that you assigned to describe the resource and that will be shown in the console

aws_credentials_sidSID<CR>

Optional

Not PII

The SID of the stored Credential resource.

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34

aws_s3_urlstring<uri>

Optional

Not PII

The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like https://documentation-example-twilio-bucket/compositions, where compositions is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986.

aws_storage_enabledboolean

Optional

Not PII

Whether all compositions are written to the aws_s3_url. When false, all compositions are stored in our cloud.

encryption_key_sidSID<CR>

Optional

Not PII

The SID of the Public Key resource used for encryption.

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34

encryption_enabledboolean

Optional

Not PII

Whether all compositions are stored in an encrypted form. The default is false.

urlstring<uri>

Optional

Not PII

The absolute URL of the resource.

Overview

The Twilio Composition Settings REST API lets you configure Twilio to store your compositions in an external AWS S3 bucket. Composition Settings work per-account (i.e. project). If you activate external S3 storage, all Video Compositions in your account (or project) will be stored in the specified external bucket.

This document contains reference information about the Composition Settings REST API for external S3 storage. For a step-by-step guide you can also read the Storing into AWS S3 developer guide

In the table above, the following properties are reserved for the feature called Encrypted Compositions:

encryption_key_sid
encryption_enabled

If you have an interest in activating Encrypted Compositions in you account, please contact the Twilio Support Service.

HTTP GET: Get Settings

Retrieves your account's default Composition Settings.

For example:

Fetch Composition Settings

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchCompositionSettings() {
11  const compositionSetting = await client.video.compositionSettings().fetch();
12
13  console.log(compositionSetting.accountSid);
14}
15
16fetchCompositionSettings();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "friendly_name": "string",
4  "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/",
7  "aws_storage_enabled": true,
8  "encryption_enabled": true,
9  "url": "https://video.twilio.com/v1/CompositionSettings/Default"
10}

HTTP POST: Set Settings

Sets your account's default Composition Settings. POST requests support the following parameters:

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

FriendlyNamestringrequired

Not PII

A descriptive string that you create to describe the resource and show to the user in the console

AwsCredentialsSidSID<CR>

Optional

Not PII

The SID of the stored Credential resource.

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34

EncryptionKeySidSID<CR>

Optional

Not PII

The SID of the Public Key resource to use for encryption.

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34

AwsS3Urlstring<uri>

Optional

Not PII

The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like https://documentation-example-twilio-bucket/compositions, where compositions is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986.

AwsStorageEnabledboolean

Optional

Not PII

Whether all compositions should be written to the aws_s3_url. When false, all compositions are stored in our cloud.

EncryptionEnabledboolean

Optional

Not PII

Whether all compositions should be stored in an encrypted form. The default is false.

In the table above, the following parameters are reserved for the feature called Encrypted Compositions:

EncryptionKeySid
EncryptionEnabled

If you have an interest in activating Encrypted Compositions and enable the use of these parameters in your account, please contact the Twilio Support Service.

Enabling external S3 storage for Compositions

The following code snippet illustrate how you can set your Compositions to be stored in an external S3 bucket:

Create or update the configuration to upload to an external S3 bucket

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createCompositionSettings() {
11  const compositionSetting = await client.video.compositionSettings().create({
12    awsCredentialsSid: "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
13    awsS3Url: "https://my-bucket.s3.amazonaws.com/recordings",
14    awsStorageEnabled: true,
15    friendlyName: "Upload to external bucket",
16  });
17
18  console.log(compositionSetting.accountSid);
19}
20
21createCompositionSettings();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "friendly_name": "Upload to external bucket",
4  "aws_credentials_sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
5  "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "aws_s3_url": "https://my-bucket.s3.amazonaws.com/recordings",
7  "aws_storage_enabled": true,
8  "encryption_enabled": true,
9  "url": "https://video.twilio.com/v1/CompositionSettings/Default"
10}

Disabling external S3 storage for Compositions

To stop storing compositions in an AWS S3 Bucket by default, you can create a new default configuration with AWS storage disabled. If you disable external AWS S3 storage, compositions will be stored in the Twilio cloud.

Disable external S3 storage for Compositions

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createCompositionSettings() {
11  const compositionSetting = await client.video.compositionSettings().create({
12    awsStorageEnabled: false,
13    friendlyName: "Resetting default configuration",
14  });
15
16  console.log(compositionSetting.accountSid);
17}
18
19createCompositionSettings();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "friendly_name": "Resetting default configuration",
4  "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/",
7  "aws_storage_enabled": false,
8  "encryption_enabled": true,
9  "url": "https://video.twilio.com/v1/CompositionSettings/Default"
10}

External S3 Compositions

Contents

URI Schemes

Composition Settings instance resource

Base URL

Resource Properties

Overview

HTTP GET: Get Settings

Output

HTTP POST: Set Settings

Request body parameters

Enabling external S3 storage for Compositions

Output

Disabling external S3 storage for Compositions

Output