Skip to content

Updates a scheduled action

Description

Updates a scheduled action.

Usage

redshiftserverless_update_scheduled_action(enabled, endTime, roleArn,
  schedule, scheduledActionDescription, scheduledActionName, startTime,
  targetAction)

Arguments

  • enabled

    Specifies whether to enable the scheduled action.

  • endTime

    The end time in UTC of the scheduled action to update.

  • roleArn

    The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (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 Management Guide

  • schedule

    The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

    • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
    • Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

  • scheduledActionDescription

    The descripion of the scheduled action to update to.

  • scheduledActionName

    [required] The name of the scheduled action to update to.

  • startTime

    The start time in UTC of the scheduled action to update to.

  • targetAction

    A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

    "{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

Value

A list with the following syntax:

list(
  scheduledAction = list(
    endTime = as.POSIXct(
      "2015-01-01"
    ),
    namespaceName = "string",
    nextInvocations = list(
      as.POSIXct(
        "2015-01-01"
      )
    ),
    roleArn = "string",
    schedule = list(
      at = as.POSIXct(
        "2015-01-01"
      ),
      cron = "string"
    ),
    scheduledActionDescription = "string",
    scheduledActionName = "string",
    scheduledActionUuid = "string",
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    state = "ACTIVE"|"DISABLED",
    targetAction = list(
      createSnapshot = list(
        namespaceName = "string",
        retentionPeriod = 123,
        snapshotNamePrefix = "string",
        tags = list(
          list(
            key = "string",
            value = "string"
          )
        )
      )
    )
  )
)

Request syntax

svc$update_scheduled_action(
  enabled = TRUE|FALSE,
  endTime = as.POSIXct(
    "2015-01-01"
  ),
  roleArn = "string",
  schedule = list(
    at = as.POSIXct(
      "2015-01-01"
    ),
    cron = "string"
  ),
  scheduledActionDescription = "string",
  scheduledActionName = "string",
  startTime = as.POSIXct(
    "2015-01-01"
  ),
  targetAction = list(
    createSnapshot = list(
      namespaceName = "string",
      retentionPeriod = 123,
      snapshotNamePrefix = "string",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  )
)