External S3 Compositions
Contents
URI Schemes
These are the URI schemes for the Composition Settings REST API and the supported methods:
/v1/CompositionSettings/DefaultGET: 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:
https://video.twilio.com/v1/CompositionSettings/Default
Resource Properties
A CompositionSettings resource has the following properties:
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that created the CompositionSettings resource. |
friendly_name
|
The string that you assigned to describe the resource and that will be shown in the console |
aws_credentials_sid
|
The SID of the stored Credential resource. |
aws_s3_url
|
The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like |
aws_storage_enabled
|
Whether all compositions are written to the |
encryption_key_sid
|
The SID of the Public Key resource used for encryption. |
encryption_enabled
|
Whether all compositions are stored in an encrypted form. The default is |
url
|
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_sidencryption_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:
HTTP POST: Set Settings
Sets your account's default Composition Settings. POST requests support the following parameters:
| Parameters in REST API format | |
|---|---|
friendly_name
Required
|
A descriptive string that you create to describe the resource and show to the user in the console |
aws_credentials_sid
Optional
|
The SID of the stored Credential resource. |
encryption_key_sid
Optional
|
The SID of the Public Key resource to use for encryption. |
aws_s3_url
Optional
|
The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like |
aws_storage_enabled
Optional
|
Whether all compositions should be written to the |
encryption_enabled
Optional
|
Whether all compositions should be stored in an encrypted form. The default is |
In the table above, the following parameters are reserved for the feature called Encrypted Compositions:
EncryptionKeySidEncryptionEnabled
If you have an interest in activating Encrypted Compositions and enable the use of these parameters in you 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:
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.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
