GET

/#Action=CreateScheduledAction

http://redshift.{region}.amazonaws.com/#Action=CreateScheduledAction

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the <code>ResizeCluster</code> API operation.

Access Token Required: API Key

Query Params

ScheduledActionNamestringrequired

The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see <a>ScheduledAction</a>.

TargetActionobjectrequired

A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see <a>ScheduledAction</a>.

Schedulestringrequired

The schedule in <code>at( )</code> or <code>cron( )</code> format. For more information about this parameter, see <a>ScheduledAction</a>.

IamRolestringrequired

The IAM role to assume to run the target action. For more information about this parameter, see <a>ScheduledAction</a>.

ScheduledActionDescriptionstring

The description of the scheduled action.

StartTimestring

The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see <a>ScheduledAction</a>.

EndTimestring

The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see <a>ScheduledAction</a>.

Enableboolean

If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about <code>state</code> of the scheduled action, see <a>ScheduledAction</a>.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://redshift.{region}.amazonaws.com/#Action=CreateScheduledAction' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}