Describe Scheduled Actions

redshift_describe_scheduled_actions

R Documentation

Describes properties of scheduled actions

Description

Describes properties of scheduled actions.

Usage

redshift_describe_scheduled_actions(ScheduledActionName,
  TargetActionType, StartTime, EndTime, Active, Filters, Marker,
  MaxRecords)

Arguments

ScheduledActionName

The name of the scheduled action to retrieve.

TargetActionType

The type of the scheduled actions to retrieve.

StartTime

The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

EndTime

The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

Active

If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

Filters

List of scheduled action filters.

Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a describe_scheduled_actions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Value

A list with the following syntax:

list(
  Marker = "string",
  ScheduledActions = list(
    list(
      ScheduledActionName = "string",
      TargetAction = list(
        ResizeCluster = list(
          ClusterIdentifier = "string",
          ClusterType = "string",
          NodeType = "string",
          NumberOfNodes = 123,
          Classic = TRUE|FALSE,
          ReservedNodeId = "string",
          TargetReservedNodeOfferingId = "string"
        ),
        PauseCluster = list(
          ClusterIdentifier = "string"
        ),
        ResumeCluster = list(
          ClusterIdentifier = "string"
        )
      ),
      Schedule = "string",
      IamRole = "string",
      ScheduledActionDescription = "string",
      State = "ACTIVE"|"DISABLED",
      NextInvocations = list(
        as.POSIXct(
          "2015-01-01"
        )
      ),
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$describe_scheduled_actions(
  ScheduledActionName = "string",
  TargetActionType = "ResizeCluster"|"PauseCluster"|"ResumeCluster",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Active = TRUE|FALSE,
  Filters = list(
    list(
      Name = "cluster-identifier"|"iam-role",
      Values = list(
        "string"
      )
    )
  ),
  Marker = "string",
  MaxRecords = 123
)