Class: AWS::AutoScaling::Client

Inherits:
Core::Client show all
Extended by:
Core::Client::QueryXML
Defined in:
lib/aws/auto_scaling/client.rb

Overview

Client class for Auto Scaling.

Constant Summary collapse

API_VERSION =
'2011-01-01'
CACHEABLE_REQUESTS =
Set[
  :describe_adjustment_types,
  :describe_auto_scaling_groups,
  :describe_auto_scaling_instances,
  :describe_auto_scaling_notification_types,
  :describe_launch_configurations,
  :describe_metric_collection_types,
  :describe_notification_configurations,
  :describe_policies,
  :describe_scaling_activities,
  :describe_scaling_process_types,
  :describe_scheduled_actions,
  :describe_tags,
]

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #endpoint, #port, #service_ruby_name, #signer

Instance Method Summary collapse

Methods included from Core::Client::QueryXML

extended, option_parsers, xml_parsers

Methods inherited from Core::Client

#initialize, #new_stub_for, #operations, #stub_for, #with_config, #with_http_handler, #with_options

Methods included from Core::Naming

#service_name, #service_ruby_name

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#create_auto_scaling_group(options = {}) ⇒ Core::Response

Calls the CreateAutoScalingGroup API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :launch_configuration_name - required - (String)

  • :min_size - required - (Integer)

  • :max_size - required - (Integer)

  • :desired_capacity - (Integer)

  • :default_cooldown - (Integer)

  • :availability_zones - required - (Array<String>)

  • :load_balancer_names - (Array<String>)

  • :health_check_type - (String)

  • :health_check_grace_period - (Integer)

  • :placement_group - (String)

  • :vpc_zone_identifier - (String)

  • :tags - (Array<Hash>)

    • :resource_id - (String)

    • :resource_type - (String)

    • :key - required - (String)

    • :value - (String)

    • :propagate_at_launch - (Boolean)

Response Structure:

This method returns no response data.

Returns:


72
# File 'lib/aws/auto_scaling/client.rb', line 72

define_client_method :create_auto_scaling_group, 'CreateAutoScalingGroup'

#create_launch_configuration(options = {}) ⇒ Core::Response

Calls the CreateLaunchConfiguration API operation.

Options:

  • :launch_configuration_name - required - (String)

  • :image_id - required - (String)

  • :key_name - (String)

  • :security_groups - (Array<String>)

  • :user_data - (String)

  • :instance_type - required - (String)

  • :kernel_id - (String)

  • :ramdisk_id - (String)

  • :block_device_mappings - (Array<Hash>)

    • :virtual_name - (String)

    • :device_name - required - (String)

    • :ebs - (Hash)

      • :snapshot_id - (String)

      • :volume_size - (Integer)

  • :instance_monitoring - (Hash)

    • :enabled - (Boolean)

Response Structure:

This method returns no response data.

Returns:


102
# File 'lib/aws/auto_scaling/client.rb', line 102

define_client_method :create_launch_configuration, 'CreateLaunchConfiguration'

#create_or_update_tags(options = {}) ⇒ Core::Response

Calls the CreateOrUpdateTags API operation.

Options:

  • :tags - required - (Array<Hash>)

    • :resource_id - (String)

    • :resource_type - (String)

    • :key - required - (String)

    • :value - (String)

    • :propagate_at_launch - (Boolean)

Response Structure:

This method returns no response data.

Returns:


122
# File 'lib/aws/auto_scaling/client.rb', line 122

define_client_method :create_or_update_tags, 'CreateOrUpdateTags'

#delete_auto_scaling_group(options = {}) ⇒ Core::Response

Calls the DeleteAutoScalingGroup API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :force_delete - (Boolean)

Response Structure:

This method returns no response data.

Returns:


138
# File 'lib/aws/auto_scaling/client.rb', line 138

define_client_method :delete_auto_scaling_group, 'DeleteAutoScalingGroup'

#delete_launch_configuration(options = {}) ⇒ Core::Response

Calls the DeleteLaunchConfiguration API operation.

Options:

  • :launch_configuration_name - required - (String)

Response Structure:

This method returns no response data.

Returns:


153
# File 'lib/aws/auto_scaling/client.rb', line 153

define_client_method :delete_launch_configuration, 'DeleteLaunchConfiguration'

#delete_notification_configuration(options = {}) ⇒ Core::Response

Calls the DeleteNotificationConfiguration API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :topic_arn - required - (String)

Response Structure:

This method returns no response data.

Returns:


169
# File 'lib/aws/auto_scaling/client.rb', line 169

define_client_method :delete_notification_configuration, 'DeleteNotificationConfiguration'

#delete_policy(options = {}) ⇒ Core::Response

Calls the DeletePolicy API operation.

Options:

  • :auto_scaling_group_name - (String)

  • :policy_name - required - (String)

Response Structure:

This method returns no response data.

Returns:


185
# File 'lib/aws/auto_scaling/client.rb', line 185

define_client_method :delete_policy, 'DeletePolicy'

#delete_scheduled_action(options = {}) ⇒ Core::Response

Calls the DeleteScheduledAction API operation.

Options:

  • :auto_scaling_group_name - (String)

  • :scheduled_action_name - required - (String)

Response Structure:

This method returns no response data.

Returns:


201
# File 'lib/aws/auto_scaling/client.rb', line 201

define_client_method :delete_scheduled_action, 'DeleteScheduledAction'

#delete_tags(options = {}) ⇒ Core::Response

Calls the DeleteTags API operation.

Options:

  • :tags - required - (Array<Hash>)

    • :resource_id - (String)

    • :resource_type - (String)

    • :key - required - (String)

    • :value - (String)

    • :propagate_at_launch - (Boolean)

Response Structure:

This method returns no response data.

Returns:


221
# File 'lib/aws/auto_scaling/client.rb', line 221

define_client_method :delete_tags, 'DeleteTags'

#describe_adjustment_types(options = {}) ⇒ Core::Response

Calls the DescribeAdjustmentTypes API operation.

Options:

This method accepts no options.

Response Structure:

  • :adjustment_types - (Array<Hash>)

    • :adjustment_type - (String)

Returns:


237
# File 'lib/aws/auto_scaling/client.rb', line 237

define_client_method :describe_adjustment_types, 'DescribeAdjustmentTypes'

#describe_auto_scaling_groups(options = {}) ⇒ Core::Response

Calls the DescribeAutoScalingGroups API operation.

Options:

  • :auto_scaling_group_names - (Array<String>)

  • :next_token - (String)

  • :max_records - (Integer)

Response Structure:

  • :auto_scaling_groups - (Array<Hash>)

    • :auto_scaling_group_name - (String)

    • :auto_scaling_group_arn - (String)

    • :launch_configuration_name - (String)

    • :min_size - (Integer)

    • :max_size - (Integer)

    • :desired_capacity - (Integer)

    • :default_cooldown - (Integer)

    • :availability_zones - (Array<String>)

    • :load_balancer_names - (Array<String>)

    • :health_check_type - (String)

    • :health_check_grace_period - (Integer)

    • :instances - (Array<Hash>)

      • :instance_id - (String)

      • :availability_zone - (String)

      • :lifecycle_state - (String)

      • :health_status - (String)

      • :launch_configuration_name - (String)

    • :created_time - (Time)

    • :suspended_processes - (Array<Hash>)

      • :process_name - (String)

      • :suspension_reason - (String)

    • :placement_group - (String)

    • :vpc_zone_identifier - (String)

    • :enabled_metrics - (Array<Hash>)

      • :metric - (String)

      • :granularity - (String)

    • :status - (String)

    • :tags - (Array<Hash>)

      • :resource_id - (String)

      • :resource_type - (String)

      • :key - (String)

      • :value - (String)

      • :propagate_at_launch - (Boolean)

  • :next_token - (String)

Returns:


288
# File 'lib/aws/auto_scaling/client.rb', line 288

define_client_method :describe_auto_scaling_groups, 'DescribeAutoScalingGroups'

#describe_auto_scaling_instances(options = {}) ⇒ Core::Response

Calls the DescribeAutoScalingInstances API operation.

Options:

  • :instance_ids - (Array<String>)

  • :max_records - (Integer)

  • :next_token - (String)

Response Structure:

  • :auto_scaling_instances - (Array<Hash>)

    • :instance_id - (String)

    • :auto_scaling_group_name - (String)

    • :availability_zone - (String)

    • :lifecycle_state - (String)

    • :health_status - (String)

    • :launch_configuration_name - (String)

  • :next_token - (String)

Returns:


312
# File 'lib/aws/auto_scaling/client.rb', line 312

define_client_method :describe_auto_scaling_instances, 'DescribeAutoScalingInstances'

#describe_auto_scaling_notification_types(options = {}) ⇒ Core::Response

Calls the DescribeAutoScalingNotificationTypes API operation.

Options:

This method accepts no options.

Response Structure:

  • :auto_scaling_notification_types - (Array<String>)

Returns:


327
# File 'lib/aws/auto_scaling/client.rb', line 327

define_client_method :describe_auto_scaling_notification_types, 'DescribeAutoScalingNotificationTypes'

#describe_launch_configurations(options = {}) ⇒ Core::Response

Calls the DescribeLaunchConfigurations API operation.

Options:

  • :launch_configuration_names - (Array<String>)

  • :next_token - (String)

  • :max_records - (Integer)

Response Structure:

  • :launch_configurations - (Array<Hash>)

    • :launch_configuration_name - (String)

    • :launch_configuration_arn - (String)

    • :image_id - (String)

    • :key_name - (String)

    • :security_groups - (Array<String>)

    • :user_data - (String)

    • :instance_type - (String)

    • :kernel_id - (String)

    • :ramdisk_id - (String)

    • :block_device_mappings - (Array<Hash>)

      • :virtual_name - (String)

      • :device_name - (String)

      • :ebs - (Hash)

        • :snapshot_id - (String)

        • :volume_size - (Integer)

    • :instance_monitoring - (Hash)

      • :enabled - (Boolean)

    • :created_time - (Time)

  • :next_token - (String)

Returns:


363
# File 'lib/aws/auto_scaling/client.rb', line 363

define_client_method :describe_launch_configurations, 'DescribeLaunchConfigurations'

#describe_metric_collection_types(options = {}) ⇒ Core::Response

Calls the DescribeMetricCollectionTypes API operation.

Options:

This method accepts no options.

Response Structure:

  • :metrics - (Array<Hash>)

    • :metric - (String)

  • :granularities - (Array<Hash>)

    • :granularity - (String)

Returns:


381
# File 'lib/aws/auto_scaling/client.rb', line 381

define_client_method :describe_metric_collection_types, 'DescribeMetricCollectionTypes'

#describe_notification_configurations(options = {}) ⇒ Core::Response

Calls the DescribeNotificationConfigurations API operation.

Options:

  • :auto_scaling_group_names - (Array<String>)

  • :next_token - (String)

  • :max_records - (Integer)

Response Structure:

  • :notification_configurations - (Array<Hash>)

    • :auto_scaling_group_name - (String)

    • :topic_arn - (String)

    • :notification_type - (String)

  • :next_token - (String)

Returns:


402
# File 'lib/aws/auto_scaling/client.rb', line 402

define_client_method :describe_notification_configurations, 'DescribeNotificationConfigurations'

#describe_policies(options = {}) ⇒ Core::Response

Calls the DescribePolicies API operation.

Options:

  • :auto_scaling_group_name - (String)

  • :policy_names - (Array<String>)

  • :next_token - (String)

  • :max_records - (Integer)

Response Structure:

  • :scaling_policies - (Array<Hash>)

    • :auto_scaling_group_name - (String)

    • :policy_name - (String)

    • :scaling_adjustment - (Integer)

    • :adjustment_type - (String)

    • :cooldown - (Integer)

    • :policy_arn - (String)

    • :alarms - (Array<Hash>)

      • :alarm_name - (String)

      • :alarm_arn - (String)

    • :min_adjustment_magnitude - (Integer)

  • :next_token - (String)

Returns:


431
# File 'lib/aws/auto_scaling/client.rb', line 431

define_client_method :describe_policies, 'DescribePolicies'

#describe_scaling_activities(options = {}) ⇒ Core::Response

Calls the DescribeScalingActivities API operation.

Options:

  • :activity_ids - (Array<String>)

  • :auto_scaling_group_name - (String)

  • :max_records - (Integer)

  • :next_token - (String)

Response Structure:

  • :activities - (Array<Hash>)

    • :activity_id - (String)

    • :auto_scaling_group_name - (String)

    • :description - (String)

    • :cause - (String)

    • :start_time - (Time)

    • :end_time - (Time)

    • :status_code - (String)

    • :status_message - (String)

    • :progress - (Integer)

    • :details - (String)

  • :next_token - (String)

Returns:


460
# File 'lib/aws/auto_scaling/client.rb', line 460

define_client_method :describe_scaling_activities, 'DescribeScalingActivities'

#describe_scaling_process_types(options = {}) ⇒ Core::Response

Calls the DescribeScalingProcessTypes API operation.

Options:

This method accepts no options.

Response Structure:

  • :processes - (Array<Hash>)

    • :process_name - (String)

Returns:


476
# File 'lib/aws/auto_scaling/client.rb', line 476

define_client_method :describe_scaling_process_types, 'DescribeScalingProcessTypes'

#describe_scheduled_actions(options = {}) ⇒ Core::Response

Calls the DescribeScheduledActions API operation.

Options:

  • :auto_scaling_group_name - (String)

  • :scheduled_action_names - (Array<String>)

  • :start_time - (String<ISO8601 datetime>)

  • :end_time - (String<ISO8601 datetime>)

  • :next_token - (String)

  • :max_records - (Integer)

Response Structure:

  • :scheduled_update_group_actions - (Array<Hash>)

    • :auto_scaling_group_name - (String)

    • :scheduled_action_name - (String)

    • :scheduled_action_arn - (String)

    • :time - (Time)

    • :start_time - (Time)

    • :end_time - (Time)

    • :recurrence - (String)

    • :min_size - (Integer)

    • :max_size - (Integer)

    • :desired_capacity - (Integer)

  • :next_token - (String)

Returns:


507
# File 'lib/aws/auto_scaling/client.rb', line 507

define_client_method :describe_scheduled_actions, 'DescribeScheduledActions'

#describe_tags(options = {}) ⇒ Core::Response

Calls the DescribeTags API operation.

Options:

  • :filters - (Array<Hash>)

    • :name - (String)

    • :values - (Array<String>)

  • :next_token - (String)

  • :max_records - (Integer)

Response Structure:

  • :tags - (Array<Hash>)

    • :resource_id - (String)

    • :resource_type - (String)

    • :key - (String)

    • :value - (String)

    • :propagate_at_launch - (Boolean)

  • :next_token - (String)

Returns:


532
# File 'lib/aws/auto_scaling/client.rb', line 532

define_client_method :describe_tags, 'DescribeTags'

#disable_metrics_collection(options = {}) ⇒ Core::Response

Calls the DisableMetricsCollection API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :metrics - (Array<String>)

Response Structure:

This method returns no response data.

Returns:


548
# File 'lib/aws/auto_scaling/client.rb', line 548

define_client_method :disable_metrics_collection, 'DisableMetricsCollection'

#enable_metrics_collection(options = {}) ⇒ Core::Response

Calls the EnableMetricsCollection API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :metrics - (Array<String>)

  • :granularity - required - (String)

Response Structure:

This method returns no response data.

Returns:


565
# File 'lib/aws/auto_scaling/client.rb', line 565

define_client_method :enable_metrics_collection, 'EnableMetricsCollection'

#execute_policy(options = {}) ⇒ Core::Response

Calls the ExecutePolicy API operation.

Options:

  • :auto_scaling_group_name - (String)

  • :policy_name - required - (String)

  • :honor_cooldown - (Boolean)

Response Structure:

This method returns no response data.

Returns:


582
# File 'lib/aws/auto_scaling/client.rb', line 582

define_client_method :execute_policy, 'ExecutePolicy'

#put_notification_configuration(options = {}) ⇒ Core::Response

Calls the PutNotificationConfiguration API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :topic_arn - required - (String)

  • :notification_types - required - (Array<String>)

Response Structure:

This method returns no response data.

Returns:


599
# File 'lib/aws/auto_scaling/client.rb', line 599

define_client_method :put_notification_configuration, 'PutNotificationConfiguration'

#put_scaling_policy(options = {}) ⇒ Core::Response

Calls the PutScalingPolicy API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :policy_name - required - (String)

  • :scaling_adjustment - required - (Integer)

  • :adjustment_type - required - (String)

  • :cooldown - (Integer)

  • :min_adjustment_magnitude - (Integer)

Response Structure:

  • :policy_arn - (String)

Returns:


619
# File 'lib/aws/auto_scaling/client.rb', line 619

define_client_method :put_scaling_policy, 'PutScalingPolicy'

#put_scheduled_update_group_action(options = {}) ⇒ Core::Response

Calls the PutScheduledUpdateGroupAction API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :scheduled_action_name - required - (String)

  • :time - (String<ISO8601 datetime>)

  • :start_time - (String<ISO8601 datetime>)

  • :end_time - (String<ISO8601 datetime>)

  • :recurrence - (String)

  • :min_size - (Integer)

  • :max_size - (Integer)

  • :desired_capacity - (Integer)

Response Structure:

This method returns no response data.

Returns:


642
# File 'lib/aws/auto_scaling/client.rb', line 642

define_client_method :put_scheduled_update_group_action, 'PutScheduledUpdateGroupAction'

#resume_processes(options = {}) ⇒ Core::Response

Calls the ResumeProcesses API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :scaling_processes - (Array<String>)

Response Structure:

This method returns no response data.

Returns:


658
# File 'lib/aws/auto_scaling/client.rb', line 658

define_client_method :resume_processes, 'ResumeProcesses'

#set_desired_capacity(options = {}) ⇒ Core::Response

Calls the SetDesiredCapacity API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :desired_capacity - required - (Integer)

  • :honor_cooldown - (Boolean)

Response Structure:

This method returns no response data.

Returns:


675
# File 'lib/aws/auto_scaling/client.rb', line 675

define_client_method :set_desired_capacity, 'SetDesiredCapacity'

#set_instance_health(options = {}) ⇒ Core::Response

Calls the SetInstanceHealth API operation.

Options:

  • :instance_id - required - (String)

  • :health_status - required - (String)

  • :should_respect_grace_period - (Boolean)

Response Structure:

This method returns no response data.

Returns:


692
# File 'lib/aws/auto_scaling/client.rb', line 692

define_client_method :set_instance_health, 'SetInstanceHealth'

#suspend_processes(options = {}) ⇒ Core::Response

Calls the SuspendProcesses API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :scaling_processes - (Array<String>)

Response Structure:

This method returns no response data.

Returns:


708
# File 'lib/aws/auto_scaling/client.rb', line 708

define_client_method :suspend_processes, 'SuspendProcesses'

#terminate_instance_in_auto_scaling_group(options = {}) ⇒ Core::Response

Calls the TerminateInstanceInAutoScalingGroup API operation.

Options:

  • :instance_id - required - (String)

  • :should_decrement_desired_capacity - required - (Boolean)

Response Structure:

  • :activity - (Hash)

    • :activity_id - (String)

    • :auto_scaling_group_name - (String)

    • :description - (String)

    • :cause - (String)

    • :start_time - (Time)

    • :end_time - (Time)

    • :status_code - (String)

    • :status_message - (String)

    • :progress - (Integer)

    • :details - (String)

Returns:


734
# File 'lib/aws/auto_scaling/client.rb', line 734

define_client_method :terminate_instance_in_auto_scaling_group, 'TerminateInstanceInAutoScalingGroup'

#update_auto_scaling_group(options = {}) ⇒ Core::Response

Calls the UpdateAutoScalingGroup API operation.

Options:

  • :auto_scaling_group_name - required - (String)

  • :launch_configuration_name - (String)

  • :min_size - (Integer)

  • :max_size - (Integer)

  • :desired_capacity - (Integer)

  • :default_cooldown - (Integer)

  • :availability_zones - (Array<String>)

  • :health_check_type - (String)

  • :health_check_grace_period - (Integer)

  • :placement_group - (String)

  • :vpc_zone_identifier - (String)

Response Structure:

This method returns no response data.

Returns:


759
# File 'lib/aws/auto_scaling/client.rb', line 759

define_client_method :update_auto_scaling_group, 'UpdateAutoScalingGroup'