Module Values.ScheduledActionSource

Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType.

Sourcetype createScheduledActionResult = {
  1. scheduledActionName : String_.t option;
    (*

    The name of the scheduled action.

    *)
  2. targetAction : ScheduledActionType.t option;
    (*

    A JSON format string of the Amazon Redshift API operation with input parameters. "{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

    *)
  3. schedule : String_.t option;
    (*

    The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)". Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

    *)
  4. iamRole : String_.t option;
    (*

    The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    *)
  5. scheduledActionDescription : String_.t option;
    (*

    The description of the scheduled action.

    *)
  6. state : ScheduledActionState.t option;
    (*

    The state of the scheduled action. For example, DISABLED.

    *)
  7. nextInvocations : ScheduledActionTimeList.t option;
    (*

    List of times when the scheduled action will run.

    *)
  8. startTime : TStamp.t option;
    (*

    The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

    *)
  9. endTime : TStamp.t option;
    (*

    The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

    *)
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. createScheduledActionResult : createScheduledActionResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `ClusterNotFoundFault of ClusterNotFoundFault.t
  2. | `InvalidScheduleFault of InvalidScheduleFault.t
  3. | `InvalidScheduledActionFault of InvalidScheduledActionFault.t
  4. | `ScheduledActionAlreadyExistsFault of ScheduledActionAlreadyExistsFault.t
  5. | `ScheduledActionQuotaExceededFault of ScheduledActionQuotaExceededFault.t
  6. | `ScheduledActionTypeUnsupportedFault of ScheduledActionTypeUnsupportedFault.t
  7. | `UnauthorizedOperation of UnauthorizedOperation.t
  8. | `UnsupportedOperationFault of UnsupportedOperationFault.t
  9. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?scheduledActionName:??? -> ?targetAction:??? -> ?schedule:??? -> ?iamRole:??? -> ?scheduledActionDescription:??? -> ?state:??? -> ?nextInvocations:??? -> ?startTime:??? -> ?endTime:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ClusterNotFoundFault of unit | `InvalidScheduleFault of unit | `InvalidScheduledActionFault of unit | `ScheduledActionAlreadyExistsFault of unit | `ScheduledActionQuotaExceededFault of unit | `ScheduledActionTypeUnsupportedFault of unit | `UnauthorizedOperation of unit | `Unknown_operation_error of string * string option | `UnsupportedOperationFault of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ClusterNotFoundFault of unit | `InvalidScheduleFault of unit | `InvalidScheduledActionFault of unit | `ScheduledActionAlreadyExistsFault of unit | `ScheduledActionQuotaExceededFault of unit | `ScheduledActionTypeUnsupportedFault of unit | `UnauthorizedOperation of unit | `Unknown_operation_error of string * string option | `UnsupportedOperationFault of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `List of [> `Timestamp of TStamp.t ] list | `String of String_.t | `Structure of (string * [> `Structure of (string * [> `Boolean of BooleanOptional.t | `Integer of IntegerOptional.t | `String of String_.t ]) list ]) list | `Timestamp of TStamp.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t