Skeddly API
Search
K
Comment on page

Action Object

Description

Represents an action.

Properties

actionId

ID of the action.
Type: string

actionType

Type ID of the action.
Type: string

actionVersionId

Version ID of the action.
Type: string

comments

User notes for the action.
Type: string

displayData

General purpose display data. This will only be populated when requested.
Type: object

lastExection

Action execution data for the last execution of this action. This will only be populated when requested.
Type: ActionExecution object.

isCurrentVersion

True if the action version is the latest.
Type: boolean

isEnabled

True if the action is enabled to execute. False otherwise.
Type: boolean

lastModifiedBy

ID of the user whom last modified the action.
Type: string

lastModifiedDate

Date, in ISO 8601 format, at which the action was last modified.
Type: string

managedInstanceId

ID of the Managed Instance to which this action belongs.
Type: string

name

Name of the action.
Type: string

nextExecutionDate

Date, in ISO 8601 format, at which the action will next execute.
Type: string

parameters

Additional action parameters specific to the action type. This will only be populated when requested.
Type: ActionParameters object.

projectId

ID of the project in which the action resides.
Type: string

runningCount

Number of currently running executions of this action. This will only be populated when requested.
Type: integer

schedule

Schedule for the action.
Type: ActionSchedule object

snsEndpoint

SNS endpoint to trigger the action.
Type: string

tags

Tags for the action.
Type: array of string

Sample JSON

{
"actionId": "a-00000001",
"actionType": "amazon-start-ec2-instances",
"actionVersionId": "av-00000001",
"comments": "Comments about this action",
"isCurrentVersion": true,
"isEnabled": true,
"lastModifiedBy": "u-00000001",
"lastModifiedDate": "2016-06-09T12:21:00Z",
"managedInstanceId": "mi-00000001",
"name": "Start My Instances",
"nextExecutionDate": "2016-06-10T12:23:00Z",
"projectId": "proj-00000001",
"schedule": {
"scheduleType": "daily",
"startDate": "2016-06-10",
"timeOfDay": "12:23:00",
"timeZoneId": "Eastern Standard Time",
"parameters": {
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
]
}
},
"tags": [
"cost-reduction"
]
}