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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Note:

When making an API call, you may pass DescribeScheduledActionsMessage data as a hash:

{
  scheduled_action_name: "String",
  target_action_type: "ResizeCluster", # accepts ResizeCluster
  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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#activeBoolean

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

Returns:

  • (Boolean)


4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4378

class DescribeScheduledActionsMessage < Struct.new(
  :scheduled_action_name,
  :target_action_type,
  :start_time,
  :end_time,
  :active,
  :filters,
  :marker,
  :max_records)
  include Aws::Structure
end

#end_timeTime

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)


4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4378

class DescribeScheduledActionsMessage < Struct.new(
  :scheduled_action_name,
  :target_action_type,
  :start_time,
  :end_time,
  :active,
  :filters,
  :marker,
  :max_records)
  include Aws::Structure
end

#filtersArray<Types::ScheduledActionFilter>

List of scheduled action filters.

Returns:



4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4378

class DescribeScheduledActionsMessage < Struct.new(
  :scheduled_action_name,
  :target_action_type,
  :start_time,
  :end_time,
  :active,
  :filters,
  :marker,
  :max_records)
  include Aws::Structure
end

#markerString

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)


4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4378

class DescribeScheduledActionsMessage < Struct.new(
  :scheduled_action_name,
  :target_action_type,
  :start_time,
  :end_time,
  :active,
  :filters,
  :marker,
  :max_records)
  include Aws::Structure
end

#max_recordsInteger

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)


4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4378

class DescribeScheduledActionsMessage < Struct.new(
  :scheduled_action_name,
  :target_action_type,
  :start_time,
  :end_time,
  :active,
  :filters,
  :marker,
  :max_records)
  include Aws::Structure
end

#scheduled_action_nameString

The name of the scheduled action to retrieve.

Returns:

  • (String)


4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4378

class DescribeScheduledActionsMessage < Struct.new(
  :scheduled_action_name,
  :target_action_type,
  :start_time,
  :end_time,
  :active,
  :filters,
  :marker,
  :max_records)
  include Aws::Structure
end

#start_timeTime

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)


4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4378

class DescribeScheduledActionsMessage < Struct.new(
  :scheduled_action_name,
  :target_action_type,
  :start_time,
  :end_time,
  :active,
  :filters,
  :marker,
  :max_records)
  include Aws::Structure
end

#target_action_typeString

The type of the scheduled actions to retrieve.

Returns:

  • (String)


4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4378

class DescribeScheduledActionsMessage < Struct.new(
  :scheduled_action_name,
  :target_action_type,
  :start_time,
  :end_time,
  :active,
  :filters,
  :marker,
  :max_records)
  include Aws::Structure
end