Build
Builds are packages of Functions and Assets that you bundle together for deployment. Builds contain Function Version SIDs, Asset Version SIDs, and Dependencies.
Dependencies are defined as JSON strings, for example:
'[{"name": "randomcolor","version":"0.5.4" },
{"name": "util","version":"0.10.3" },
{"name": "xmldom","version":"0.1.27" },
{"name": "got","version":"6.7.1" },
{"name": "fs","version":"0.0.1-security" },
{"name": "lodash","version":"4.17.11" },
{"name": "date-fns","version":"1.30.1" }]'Builds take time to package, deploy, and be verified. After creating a Build, it is best to poll every second to check the Build's status. When a Build is verified, it is ready to be used in a Deployment.
List of Build statuses
|
Build status |
Meaning |
|---|---|
Building |
Build request is being processed by the packager. |
Completed |
We have run a health check on the uploaded package and verified it. |
Failed |
Packaging has failed at any of the above steps. |
Build properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the Build resource. |
account_sid
|
The SID of the Account that created the Build resource. |
service_sid
|
The SID of the Service that the Build resource is associated with. |
status
|
The status of the Build. Can be: |
asset_versions
|
The list of Asset Version resource SIDs that are included in the Build. |
function_versions
|
The list of Function Version resource SIDs that are included in the Build. |
dependencies
|
A list of objects that describe the Dependencies included in the Build. Each object contains the |
runtime
|
The Runtime version that will be used to run the Build resource when it is deployed. |
date_created
|
The date and time in GMT when the Build resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the Build resource was last updated specified in ISO 8601 format. |
url
|
The absolute URL of the Build resource. |
links
|
|
Create a Build resource
https://serverless.twilio.com/v1/Services/{ServiceSid}/Builds
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to create the Build resource under. |
asset_versions
Optional
|
The list of Asset Version resource SIDs to include in the Build. |
function_versions
Optional
|
The list of the Function Version resource SIDs to include in the Build. |
dependencies
Optional
|
A list of objects that describe the Dependencies included in the Build. Each object contains the |
runtime
Optional
|
The Runtime version that will be used to run the Build resource when it is deployed. |
You must specify all Function or Asset Versions when creating a Build. Builds only use the provided Versions, and do not reference the Versions used by previous Builds.
In order to create a Build successfully, your request must include at least one Function Version, Asset Version, or a combination of both.
If no Function or Asset Versions are indicated, you'll receive Error 20001:
At least one Function Version or Asset Version is required for Build
Example 1
Example 2
Example 3
Fetch a Build resource
https://serverless.twilio.com/v1/Services/{ServiceSid}/Builds/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to fetch the Build resource from. |
sid
Path
|
The SID of the Build resource to fetch. |
Example 1
Read multiple Build resources
https://serverless.twilio.com/v1/Services/{ServiceSid}/Builds
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to read the Build resources from. |
Example 1
Delete a Build resource
https://serverless.twilio.com/v1/Services/{ServiceSid}/Builds/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service to delete the Build resource from. |
sid
Path
|
The SID of the Build resource to delete. |
Example 1
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.
