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

Class: Aws::AutoScaling::Types::DescribeScheduledActionsType

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

Overview

Note:

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

{
  auto_scaling_group_name: "ResourceName",
  scheduled_action_names: ["ResourceName"],
  start_time: Time.now,
  end_time: Time.now,
  next_token: "XmlString",
  max_records: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


1776
1777
1778
1779
1780
1781
1782
1783
1784
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1776

class DescribeScheduledActionsType < Struct.new(
  :auto_scaling_group_name,
  :scheduled_action_names,
  :start_time,
  :end_time,
  :next_token,
  :max_records)
  include Aws::Structure
end

#end_timeTime

The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

Returns:

  • (Time)


1776
1777
1778
1779
1780
1781
1782
1783
1784
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1776

class DescribeScheduledActionsType < Struct.new(
  :auto_scaling_group_name,
  :scheduled_action_names,
  :start_time,
  :end_time,
  :next_token,
  :max_records)
  include Aws::Structure
end

#max_recordsInteger

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Returns:

  • (Integer)


1776
1777
1778
1779
1780
1781
1782
1783
1784
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1776

class DescribeScheduledActionsType < Struct.new(
  :auto_scaling_group_name,
  :scheduled_action_names,
  :start_time,
  :end_time,
  :next_token,
  :max_records)
  include Aws::Structure
end

#next_tokenString

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (String)


1776
1777
1778
1779
1780
1781
1782
1783
1784
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1776

class DescribeScheduledActionsType < Struct.new(
  :auto_scaling_group_name,
  :scheduled_action_names,
  :start_time,
  :end_time,
  :next_token,
  :max_records)
  include Aws::Structure
end

#scheduled_action_namesArray<String>

Describes one or more scheduled actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

You can describe up to a maximum of 50 instances with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token.

Returns:

  • (Array<String>)


1776
1777
1778
1779
1780
1781
1782
1783
1784
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1776

class DescribeScheduledActionsType < Struct.new(
  :auto_scaling_group_name,
  :scheduled_action_names,
  :start_time,
  :end_time,
  :next_token,
  :max_records)
  include Aws::Structure
end

#start_timeTime

The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

Returns:

  • (Time)


1776
1777
1778
1779
1780
1781
1782
1783
1784
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1776

class DescribeScheduledActionsType < Struct.new(
  :auto_scaling_group_name,
  :scheduled_action_names,
  :start_time,
  :end_time,
  :next_token,
  :max_records)
  include Aws::Structure
end