You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Redshift::Types::DescribeScheduledActionsMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeScheduledActionsMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  scheduled_action_name: "String",
  target_action_type: "ResizeCluster", # accepts ResizeCluster, PauseCluster, ResumeCluster
  start_time: Time.now,
  end_time: Time.now,
  active: false,
  filters: [
    {
      name: "cluster-identifier", # required, accepts cluster-identifier, iam-role
      values: ["String"], # required
    },
  ],
  marker: "String",
  max_records: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#active ⇒ Boolean

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

Returns:

  • (Boolean) —

    If true, retrieve only active scheduled actions.

#end_time ⇒ Time

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

Returns:

  • (Time) —

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

#filters ⇒ Array<Types::ScheduledActionFilter>

List of scheduled action filters.

Returns:

#marker ⇒ String

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, AWS 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.

Returns:

  • (String) —

    An optional parameter that specifies the starting point to return a set of response records.

#max_records ⇒ Integer

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.

Returns:

  • (Integer) —

    The maximum number of response records to return in each call.

#scheduled_action_name ⇒ String

The name of the scheduled action to retrieve.

Returns:

  • (String) —

    The name of the scheduled action to retrieve.

#start_time ⇒ Time

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

Returns:

  • (Time) —

    The start time in UTC of the scheduled actions to retrieve.

#target_action_type ⇒ String

The type of the scheduled actions to retrieve.

Possible values:

  • ResizeCluster
  • PauseCluster
  • ResumeCluster

Returns:

  • (String) —

    The type of the scheduled actions to retrieve.