AWS CLI

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to AWS_CLI.
execute_commands
Required
String[]The commands that will be executed.
region
Required
StringThe Amazon S3 region.
integration
Required
IntegrationThe integration.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "Run AWS command",
"type": "AWS_CLI",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"execute_commands": [
"aws lambda $command"
],
"variables": [
{
"key": "command",
"value": "list-functions"
}
],
"integration": {
"id": 33
},
"region": "us-west-2"
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
"id": 2,
"name": "Run AWS command",
"type": "AWS_CLI",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"last_execution_status": "INITIAL",
"execute_commands": [
"aws lambda $command"
],
"variables": [
{
"key": "command",
"value": "list-functions"
}
],
"integration": {
"id": 33
},
"region": "us-west-2",
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "Live mirror",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}