Class: AWS::EC2::Client

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

Overview

Client class for Amazon Elastic Compute Cloud (EC2).

Constant Summary collapse

API_VERSION = 
'2012-04-01'
CACHEABLE_REQUESTS = 
Set[
  :describe_addresses,
  :describe_availability_zones,
  :describe_bundle_tasks,
  :describe_customer_gateways,
  :describe_dhcp_options,
  :describe_image_attribute,
  :describe_images,
  :describe_instances,
  :describe_key_pairs,
  :describe_regions,
  :describe_reserved_instances,
  :describe_reserved_instances_offerings,
  :describe_security_groups,
  :describe_snapshot_attribute,
  :describe_snapshots,
  :describe_subnets,
  :describe_volume_status,
  :describe_volumes,
  :describe_vpcs,
  :describe_vpn_connections,
  :describe_vpn_gateways,
  :describe_instance_attribute,
  :describe_spot_instance_requests,
  :describe_spot_price_history,
  :describe_spot_datafeed_subscription,
  :describe_licenses,
  :describe_placement_groups,
  :describe_tags,
  :describe_internet_gateways,
  :describe_route_tables,
  :describe_network_acls,
  :describe_instance_status,
  :describe_conversion_tasks,
  :describe_network_interfaces,
  :describe_network_interface_attribute,
]

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

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

Calls the ActivateLicense API operation.

Options:

  • :license_id - required - (String) Specifies the ID for the specific license to activate against.

  • :capacity - required - (Integer) Specifies the additional number of licenses to activate.

Response Structure:

This method returns no response data.

Returns:



81
 
# File 'lib/aws/ec2/client.rb', line 81

define_client_method :activate_license, 'ActivateLicense'

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

Calls the AllocateAddress API operation.

Options:

  • :domain - (String) Set to vpc to allocate the address to your VPC. By default, will allocate to EC2.

Response Structure:

  • :public_ip - (String)

  • :domain - (String)

  • :allocation_id - (String)

Returns:



99
 
# File 'lib/aws/ec2/client.rb', line 99

define_client_method :allocate_address, 'AllocateAddress'

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

Calls the AssociateAddress API operation.

Options:

  • :instance_id - required - (String) The instance to associate with the IP address.

  • :public_ip - (String) IP address that you are assigning to the instance.

  • :allocation_id - (String) The allocation ID that AWS returned when you allocated the elastic IP address for use with Amazon VPC.

  • :network_interface_id - (String)

Response Structure:

  • :association_id - (String)

Returns:



120
 
# File 'lib/aws/ec2/client.rb', line 120

define_client_method :associate_address, 'AssociateAddress'

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

Calls the AssociateDhcpOptions API operation.

Options:

  • :dhcp_options_id - required - (String) The ID of the DHCP options to associate with the VPC. Specify “default” to associate the default DHCP options with the VPC.

  • :vpc_id - required - (String) The ID of the VPC to associate the DHCP options with.

Response Structure:

This method returns no response data.

Returns:



139
 
# File 'lib/aws/ec2/client.rb', line 139

define_client_method :associate_dhcp_options, 'AssociateDhcpOptions'

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

Calls the AssociateRouteTable API operation.

Options:

  • :subnet_id - required - (String) The ID of the subnet.

  • :route_table_id - required - (String) The ID of the route table.

Response Structure:

  • :association_id - (String)

Returns:



155
 
# File 'lib/aws/ec2/client.rb', line 155

define_client_method :associate_route_table, 'AssociateRouteTable'

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

Calls the AttachInternetGateway API operation.

Options:

  • :internet_gateway_id - required - (String) The ID of the Internet gateway to attach.

  • :vpc_id - required - (String) The ID of the VPC.

Response Structure:

This method returns no response data.

Returns:



172
 
# File 'lib/aws/ec2/client.rb', line 172

define_client_method :attach_internet_gateway, 'AttachInternetGateway'

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

Calls the AttachNetworkInterface API operation.

Options:

  • :network_interface_id - required - (String)

  • :instance_id - required - (String)

  • :device_index - required - (Integer)

Response Structure:

  • :attachment_id - (String)

Returns:



189
 
# File 'lib/aws/ec2/client.rb', line 189

define_client_method :attach_network_interface, 'AttachNetworkInterface'

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

Calls the AttachVolume API operation.

Options:

  • :volume_id - required - (String) The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone and the instance must be running.

  • :instance_id - required - (String) The ID of the instance to which the volume attaches. The volume and instance must be within the same Availability Zone and the instance must be running.

  • :device - required - (String) Specifies how the device is exposed to the instance (e.g., /dev/sdh).

Response Structure:

  • :volume_id - (String)

  • :instance_id - (String)

  • :device - (String)

  • :status - (String)

  • :attach_time - (Time)

  • :delete_on_termination - (Boolean)

Returns:



216
 
# File 'lib/aws/ec2/client.rb', line 216

define_client_method :attach_volume, 'AttachVolume'

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

Calls the AttachVpnGateway API operation.

Options:

  • :vpn_gateway_id - required - (String) The ID of the VPN gateway to attach to the VPC.

  • :vpc_id - required - (String) The ID of the VPC to attach to the VPN gateway.

Response Structure:

  • :attachment - (Hash)

    • :vpc_id - (String)

    • :state - (String)

Returns:



236
 
# File 'lib/aws/ec2/client.rb', line 236

define_client_method :attach_vpn_gateway, 'AttachVpnGateway'

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

Calls the AuthorizeSecurityGroupEgress API operation.

Options:

  • :group_id - required - (String) ID of the VPC security group to modify.

  • :source_security_group_name - (String) Deprecated.

  • :source_security_group_owner_id - (String) Deprecated.

  • :ip_protocol - (String) Deprecated.

  • :from_port - (Integer) Deprecated.

  • :to_port - (Integer) Deprecated.

  • :cidr_ip - (String) Deprecated.

  • :ip_permissions - (Array<Hash>) List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

    • :ip_protocol - (String) The IP protocol of this permission. Valid protocol values: tcp, udp, icmp

    • :from_port - (Integer) Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

    • :to_port - (Integer) End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

    • :user_id_group_pairs - (Array<Hash>) The list of AWS user IDs and groups included in this permission.

      • :user_id - (String) The AWS user ID of an account.

      • :group_name - (String) Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

      • :group_id - (String) ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

    • :ip_ranges - (Array<Hash>) The list of CIDR IP ranges included in this permission.

      • :cidr_ip - (String) The list of CIDR IP ranges.

Response Structure:

This method returns no response data.

Returns:



282
 
# File 'lib/aws/ec2/client.rb', line 282

define_client_method :authorize_security_group_egress, 'AuthorizeSecurityGroupEgress'

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

Calls the AuthorizeSecurityGroupIngress API operation.

Options:

  • :group_name - (String) Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.

  • :group_id - (String) ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.

  • :source_security_group_name - (String) Deprecated

  • :source_security_group_owner_id - (String) Deprecated

  • :ip_protocol - (String) Deprecated

  • :from_port - (Integer) Deprecated

  • :to_port - (Integer) Deprecated

  • :cidr_ip - (String) Deprecated

  • :ip_permissions - (Array<Hash>) List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

    • :ip_protocol - (String) The IP protocol of this permission. Valid protocol values: tcp, udp, icmp

    • :from_port - (Integer) Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

    • :to_port - (Integer) End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

    • :user_id_group_pairs - (Array<Hash>) The list of AWS user IDs and groups included in this permission.

      • :user_id - (String) The AWS user ID of an account.

      • :group_name - (String) Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

      • :group_id - (String) ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

    • :ip_ranges - (Array<Hash>) The list of CIDR IP ranges included in this permission.

      • :cidr_ip - (String) The list of CIDR IP ranges.

Response Structure:

This method returns no response data.

Returns:



333
 
# File 'lib/aws/ec2/client.rb', line 333

define_client_method :authorize_security_group_ingress, 'AuthorizeSecurityGroupIngress'

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

Calls the BundleInstance API operation.

Options:

  • :instance_id - required - (String) The ID of the instance to bundle.

  • :storage - required - (Hash)

    • :s3 - (Hash) The details of S3 storage for bundling a Windows instance.

      • :bucket - (String) The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

      • :prefix - (String) The prefix to use when storing the AMI in S3.

      • :aws_access_key_id - (String) The Access Key ID of the owner of the Amazon S3 bucket.

      • :upload_policy - (String) A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on the user’s behalf.

      • :upload_policy_signature - (String) The signature of the Base64 encoded JSON document.

Response Structure:

  • :bundle_instance_task - (Hash)

    • :instance_id - (String)

    • :bundle_id - (String)

    • :state - (String)

    • :start_time - (Time)

    • :update_time - (Time)

    • :storage - (Hash)

      • :s3 - (Hash)

        • :bucket - (String)

        • :prefix - (String)

        • :aws_access_key_id - (String)

        • :upload_policy - (String)

        • :upload_policy_signature - (String)

    • :progress - (String)

    • :error - (Hash)

      • :code - (String)

      • :message - (String)

Returns:



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

define_client_method :bundle_instance, 'BundleInstance'

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

Calls the CancelBundleTask API operation.

Options:

  • :bundle_id - required - (String) The ID of the bundle task to cancel.

Response Structure:

  • :bundle_instance_task - (Hash)

    • :instance_id - (String)

    • :bundle_id - (String)

    • :state - (String)

    • :start_time - (Time)

    • :update_time - (Time)

    • :storage - (Hash)

      • :s3 - (Hash)

        • :bucket - (String)

        • :prefix - (String)

        • :aws_access_key_id - (String)

        • :upload_policy - (String)

        • :upload_policy_signature - (String)

    • :progress - (String)

    • :error - (Hash)

      • :code - (String)

      • :message - (String)

Returns:



413
 
# File 'lib/aws/ec2/client.rb', line 413

define_client_method :cancel_bundle_task, 'CancelBundleTask'

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

Calls the CancelConversionTask API operation.

Options:

  • :conversion_task_id - required - (String)

  • :reason_message - (String)

Response Structure:

This method returns no response data.

Returns:



429
 
# File 'lib/aws/ec2/client.rb', line 429

define_client_method :cancel_conversion_task, 'CancelConversionTask'

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

Calls the CancelSpotInstanceRequests API operation.

Options:

  • :spot_instance_request_ids - required - (Array<String>) Specifies the ID of the Spot Instance request.

Response Structure:

  • :spot_instance_request_set - (Array<Hash>)

    • :spot_instance_request_id - (String)

    • :state - (String)

Returns:



447
 
# File 'lib/aws/ec2/client.rb', line 447

define_client_method :cancel_spot_instance_requests, 'CancelSpotInstanceRequests'

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

Calls the ConfirmProductInstance API operation.

Options:

  • :product_code - required - (String) The product code to confirm.

  • :instance_id - required - (String) The ID of the instance to confirm.

Response Structure:

  • :owner_id - (String)

Returns:



464
 
# File 'lib/aws/ec2/client.rb', line 464

define_client_method :confirm_product_instance, 'ConfirmProductInstance'

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

Calls the CreateCustomerGateway API operation.

Options:

  • :type - required - (String) The type of VPN connection this customer gateway supports.

  • :public_ip - required - (String) The Internet-routable IP address for the customer gateway’s outside interface. The address must be static

  • :bgp_asn - required - (Integer) The customer gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Response Structure:

  • :customer_gateway - (Hash)

    • :customer_gateway_id - (String)

    • :state - (String)

    • :type - (String)

    • :ip_address - (String)

    • :bgp_asn - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



493
 
# File 'lib/aws/ec2/client.rb', line 493

define_client_method :create_customer_gateway, 'CreateCustomerGateway'

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

Calls the CreateDhcpOptions API operation.

Options:

  • :dhcp_configurations - required - (Array<Hash>) A set of one or more DHCP configurations.

    • :key - (String) Contains the name of a DHCP option.

    • :values - (Array<String>) Contains a set of values for a DHCP option.

Response Structure:

  • :dhcp_options - (Hash)

    • :dhcp_options_id - (String)

    • :dhcp_configuration_set - (Array<Hash>)

      • :key - (String)

      • :value_set - (Array<String>)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



519
 
# File 'lib/aws/ec2/client.rb', line 519

define_client_method :create_dhcp_options, 'CreateDhcpOptions'

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

Calls the CreateImage API operation.

Options:

  • :instance_id - required - (String) The ID of the instance from which to create the new image.

  • :name - required - (String) The name for the new AMI being created.

  • :description - (String) The description for the new AMI being created.

  • :no_reboot - (Boolean) By default this property is set to false , which means Amazon EC2 attempts to cleanly shut down the instance before image creation and reboots the instance afterwards. When set to true , Amazon EC2 will not shut down the instance before creating the image. When this option is used, file system integrity on the created image cannot be guaranteed.

Response Structure:

  • :image_id - (String)

Returns:



545
 
# File 'lib/aws/ec2/client.rb', line 545

define_client_method :create_image, 'CreateImage'

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

Calls the CreateInternetGateway API operation.

Options:

This method accepts no options.

Response Structure:

  • :internet_gateway - (Hash)

    • :internet_gateway_id - (String)

    • :attachment_set - (Array<Hash>)

      • :vpc_id - (String)

      • :state - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



567
 
# File 'lib/aws/ec2/client.rb', line 567

define_client_method :create_internet_gateway, 'CreateInternetGateway'

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

Calls the CreateKeyPair API operation.

Options:

  • :key_name - required - (String) The unique name for the new key pair.

Response Structure:

  • :key_pair - (Hash)

    • :key_name - (String)

    • :key_fingerprint - (String)

    • :key_material - (String)

Returns:



586
 
# File 'lib/aws/ec2/client.rb', line 586

define_client_method :create_key_pair, 'CreateKeyPair'

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

Calls the CreateNetworkAcl API operation.

Options:

  • :vpc_id - required - (String) The ID of the VPC where the network ACL will be created.

Response Structure:

  • :network_acl - (Hash)

    • :network_acl_id - (String)

    • :vpc_id - (String)

    • :default - (Boolean)

    • :entry_set - (Array<Hash>)

      • :rule_number - (Integer)

      • :protocol - (String)

      • :rule_action - (String)

      • :egress - (Boolean)

      • :cidr_block - (String)

      • :icmp_type_code - (Hash)

        • :type - (Integer)

        • :code - (Integer)

      • :port_range - (Hash)

        • :from - (Integer)

        • :to - (Integer)

    • :association_set - (Array<Hash>)

      • :network_acl_association_id - (String)

      • :network_acl_id - (String)

      • :subnet_id - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



624
 
# File 'lib/aws/ec2/client.rb', line 624

define_client_method :create_network_acl, 'CreateNetworkAcl'

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

Calls the CreateNetworkAclEntry API operation.

Options:

  • :network_acl_id - required - (String) ID of the ACL where the entry will be created.

  • :rule_number - required - (Integer) Rule number to assign to the entry (e.g., 100). ACL entries are processed in ascending order by rule number.

  • :protocol - required - (String) IP protocol the rule applies to. Valid Values: tcp, udp, icmp or an IP protocol number.

  • :rule_action - required - (String) Whether to allow or deny traffic that matches the rule.

  • :egress - required - (Boolean) Whether this rule applies to egress traffic from the subnet ( true ) or ingress traffic to the subnet ( false ).

  • :cidr_block - required - (String) The CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).

  • :icmp_type_code - (Hash) ICMP values.

    • :type - (Integer) For the ICMP protocol, the ICMP type. A value of -1 is a wildcard meaning all types. Required if specifying icmp for the protocol.

    • :code - (Integer) For the ICMP protocol, the ICMP code. A value of -1 is a wildcard meaning all codes. Required if specifying icmp for the protocol.

  • :port_range - (Hash) Port ranges.

    • :from - (Integer) The first port in the range. Required if specifying tcp or udp for the protocol.

    • :to - (Integer) The last port in the range. Required if specifying tcp or udp for the protocol.

Response Structure:

This method returns no response data.

Returns:



664
 
# File 'lib/aws/ec2/client.rb', line 664

define_client_method :create_network_acl_entry, 'CreateNetworkAclEntry'

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

Calls the CreateNetworkInterface API operation.

Options:

  • :subnet_id - required - (String)

  • :description - (String)

  • :private_ip_address - (String)

  • :groups - (Array<String>)

Response Structure:

  • :network_interface - (Hash)

    • :network_interface_id - (String)

    • :subnet_id - (String)

    • :vpc_id - (String)

    • :availability_zone - (String)

    • :description - (String)

    • :owner_id - (String)

    • :requester_id - (String)

    • :requester_managed - (Boolean)

    • :status - (String)

    • :mac_address - (String)

    • :private_ip_address - (String)

    • :private_dns_name - (String)

    • :source_dest_check - (Boolean)

    • :group_set - (Array<Hash>)

      • :group_name - (String)

      • :group_id - (String)

    • :attachment - (Hash)

      • :attachment_id - (String)

      • :instance_id - (String)

      • :instance_owner_id - (String)

      • :device_index - (Integer)

      • :status - (String)

      • :attach_time - (Time)

      • :delete_on_termination - (Boolean)

    • :association - (Hash)

      • :public_ip - (String)

      • :ip_owner_id - (String)

      • :allocation_id - (String)

      • :association_id - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



714
 
# File 'lib/aws/ec2/client.rb', line 714

define_client_method :create_network_interface, 'CreateNetworkInterface'

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

Calls the CreatePlacementGroup API operation.

Options:

  • :group_name - required - (String) The name of the PlacementGroup.

  • :strategy - required - (String) The PlacementGroup strategy.

Response Structure:

This method returns no response data.

Returns:



730
 
# File 'lib/aws/ec2/client.rb', line 730

define_client_method :create_placement_group, 'CreatePlacementGroup'

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

Calls the CreateRoute API operation.

Options:

  • :route_table_id - required - (String) The ID of the route table where the route will be added.

  • :destination_cidr_block - required - (String) The CIDR address block used for the destination match. For example: 0.0.0.0/0. Routing decisions are based on the most specific match.

  • :gateway_id - (String) The ID of a VPN or Internet gateway attached to your VPC. You must provide either GatewayId or InstanceId, but not both.

  • :instance_id - (String) The ID of a NAT instance in your VPC. You must provide either GatewayId or InstanceId, but not both.

  • :network_interface_id - (String)

Response Structure:

This method returns no response data.

Returns:



755
 
# File 'lib/aws/ec2/client.rb', line 755

define_client_method :create_route, 'CreateRoute'

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

Calls the CreateRouteTable API operation.

Options:

  • :vpc_id - required - (String) The ID of the VPC where the route table will be created.

Response Structure:

  • :route_table - (Hash)

    • :route_table_id - (String)

    • :vpc_id - (String)

    • :route_set - (Array<Hash>)

      • :destination_cidr_block - (String)

      • :gateway_id - (String)

      • :instance_id - (String)

      • :instance_owner_id - (String)

      • :network_interface_id - (String)

      • :state - (String)

    • :association_set - (Array<Hash>)

      • :route_table_association_id - (String)

      • :route_table_id - (String)

      • :subnet_id - (String)

      • :main - (Boolean)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



788
 
# File 'lib/aws/ec2/client.rb', line 788

define_client_method :create_route_table, 'CreateRouteTable'

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

Calls the CreateSecurityGroup API operation.

Options:

  • :group_name - required - (String) Name of the security group.

  • :description - required - (String) Description of the group. This is informational only.

  • :vpc_id - (String) ID of the VPC.

Response Structure:

  • :group_id - (String)

Returns:



806
 
# File 'lib/aws/ec2/client.rb', line 806

define_client_method :create_security_group, 'CreateSecurityGroup'

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

Calls the CreateSnapshot API operation.

Options:

  • :volume_id - required - (String) The ID of the volume from which to create the snapshot.

  • :description - (String) The description for the new snapshot.

Response Structure:

  • :snapshot_id - (String)

  • :volume_id - (String)

  • :status - (String)

  • :start_time - (Time)

  • :progress - (String)

  • :owner_id - (String)

  • :description - (String)

  • :volume_size - (Integer)

  • :owner_alias - (String)

  • :tag_set - (Array<Hash>)

    • :key - (String)

    • :value - (String)

Returns:



834
 
# File 'lib/aws/ec2/client.rb', line 834

define_client_method :create_snapshot, 'CreateSnapshot'

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

Calls the CreateSpotDatafeedSubscription API operation.

Options:

  • :bucket - required - (String) The Amazon S3 bucket in which to store the Spot Instance datafeed.

  • :prefix - (String) The prefix that is prepended to datafeed files.

Response Structure:

  • :spot_datafeed_subscription - (Hash)

    • :owner_id - (String)

    • :bucket - (String)

    • :prefix - (String)

    • :state - (String)

    • :fault - (Hash)

      • :code - (String)

      • :message - (String)

Returns:



858
 
# File 'lib/aws/ec2/client.rb', line 858

define_client_method :create_spot_datafeed_subscription, 'CreateSpotDatafeedSubscription'

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

Calls the CreateSubnet API operation.

Options:

  • :vpc_id - required - (String) The ID of the VPC to create the subnet in.

  • :cidr_block - required - (String) The CIDR block the subnet is to cover.

  • :availability_zone - (String) The Availability Zone to create the subnet in.

Response Structure:

  • :subnet - (Hash)

    • :subnet_id - (String)

    • :state - (String)

    • :vpc_id - (String)

    • :cidr_block - (String)

    • :available_ip_address_count - (Integer)

    • :availability_zone - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



887
 
# File 'lib/aws/ec2/client.rb', line 887

define_client_method :create_subnet, 'CreateSubnet'

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

Calls the CreateTags API operation.

Options:

  • :resources - required - (Array<String>) One or more IDs of resources to tag. This could be the ID of an AMI, an instance, an EBS volume, or snapshot, etc.

  • :tags - required - (Array<Hash>) The tags to add or overwrite for the specified resources. Each tag item consists of a key-value pair.

    • :key - (String) The tag’s key.

    • :value - (String) The tag’s value.

Response Structure:

This method returns no response data.

Returns:



908
 
# File 'lib/aws/ec2/client.rb', line 908

define_client_method :create_tags, 'CreateTags'

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

Calls the CreateVolume API operation.

Options:

  • :size - (Integer) The size of the volume, in gigabytes. Required if you are not creating a volume from a snapshot.

  • :snapshot_id - (String) The ID of the snapshot from which to create the new volume.

  • :availability_zone - required - (String) The Availability Zone in which to create the new volume.

Response Structure:

  • :volume_id - (String)

  • :size - (Integer)

  • :snapshot_id - (String)

  • :availability_zone - (String)

  • :status - (String)

  • :create_time - (Time)

  • :attachment_set - (Array<Hash>)

    • :volume_id - (String)

    • :instance_id - (String)

    • :device - (String)

    • :status - (String)

    • :attach_time - (Time)

    • :delete_on_termination - (Boolean)

  • :tag_set - (Array<Hash>)

    • :key - (String)

    • :value - (String)

Returns:



943
 
# File 'lib/aws/ec2/client.rb', line 943

define_client_method :create_volume, 'CreateVolume'

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

Calls the CreateVpc API operation.

Options:

  • :cidr_block - required - (String) A valid CIDR block.

  • :instance_tenancy - (String) The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means instances must be launched with tenancy as dedicated.

Response Structure:

  • :vpc - (Hash)

    • :vpc_id - (String)

    • :state - (String)

    • :cidr_block - (String)

    • :dhcp_options_id - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

    • :instance_tenancy - (String)

Returns:



970
 
# File 'lib/aws/ec2/client.rb', line 970

define_client_method :create_vpc, 'CreateVpc'

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

Calls the CreateVpnConnection API operation.

Options:

  • :type - required - (String) The type of VPN connection.

  • :customer_gateway_id - required - (String) The ID of the customer gateway.

  • :vpn_gateway_id - required - (String) The ID of the VPN gateway.

Response Structure:

  • :vpn_connection - (Hash)

    • :vpn_connection_id - (String)

    • :state - (String)

    • :customer_gateway_configuration - (String)

    • :type - (String)

    • :customer_gateway_id - (String)

    • :vpn_gateway_id - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

    • :vgw_telemetry - (Array<Hash>)

      • :outside_ip_address - (String)

      • :status - (String)

      • :last_status_change - (Time)

      • :status_message - (String)

      • :accepted_route_count - (Integer)

Returns:



1003
 
# File 'lib/aws/ec2/client.rb', line 1003

define_client_method :create_vpn_connection, 'CreateVpnConnection'

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

Calls the CreateVpnGateway API operation.

Options:

  • :type - required - (String) The type of VPN connection this VPN gateway supports.

  • :availability_zone - (String) The Availability Zone in which to create the VPN gateway.

Response Structure:

  • :vpn_gateway - (Hash)

    • :vpn_gateway_id - (String)

    • :state - (String)

    • :vpn_type - (String)

    • :availability_zone - (String)

    • :attachments - (Array<Hash>)

      • :vpc_id - (String)

      • :state - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



1031
 
# File 'lib/aws/ec2/client.rb', line 1031

define_client_method :create_vpn_gateway, 'CreateVpnGateway'

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

Calls the DeactivateLicense API operation.

Options:

  • :license_id - required - (String) Specifies the ID for the specific license to deactivate against.

  • :capacity - required - (Integer) Specifies the amount of capacity to deactivate against the license.

Response Structure:

This method returns no response data.

Returns:



1049
 
# File 'lib/aws/ec2/client.rb', line 1049

define_client_method :deactivate_license, 'DeactivateLicense'

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

Calls the DeleteCustomerGateway API operation.

Options:

  • :customer_gateway_id - required - (String) The ID of the customer gateway to delete.

Response Structure:

This method returns no response data.

Returns:



1065
 
# File 'lib/aws/ec2/client.rb', line 1065

define_client_method :delete_customer_gateway, 'DeleteCustomerGateway'

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

Calls the DeleteDhcpOptions API operation.

Options:

  • :dhcp_options_id - required - (String) The ID of the DHCP options set to delete.

Response Structure:

This method returns no response data.

Returns:



1081
 
# File 'lib/aws/ec2/client.rb', line 1081

define_client_method :delete_dhcp_options, 'DeleteDhcpOptions'

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

Calls the DeleteInternetGateway API operation.

Options:

  • :internet_gateway_id - required - (String) The ID of the Internet gateway to be deleted.

Response Structure:

This method returns no response data.

Returns:



1097
 
# File 'lib/aws/ec2/client.rb', line 1097

define_client_method :delete_internet_gateway, 'DeleteInternetGateway'

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

Calls the DeleteKeyPair API operation.

Options:

  • :key_name - required - (String) The name of the Amazon EC2 key pair to delete.

Response Structure:

This method returns no response data.

Returns:



1113
 
# File 'lib/aws/ec2/client.rb', line 1113

define_client_method :delete_key_pair, 'DeleteKeyPair'

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

Calls the DeleteNetworkAcl API operation.

Options:

  • :network_acl_id - required - (String) The ID of the network ACL to be deleted.

Response Structure:

This method returns no response data.

Returns:



1129
 
# File 'lib/aws/ec2/client.rb', line 1129

define_client_method :delete_network_acl, 'DeleteNetworkAcl'

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

Calls the DeleteNetworkAclEntry API operation.

Options:

  • :network_acl_id - required - (String) ID of the network ACL.

  • :rule_number - required - (Integer) Rule number for the entry to delete.

  • :egress - required - (Boolean) Whether the rule to delete is an egress rule ( true ) or ingress rule ( false ).

Response Structure:

This method returns no response data.

Returns:



1148
 
# File 'lib/aws/ec2/client.rb', line 1148

define_client_method :delete_network_acl_entry, 'DeleteNetworkAclEntry'

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

Calls the DeleteNetworkInterface API operation.

Options:

  • :network_interface_id - required - (String)

Response Structure:

This method returns no response data.

Returns:



1163
 
# File 'lib/aws/ec2/client.rb', line 1163

define_client_method :delete_network_interface, 'DeleteNetworkInterface'

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

Calls the DeletePlacementGroup API operation.

Options:

  • :group_name - required - (String) The name of the PlacementGroup to delete.

Response Structure:

This method returns no response data.

Returns:



1179
 
# File 'lib/aws/ec2/client.rb', line 1179

define_client_method :delete_placement_group, 'DeletePlacementGroup'

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

Calls the DeleteRoute API operation.

Options:

  • :route_table_id - required - (String) The ID of the route table where the route will be deleted.

  • :destination_cidr_block - required - (String) The CIDR range for the route you want to delete. The value you specify must exactly match the CIDR for the route you want to delete.

Response Structure:

This method returns no response data.

Returns:



1198
 
# File 'lib/aws/ec2/client.rb', line 1198

define_client_method :delete_route, 'DeleteRoute'

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

Calls the DeleteRouteTable API operation.

Options:

  • :route_table_id - required - (String) The ID of the route table to be deleted.

Response Structure:

This method returns no response data.

Returns:



1214
 
# File 'lib/aws/ec2/client.rb', line 1214

define_client_method :delete_route_table, 'DeleteRouteTable'

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

Calls the DeleteSecurityGroup API operation.

Options:

  • :group_name - (String) The name of the Amazon EC2 security group to delete.

  • :group_id - (String) The ID of the Amazon EC2 security group to delete.

Response Structure:

This method returns no response data.

Returns:



1232
 
# File 'lib/aws/ec2/client.rb', line 1232

define_client_method :delete_security_group, 'DeleteSecurityGroup'

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

Calls the DeleteSnapshot API operation.

Options:

  • :snapshot_id - required - (String) The ID of the snapshot to delete.

Response Structure:

This method returns no response data.

Returns:



1248
 
# File 'lib/aws/ec2/client.rb', line 1248

define_client_method :delete_snapshot, 'DeleteSnapshot'

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

Calls the DeleteSpotDatafeedSubscription API operation.

Options:

This method accepts no options.

Response Structure:

This method returns no response data.

Returns:



1263
 
# File 'lib/aws/ec2/client.rb', line 1263

define_client_method :delete_spot_datafeed_subscription, 'DeleteSpotDatafeedSubscription'

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

Calls the DeleteSubnet API operation.

Options:

  • :subnet_id - required - (String) The ID of the subnet you want to delete.

Response Structure:

This method returns no response data.

Returns:



1279
 
# File 'lib/aws/ec2/client.rb', line 1279

define_client_method :delete_subnet, 'DeleteSubnet'

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

Calls the DeleteTags API operation.

Options:

  • :resources - required - (Array<String>) A list of one or more resource IDs. This could be the ID of an AMI, an instance, an EBS volume, or snapshot, etc.

  • :tags - (Array<Hash>) The tags to delete from the specified resources. Each tag item consists of a key-value pair. If a tag is specified without a value, the tag and all of its values are deleted.

    • :key - (String) The tag’s key.

    • :value - (String) The tag’s value.

Response Structure:

This method returns no response data.

Returns:



1301
 
# File 'lib/aws/ec2/client.rb', line 1301

define_client_method :delete_tags, 'DeleteTags'

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

Calls the DeleteVolume API operation.

Options:

  • :volume_id - required - (String) The ID of the EBS volume to delete.

Response Structure:

This method returns no response data.

Returns:



1317
 
# File 'lib/aws/ec2/client.rb', line 1317

define_client_method :delete_volume, 'DeleteVolume'

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

Calls the DeleteVpc API operation.

Options:

  • :vpc_id - required - (String) The ID of the VPC you want to delete.

Response Structure:

This method returns no response data.

Returns:



1333
 
# File 'lib/aws/ec2/client.rb', line 1333

define_client_method :delete_vpc, 'DeleteVpc'

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

Calls the DeleteVpnConnection API operation.

Options:

  • :vpn_connection_id - required - (String) The ID of the VPN connection to delete

Response Structure:

This method returns no response data.

Returns:



1349
 
# File 'lib/aws/ec2/client.rb', line 1349

define_client_method :delete_vpn_connection, 'DeleteVpnConnection'

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

Calls the DeleteVpnGateway API operation.

Options:

  • :vpn_gateway_id - required - (String) The ID of the VPN gateway to delete.

Response Structure:

This method returns no response data.

Returns:



1365
 
# File 'lib/aws/ec2/client.rb', line 1365

define_client_method :delete_vpn_gateway, 'DeleteVpnGateway'

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

Calls the DeregisterImage API operation.

Options:

  • :image_id - required - (String) The ID of the AMI to deregister.

Response Structure:

This method returns no response data.

Returns:



1380
 
# File 'lib/aws/ec2/client.rb', line 1380

define_client_method :deregister_image, 'DeregisterImage'

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

Calls the DescribeAddresses API operation.

Options:

  • :public_ips - (Array<String>) The optional list of Elastic IP addresses to describe.

  • :filters - (Array<Hash>) A list of filters used to match properties for Addresses. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

  • :allocation_ids - (Array<String>)

Response Structure:

  • :addresses_set - (Array<Hash>)

    • :instance_id - (String)

    • :public_ip - (String)

    • :allocation_id - (String)

    • :association_id - (String)

    • :domain - (String)

    • :network_interface_id - (String)

    • :network_interface_owner_id - (String)

Returns:



1410
 
# File 'lib/aws/ec2/client.rb', line 1410

define_client_method :describe_addresses, 'DescribeAddresses'

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

Calls the DescribeAvailabilityZones API operation.

Options:

  • :zone_names - (Array<String>) A list of the availability zone names to describe.

  • :filters - (Array<Hash>) A list of filters used to match properties for AvailabilityZones. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :availability_zone_info - (Array<Hash>)

    • :zone_name - (String)

    • :zone_state - (String)

    • :region_name - (String)

    • :message_set - (Array<Hash>)

      • :message - (String)

Returns:



1437
 
# File 'lib/aws/ec2/client.rb', line 1437

define_client_method :describe_availability_zones, 'DescribeAvailabilityZones'

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

Calls the DescribeBundleTasks API operation.

Options:

  • :bundle_ids - (Array<String>) The list of bundle task IDs to describe.

  • :filters - (Array<Hash>) A list of filters used to match properties for BundleTasks. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :bundle_instance_tasks_set - (Array<Hash>)

    • :instance_id - (String)

    • :bundle_id - (String)

    • :state - (String)

    • :start_time - (Time)

    • :update_time - (Time)

    • :storage - (Hash)

      • :s3 - (Hash)

        • :bucket - (String)

        • :prefix - (String)

        • :aws_access_key_id - (String)

        • :upload_policy - (String)

        • :upload_policy_signature - (String)

    • :progress - (String)

    • :error - (Hash)

      • :code - (String)

      • :message - (String)

Returns:



1475
 
# File 'lib/aws/ec2/client.rb', line 1475

define_client_method :describe_bundle_tasks, 'DescribeBundleTasks'

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

Calls the DescribeConversionTasks API operation.

Options:

  • :filters - (Array<Hash>)

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

  • :conversion_task_ids - (Array<String>)

Response Structure:

  • :conversion_tasks - (Array<Hash>)

    • :conversion_task_id - (String)

    • :expiration_time - (String)

    • :import_instance - (Hash)

      • :volumes - (Array<Hash>)

        • :bytes_converted - (Integer)

        • :availability_zone - (String)

        • :image - (Hash)

          • :format - (String)

          • :size - (Integer)

          • :import_manifest_url - (String)

          • :checksum - (String)

        • :volume - (Hash)

          • :size - (Integer)

          • :id - (String)

        • :status - (String)

        • :status_message - (String)

        • :description - (String)

      • :instance_id - (String)

      • :platform - (String)

      • :description - (String)

    • :import_volume - (Hash)

      • :bytes_converted - (Integer)

      • :availability_zone - (String)

      • :description - (String)

      • :image - (Hash)

        • :format - (String)

        • :size - (Integer)

        • :import_manifest_url - (String)

        • :checksum - (String)

      • :volume - (Hash)

        • :size - (Integer)

        • :id - (String)

    • :state - (String)

    • :status_message - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



1531
 
# File 'lib/aws/ec2/client.rb', line 1531

define_client_method :describe_conversion_tasks, 'DescribeConversionTasks'

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

Calls the DescribeCustomerGateways API operation.

Options:

  • :customer_gateway_ids - (Array<String>) A set of one or more customer gateway IDs.

  • :filters - (Array<Hash>) A list of filters used to match properties for Customer Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :customer_gateway_set - (Array<Hash>)

    • :customer_gateway_id - (String)

    • :state - (String)

    • :vpn_type - (String)

    • :ip_address - (String)

    • :bgp_asn - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



1561
 
# File 'lib/aws/ec2/client.rb', line 1561

define_client_method :describe_customer_gateways, 'DescribeCustomerGateways'

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

Calls the DescribeDhcpOptions API operation.

Options:

  • :dhcp_options_ids - (Array<String>)

  • :filters - (Array<Hash>) A list of filters used to match properties for DhcpOptions. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :dhcp_options_set - (Array<Hash>)

    • :dhcp_options_id - (String)

    • :dhcp_configuration_set - (Array<Hash>)

      • :key - (String)

      • :value_set - (Array<String>)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



1589
 
# File 'lib/aws/ec2/client.rb', line 1589

define_client_method :describe_dhcp_options, 'DescribeDhcpOptions'

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

Calls the DescribeImageAttribute API operation.

Options:

  • :image_id - required - (String) The ID of the AMI whose attribute is to be described.

  • :attribute - required - (String) The name of the attribute to describe. Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

Response Structure:

  • :image_id - (String)

  • :launch_permission - (Array<Hash>)

    • :user_id - (String)

    • :group - (String)

  • :product_codes - (Array<Hash>)

    • :product_code - (String)

    • :type - (String)

  • :kernel - (Hash)

    • :value - (String)

  • :ramdisk - (Hash)

    • :value - (String)

  • :description - (Hash)

    • :value - (String)

  • :block_device_mapping - (Array<Hash>)

    • :virtual_name - (String)

    • :device_name - (String)

    • :ebs - (Hash)

      • :snapshot_id - (String)

      • :volume_size - (Integer)

      • :delete_on_termination - (Boolean)

    • :no_device - (String)

Returns:



1628
 
# File 'lib/aws/ec2/client.rb', line 1628

define_client_method :describe_image_attribute, 'DescribeImageAttribute'

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

Calls the DescribeImages API operation.

Options:

  • :image_ids - (Array<String>) An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.

  • :owners - (Array<String>) The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.

  • :executable_users - (Array<String>) The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user’s account ID, ‘self’ to return AMIs for which the sender of the request has explicit launch permissions, or ‘all’ to return AMIs with public launch permissions.

  • :filters - (Array<Hash>) A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :images_set - (Array<Hash>)

    • :image_id - (String)

    • :image_location - (String)

    • :image_state - (String)

    • :image_owner_id - (String)

    • :is_public - (Boolean)

    • :product_codes - (Array<Hash>)

      • :product_code - (String)

      • :type - (String)

    • :architecture - (String)

    • :image_type - (String)

    • :kernel_id - (String)

    • :ramdisk_id - (String)

    • :platform - (String)

    • :state_reason - (Hash)

      • :code - (String)

      • :message - (String)

    • :image_owner_alias - (String)

    • :name - (String)

    • :description - (String)

    • :root_device_type - (String)

    • :root_device_name - (String)

    • :block_device_mapping - (Array<Hash>)

      • :virtual_name - (String)

      • :device_name - (String)

      • :ebs - (Hash)

        • :snapshot_id - (String)

        • :volume_size - (Integer)

        • :delete_on_termination - (Boolean)

      • :no_device - (String)

    • :virtualization_type - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

    • :hypervisor - (String)

Returns:



1693
 
# File 'lib/aws/ec2/client.rb', line 1693

define_client_method :describe_images, 'DescribeImages'

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

Calls the DescribeInstanceAttribute API operation.

Options:

  • :instance_id - required - (String) The ID of the instance whose instance attribute is being described.

  • :attribute - required - (String) The name of the attribute to describe. Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping

Response Structure:

  • :instance_id - (String)

  • :instance_type - (Hash)

    • :value - (String)

  • :kernel - (Hash)

    • :value - (String)

  • :ramdisk - (Hash)

    • :value - (String)

  • :user_data - (Hash)

    • :value - (String)

  • :disable_api_termination - (Hash)

    • :value - (Boolean)

  • :instance_initiated_shutdown_behavior - (Hash)

    • :value - (String)

  • :root_device_name - (Hash)

    • :value - (String)

  • :block_device_mapping - (Array<Hash>)

    • :device_name - (String)

    • :ebs - (Hash)

      • :volume_id - (String)

      • :status - (String)

      • :attach_time - (Time)

      • :delete_on_termination - (Boolean)

  • :product_codes - (Array<Hash>)

    • :product_code - (String)

    • :type - (String)

Returns:



1737
 
# File 'lib/aws/ec2/client.rb', line 1737

define_client_method :describe_instance_attribute, 'DescribeInstanceAttribute'

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

Calls the DescribeInstanceStatus API operation.

Options:

  • :instance_ids - (Array<String>) The list of instance IDs. If not specified, all instances are described.

  • :filters - (Array<Hash>) The list of filters to limit returned results.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

  • :next_token - (String) A string specifying the next paginated set of results to return.

  • :max_results - (Integer) The maximum number of paginated instance items per response.

Response Structure:

  • :instance_status_set - (Array<Hash>)

    • :instance_id - (String)

    • :availability_zone - (String)

    • :events_set - (Array<Hash>)

      • :code - (String)

      • :description - (String)

      • :not_before - (Time)

      • :not_after - (Time)

    • :instance_state - (Hash)

      • :code - (Integer)

      • :name - (String)

    • :system_status - (Hash)

      • :status - (String)

      • :details - (Array<Hash>)

        • :name - (String)

        • :status - (String)

    • :instance_status - (Hash)

      • :status - (String)

      • :details - (Array<Hash>)

        • :name - (String)

        • :status - (String)

  • :next_token - (String)

Returns:



1783
 
# File 'lib/aws/ec2/client.rb', line 1783

define_client_method :describe_instance_status, 'DescribeInstanceStatus'

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

Calls the DescribeInstances API operation.

Options:

  • :instance_ids - (Array<String>) An optional list of the instances to describe.

  • :filters - (Array<Hash>) A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :reservation_set - (Array<Hash>)

    • :reservation_id - (String)

    • :owner_id - (String)

    • :requester_id - (String)

    • :group_set - (Array<Hash>)

      • :group_name - (String)

      • :group_id - (String)

    • :instances_set - (Array<Hash>)

      • :instance_id - (String)

      • :image_id - (String)

      • :instance_state - (Hash)

        • :code - (Integer)

        • :name - (String)

      • :private_dns_name - (String)

      • :dns_name - (String)

      • :reason - (String)

      • :key_name - (String)

      • :ami_launch_index - (Integer)

      • :product_codes - (Array<Hash>)

        • :product_code - (String)

        • :type - (String)

      • :instance_type - (String)

      • :launch_time - (Time)

      • :placement - (Hash)

        • :availability_zone - (String)

        • :group_name - (String)

        • :tenancy - (String)

      • :kernel_id - (String)

      • :ramdisk_id - (String)

      • :platform - (String)

      • :monitoring - (Hash)

        • :state - (String)

      • :subnet_id - (String)

      • :vpc_id - (String)

      • :private_ip_address - (String)

      • :ip_address - (String)

      • :state_reason - (Hash)

        • :code - (String)

        • :message - (String)

      • :architecture - (String)

      • :root_device_type - (String)

      • :root_device_name - (String)

      • :block_device_mapping - (Array<Hash>)

        • :device_name - (String)

        • :ebs - (Hash)

          • :volume_id - (String)

          • :status - (String)

          • :attach_time - (Time)

          • :delete_on_termination - (Boolean)

      • :virtualization_type - (String)

      • :instance_lifecycle - (String)

      • :spot_instance_request_id - (String)

      • :license - (Hash)

        • :pool - (String)

      • :client_token - (String)

      • :tag_set - (Array<Hash>)

        • :key - (String)

        • :value - (String)

      • :group_set - (Array<Hash>)

        • :group_name - (String)

        • :group_id - (String)

      • :source_dest_check - (Boolean)

      • :hypervisor - (String)

      • :network_interface_set - (Array<Hash>)

        • :network_interface_id - (String)

        • :subnet_id - (String)

        • :vpc_id - (String)

        • :description - (String)

        • :owner_id - (String)

        • :status - (String)

        • :private_ip_address - (String)

        • :private_dns_name - (String)

        • :source_dest_check - (Boolean)

        • :group_set - (Array<Hash>)

          • :group_name - (String)

          • :group_id - (String)

        • :attachment - (Hash)

          • :attachment_id - (String)

          • :device_index - (Integer)

          • :status - (String)

          • :attach_time - (Time)

          • :delete_on_termination - (Boolean)

        • :association - (Hash)

          • :public_ip - (String)

          • :ip_owner_id - (String)

Returns:



1889
 
# File 'lib/aws/ec2/client.rb', line 1889

define_client_method :describe_instances, 'DescribeInstances'

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

Calls the DescribeInternetGateways API operation.

Options:

  • :internet_gateway_ids - (Array<String>) One or more Internet gateway IDs.

  • :filters - (Array<Hash>) A list of filters used to match properties for Internet Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :internet_gateway_set - (Array<Hash>)

    • :internet_gateway_id - (String)

    • :attachment_set - (Array<Hash>)

      • :vpc_id - (String)

      • :state - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



1918
 
# File 'lib/aws/ec2/client.rb', line 1918

define_client_method :describe_internet_gateways, 'DescribeInternetGateways'

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

Calls the DescribeKeyPairs API operation.

Options:

  • :key_names - (Array<String>) The optional list of key pair names to describe.

  • :filters - (Array<Hash>) A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :key_set - (Array<Hash>)

    • :key_name - (String)

    • :key_fingerprint - (String)

Returns:



1942
 
# File 'lib/aws/ec2/client.rb', line 1942

define_client_method :describe_key_pairs, 'DescribeKeyPairs'

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

Calls the DescribeLicenses API operation.

Options:

  • :license_ids - (Array<String>) Specifies the license registration for which details are to be returned.

  • :filters - (Array<Hash>) A list of filters used to match properties for Licenses. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :license_set - (Array<Hash>)

    • :license_id - (String)

    • :type - (String)

    • :pool - (String)

    • :capacity_set - (Array<Hash>)

      • :capacity - (Integer)

      • :instance_capacity - (Integer)

      • :state - (String)

      • :earliest_allowed_deactivation_time - (Time)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



1975
 
# File 'lib/aws/ec2/client.rb', line 1975

define_client_method :describe_licenses, 'DescribeLicenses'

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

Calls the DescribeNetworkAcls API operation.

Options:

  • :network_acl_ids - (Array<String>) One or more network ACL IDs.

  • :filters - (Array<Hash>) A list of filters used to match properties for Network ACLs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :network_acl_set - (Array<Hash>)

    • :network_acl_id - (String)

    • :vpc_id - (String)

    • :default - (Boolean)

    • :entry_set - (Array<Hash>)

      • :rule_number - (Integer)

      • :protocol - (String)

      • :rule_action - (String)

      • :egress - (Boolean)

      • :cidr_block - (String)

      • :icmp_type_code - (Hash)

        • :type - (Integer)

        • :code - (Integer)

      • :port_range - (Hash)

        • :from - (Integer)

        • :to - (Integer)

    • :association_set - (Array<Hash>)

      • :network_acl_association_id - (String)

      • :network_acl_id - (String)

      • :subnet_id - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



2018
 
# File 'lib/aws/ec2/client.rb', line 2018

define_client_method :describe_network_acls, 'DescribeNetworkAcls'

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

Calls the DescribeNetworkInterfaceAttribute API operation.

Options:

  • :network_interface_id - required - (String)

  • :description - (String)

  • :source_dest_check - (String)

  • :groups - (String)

  • :attachment - (String)

Response Structure:

  • :network_interface_id - (String)

  • :description - (Hash)

    • :value - (String)

  • :source_dest_check - (Hash)

    • :value - (Boolean)

  • :group_set - (Array<Hash>)

    • :group_name - (String)

    • :group_id - (String)

  • :attachment - (Hash)

    • :attachment_id - (String)

    • :instance_id - (String)

    • :instance_owner_id - (String)

    • :device_index - (Integer)

    • :status - (String)

    • :attach_time - (Time)

    • :delete_on_termination - (Boolean)

Returns:



2052
 
# File 'lib/aws/ec2/client.rb', line 2052

define_client_method :describe_network_interface_attribute, 'DescribeNetworkInterfaceAttribute'

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

Calls the DescribeNetworkInterfaces API operation.

Options:

  • :network_interface_ids - (Array<String>)

  • :filters - (Array<Hash>)

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :network_interface_set - (Array<Hash>)

    • :network_interface_id - (String)

    • :subnet_id - (String)

    • :vpc_id - (String)

    • :availability_zone - (String)

    • :description - (String)

    • :owner_id - (String)

    • :requester_id - (String)

    • :requester_managed - (Boolean)

    • :status - (String)

    • :mac_address - (String)

    • :private_ip_address - (String)

    • :private_dns_name - (String)

    • :source_dest_check - (Boolean)

    • :groups - (Array<Hash>)

      • :group_name - (String)

      • :group_id - (String)

    • :attachment - (Hash)

      • :attachment_id - (String)

      • :instance_id - (String)

      • :instance_owner_id - (String)

      • :device_index - (Integer)

      • :status - (String)

      • :attach_time - (Time)

      • :delete_on_termination - (Boolean)

    • :association - (Hash)

      • :public_ip - (String)

      • :ip_owner_id - (String)

      • :allocation_id - (String)

      • :association_id - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



2103
 
# File 'lib/aws/ec2/client.rb', line 2103

define_client_method :describe_network_interfaces, 'DescribeNetworkInterfaces'

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

Calls the DescribePlacementGroups API operation.

Options:

  • :group_names - (Array<String>) The name of the PlacementGroup.

  • :filters - (Array<Hash>) A list of filters used to match properties for Placement Groups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :placement_group_set - (Array<Hash>)

    • :group_name - (String)

    • :strategy - (String)

    • :state - (String)

Returns:



2127
 
# File 'lib/aws/ec2/client.rb', line 2127

define_client_method :describe_placement_groups, 'DescribePlacementGroups'

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

Calls the DescribeRegions API operation.

Options:

  • :region_names - (Array<String>) The optional list of regions to describe.

  • :filters - (Array<Hash>) A list of filters used to match properties for Regions. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :region_info - (Array<Hash>)

    • :region_name - (String)

    • :region_endpoint - (String)

Returns:



2151
 
# File 'lib/aws/ec2/client.rb', line 2151

define_client_method :describe_regions, 'DescribeRegions'

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

Calls the DescribeReservedInstances API operation.

Options:

  • :reserved_instances_ids - (Array<String>) The optional list of Reserved Instance IDs to describe.

  • :filters - (Array<Hash>) A list of filters used to match properties for ReservedInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

  • :offering_type - (String) The Reserved Instance offering type.

Response Structure:

  • :reserved_instances_set - (Array<Hash>)

    • :reserved_instances_id - (String)

    • :instance_type - (String)

    • :availability_zone - (String)

    • :start - (Time)

    • :duration - (Integer)

    • :usage_price - (Numeric)

    • :fixed_price - (Numeric)

    • :instance_count - (Integer)

    • :product_description - (String)

    • :state - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

    • :instance_tenancy - (String)

    • :currency_code - (String)

    • :offering_type - (String)

    • :recurring_charges - (Array<Hash>)

      • :frequency - (String)

      • :amount - (Numeric)

Returns:



2193
 
# File 'lib/aws/ec2/client.rb', line 2193

define_client_method :describe_reserved_instances, 'DescribeReservedInstances'

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

Calls the DescribeReservedInstancesOfferings API operation.

Options:

  • :reserved_instances_offering_ids - (Array<String>) An optional list of the unique IDs of the Reserved Instance offerings to describe.

  • :instance_type - (String) The instance type on which the Reserved Instance can be used.

  • :availability_zone - (String) The Availability Zone in which the Reserved Instance can be used.

  • :product_description - (String) The Reserved Instance product description.

  • :filters - (Array<Hash>) A list of filters used to match properties for ReservedInstancesOfferings. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

  • :instance_tenancy - (String) The tenancy of the Reserved Instance offering. A Reserved Instance with tenancy of dedicated will run on single-tenant hardware and can only be launched within a VPC.

  • :offering_type - (String) The Reserved Instance offering type.

Response Structure:

  • :reserved_instances_offerings_set - (Array<Hash>)

    • :reserved_instances_offering_id - (String)

    • :instance_type - (String)

    • :availability_zone - (String)

    • :duration - (Integer)

    • :usage_price - (Numeric)

    • :fixed_price - (Numeric)

    • :product_description - (String)

    • :instance_tenancy - (String)

    • :currency_code - (String)

    • :offering_type - (String)

    • :recurring_charges - (Array<Hash>)

      • :frequency - (String)

      • :amount - (Numeric)

Returns:



2239
 
# File 'lib/aws/ec2/client.rb', line 2239

define_client_method :describe_reserved_instances_offerings, 'DescribeReservedInstancesOfferings'

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

Calls the DescribeRouteTables API operation.

Options:

  • :route_table_ids - (Array<String>) One or more route table IDs.

  • :filters - (Array<Hash>) A list of filters used to match properties for Route Tables. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :route_table_set - (Array<Hash>)

    • :route_table_id - (String)

    • :vpc_id - (String)

    • :route_set - (Array<Hash>)

      • :destination_cidr_block - (String)

      • :gateway_id - (String)

      • :instance_id - (String)

      • :instance_owner_id - (String)

      • :network_interface_id - (String)

      • :state - (String)

    • :association_set - (Array<Hash>)

      • :route_table_association_id - (String)

      • :route_table_id - (String)

      • :subnet_id - (String)

      • :main - (Boolean)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



2277
 
# File 'lib/aws/ec2/client.rb', line 2277

define_client_method :describe_route_tables, 'DescribeRouteTables'

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

Calls the DescribeSecurityGroups API operation.

Options:

  • :group_names - (Array<String>) The optional list of Amazon EC2 security groups to describe.

  • :group_ids - (Array<String>)

  • :filters - (Array<Hash>) A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :security_group_info - (Array<Hash>)

    • :owner_id - (String)

    • :group_name - (String)

    • :group_id - (String)

    • :group_description - (String)

    • :ip_permissions - (Array<Hash>)

      • :ip_protocol - (String)

      • :from_port - (Integer)

      • :to_port - (Integer)

      • :groups - (Array<Hash>)

        • :user_id - (String)

        • :group_name - (String)

        • :group_id - (String)

      • :ip_ranges - (Array<Hash>)

        • :cidr_ip - (String)

    • :ip_permissions_egress - (Array<Hash>)

      • :ip_protocol - (String)

      • :from_port - (Integer)

      • :to_port - (Integer)

      • :groups - (Array<Hash>)

        • :user_id - (String)

        • :group_name - (String)

        • :group_id - (String)

      • :ip_ranges - (Array<Hash>)

        • :cidr_ip - (String)

    • :vpc_id - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



2328
 
# File 'lib/aws/ec2/client.rb', line 2328

define_client_method :describe_security_groups, 'DescribeSecurityGroups'

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

Calls the DescribeSnapshotAttribute API operation.

Options:

  • :snapshot_id - required - (String) The ID of the EBS snapshot whose attribute is being described.

  • :attribute - required - (String) The name of the EBS attribute to describe. Available attribute names: createVolumePermission

Response Structure:

  • :snapshot_id - (String)

  • :create_volume_permission - (Array<Hash>)

    • :user_id - (String)

    • :group - (String)

  • :product_codes - (Array<Hash>)

    • :product_code - (String)

    • :type - (String)

Returns:



2352
 
# File 'lib/aws/ec2/client.rb', line 2352

define_client_method :describe_snapshot_attribute, 'DescribeSnapshotAttribute'

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

Calls the DescribeSnapshots API operation.

Options:

  • :snapshot_ids - (Array<String>) The optional list of EBS snapshot IDs to describe.

  • :owner_ids - (Array<String>) The optional list of EBS snapshot owners.

  • :restorable_by_user_ids - (Array<String>) The optional list of users who have permission to create volumes from the described EBS snapshots.

  • :filters - (Array<Hash>) A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :snapshot_set - (Array<Hash>)

    • :snapshot_id - (String)

    • :volume_id - (String)

    • :status - (String)

    • :start_time - (Time)

    • :progress - (String)

    • :owner_id - (String)

    • :description - (String)

    • :volume_size - (Integer)

    • :owner_alias - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



2391
 
# File 'lib/aws/ec2/client.rb', line 2391

define_client_method :describe_snapshots, 'DescribeSnapshots'

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

Calls the DescribeSpotDatafeedSubscription API operation.

Options:

This method accepts no options.

Response Structure:

  • :spot_datafeed_subscription - (Hash)

    • :owner_id - (String)

    • :bucket - (String)

    • :prefix - (String)

    • :state - (String)

    • :fault - (Hash)

      • :code - (String)

      • :message - (String)

Returns:



2413
 
# File 'lib/aws/ec2/client.rb', line 2413

define_client_method :describe_spot_datafeed_subscription, 'DescribeSpotDatafeedSubscription'

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

Calls the DescribeSpotInstanceRequests API operation.

Options:

  • :spot_instance_request_ids - (Array<String>) The ID of the request.

  • :filters - (Array<Hash>) A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :spot_instance_request_set - (Array<Hash>)

    • :spot_instance_request_id - (String)

    • :spot_price - (String)

    • :type - (String)

    • :state - (String)

    • :fault - (Hash)

      • :code - (String)

      • :message - (String)

    • :valid_from - (Time)

    • :valid_until - (Time)

    • :launch_group - (String)

    • :availability_zone_group - (String)

    • :launch_specification - (Hash)

      • :image_id - (String)

      • :key_name - (String)

      • :group_set - (Array<Hash>)

        • :group_name - (String)

        • :group_id - (String)

      • :user_data - (String)

      • :addressing_type - (String)

      • :instance_type - (String)

      • :placement - (Hash)

        • :availability_zone - (String)

        • :group_name - (String)

      • :kernel_id - (String)

      • :ramdisk_id - (String)

      • :block_device_mapping - (Array<Hash>)

        • :virtual_name - (String)

        • :device_name - (String)

        • :ebs - (Hash)

          • :snapshot_id - (String)

          • :volume_size - (Integer)

          • :delete_on_termination - (Boolean)

        • :no_device - (String)

      • :monitoring_enabled - (Boolean)

      • :subnet_id - (String)

      • :network_interface_set - (Array<Hash>)

        • :network_interface_id - (String)

        • :device_index - (Integer)

        • :subnet_id - (String)

        • :description - (String)

        • :private_ip_address - (String)

        • :security_group_id - (Array<String>)

        • :delete_on_termination - (Boolean)

    • :instance_id - (String)

    • :create_time - (Time)

    • :product_description - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

    • :launched_availability_zone - (String)

Returns:



2484
 
# File 'lib/aws/ec2/client.rb', line 2484

define_client_method :describe_spot_instance_requests, 'DescribeSpotInstanceRequests'

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

Calls the DescribeSpotPriceHistory API operation.

Options:

  • :start_time - (String<ISO8601 datetime>) The start date and time of the Spot Instance price history data.

  • :end_time - (String<ISO8601 datetime>) The end date and time of the Spot Instance price history data.

  • :instance_types - (Array<String>) Specifies the instance type to return.

  • :product_descriptions - (Array<String>) The description of the AMI.

  • :filters - (Array<Hash>) A list of filters used to match properties for SpotPriceHistory. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

  • :availability_zone - (String) Filters the results by availability zone (ex: ‘us-east-1a’).

  • :max_results - (Integer) Specifies the number of rows to return.

  • :next_token - (String) Specifies the next set of rows to return.

Response Structure:

  • :spot_price_history_set - (Array<Hash>)

    • :instance_type - (String)

    • :product_description - (String)

    • :spot_price - (String)

    • :timestamp - (Time)

    • :availability_zone - (String)

  • :next_token - (String)

Returns:



2521
 
# File 'lib/aws/ec2/client.rb', line 2521

define_client_method :describe_spot_price_history, 'DescribeSpotPriceHistory'

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

Calls the DescribeSubnets API operation.

Options:

  • :subnet_ids - (Array<String>) A set of one or more subnet IDs.

  • :filters - (Array<Hash>) A list of filters used to match properties for Subnets. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :subnet_set - (Array<Hash>)

    • :subnet_id - (String)

    • :state - (String)

    • :vpc_id - (String)

    • :cidr_block - (String)

    • :available_ip_address_count - (Integer)

    • :availability_zone - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



2551
 
# File 'lib/aws/ec2/client.rb', line 2551

define_client_method :describe_subnets, 'DescribeSubnets'

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

Calls the DescribeTags API operation.

Options:

  • :filters - (Array<Hash>) A list of filters used to match properties for tags.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :tag_set - (Array<Hash>)

    • :resource_id - (String)

    • :resource_type - (String)

    • :key - (String)

    • :value - (String)

Returns:



2574
 
# File 'lib/aws/ec2/client.rb', line 2574

define_client_method :describe_tags, 'DescribeTags'

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

Calls the DescribeVolumeAttribute API operation.

Options:

  • :volume_id - required - (String)

  • :attribute - (String)

Response Structure:

  • :volume_id - (String)

  • :auto_enable_io - (Hash)

    • :value - (Boolean)

  • :product_codes - (Array<Hash>)

    • :product_code - (String)

    • :type - (String)

Returns:



2595
 
# File 'lib/aws/ec2/client.rb', line 2595

define_client_method :describe_volume_attribute, 'DescribeVolumeAttribute'

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

Calls the DescribeVolumeStatus API operation.

Options:

  • :volume_ids - (Array<String>)

  • :filters - (Array<Hash>)

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

  • :next_token - (String)

  • :max_results - (Integer)

Response Structure:

  • :volume_status_set - (Array<Hash>)

    • :volume_id - (String)

    • :availability_zone - (String)

    • :volume_status - (Hash)

      • :status - (String)

      • :details - (Array<Hash>)

        • :name - (String)

        • :status - (String)

    • :events_set - (Array<Hash>)

      • :event_type - (String)

      • :description - (String)

      • :not_before - (Time)

      • :not_after - (Time)

      • :event_id - (String)

    • :actions_set - (Array<Hash>)

      • :code - (String)

      • :description - (String)

      • :event_type - (String)

      • :event_id - (String)

  • :next_token - (String)

Returns:



2635
 
# File 'lib/aws/ec2/client.rb', line 2635

define_client_method :describe_volume_status, 'DescribeVolumeStatus'

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

Calls the DescribeVolumes API operation.

Options:

  • :volume_ids - (Array<String>) The optional list of EBS volumes to describe.

  • :filters - (Array<Hash>) A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :volume_set - (Array<Hash>)

    • :volume_id - (String)

    • :size - (Integer)

    • :snapshot_id - (String)

    • :availability_zone - (String)

    • :status - (String)

    • :create_time - (Time)

    • :attachment_set - (Array<Hash>)

      • :volume_id - (String)

      • :instance_id - (String)

      • :device - (String)

      • :status - (String)

      • :attach_time - (Time)

      • :delete_on_termination - (Boolean)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



2673
 
# File 'lib/aws/ec2/client.rb', line 2673

define_client_method :describe_volumes, 'DescribeVolumes'

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

Calls the DescribeVpcs API operation.

Options:

  • :vpc_ids - (Array<String>) The ID of a VPC you want information about.

  • :filters - (Array<Hash>) A list of filters used to match properties for VPCs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :vpc_set - (Array<Hash>)

    • :vpc_id - (String)

    • :state - (String)

    • :cidr_block - (String)

    • :dhcp_options_id - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

    • :instance_tenancy - (String)

Returns:



2703
 
# File 'lib/aws/ec2/client.rb', line 2703

define_client_method :describe_vpcs, 'DescribeVpcs'

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

Calls the DescribeVpnConnections API operation.

Options:

  • :vpn_connection_ids - (Array<String>) A VPN connection ID. More than one may be specified per request.

  • :filters - (Array<Hash>) A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :vpn_connection_set - (Array<Hash>)

    • :vpn_connection_id - (String)

    • :state - (String)

    • :customer_gateway_configuration - (String)

    • :vpn_type - (String)

    • :customer_gateway_id - (String)

    • :vpn_gateway_id - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

    • :vgw_telemetry - (Array<Hash>)

      • :outside_ip_address - (String)

      • :status - (String)

      • :last_status_change - (Time)

      • :status_message - (String)

      • :accepted_route_count - (Integer)

Returns:



2740
 
# File 'lib/aws/ec2/client.rb', line 2740

define_client_method :describe_vpn_connections, 'DescribeVpnConnections'

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

Calls the DescribeVpnGateways API operation.

Options:

  • :vpn_gateway_ids - (Array<String>) A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

  • :filters - (Array<Hash>) A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    • :name - (String) Specifies the name of the filter.

    • :values - (Array<String>) Contains one or more values for the filter.

Response Structure:

  • :vpn_gateway_set - (Array<Hash>)

    • :vpn_gateway_id - (String)

    • :state - (String)

    • :vpn_type - (String)

    • :availability_zone - (String)

    • :attachments - (Array<Hash>)

      • :vpc_id - (String)

      • :state - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



2774
 
# File 'lib/aws/ec2/client.rb', line 2774

define_client_method :describe_vpn_gateways, 'DescribeVpnGateways'

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

Calls the DetachInternetGateway API operation.

Options:

  • :internet_gateway_id - required - (String) The ID of the Internet gateway to detach.

  • :vpc_id - required - (String) The ID of the VPC.

Response Structure:

This method returns no response data.

Returns:



2791
 
# File 'lib/aws/ec2/client.rb', line 2791

define_client_method :detach_internet_gateway, 'DetachInternetGateway'

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

Calls the DetachNetworkInterface API operation.

Options:

  • :attachment_id - required - (String)

  • :force - (Boolean)

Response Structure:

This method returns no response data.

Returns:



2807
 
# File 'lib/aws/ec2/client.rb', line 2807

define_client_method :detach_network_interface, 'DetachNetworkInterface'

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

Calls the DetachVolume API operation.

Options:

  • :volume_id - required - (String) The ID of the volume to detach.

  • :instance_id - (String) The ID of the instance from which to detach the the specified volume.

  • :device - (String) The device name to which the volume is attached on the specified instance.

  • :force - (Boolean) Forces detachment if the previous detachment attempt did not occur cleanly (logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures.

Response Structure:

  • :volume_id - (String)

  • :instance_id - (String)

  • :device - (String)

  • :status - (String)

  • :attach_time - (Time)

  • :delete_on_termination - (Boolean)

Returns:



2839
 
# File 'lib/aws/ec2/client.rb', line 2839

define_client_method :detach_volume, 'DetachVolume'

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

Calls the DetachVpnGateway API operation.

Options:

  • :vpn_gateway_id - required - (String) The ID of the VPN gateway to detach from the VPC.

  • :vpc_id - required - (String) The ID of the VPC to detach the VPN gateway from.

Response Structure:

This method returns no response data.

Returns:



2857
 
# File 'lib/aws/ec2/client.rb', line 2857

define_client_method :detach_vpn_gateway, 'DetachVpnGateway'

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

Calls the DisassociateAddress API operation.

Options:

  • :public_ip - (String) The elastic IP address that you are disassociating from the instance.

  • :association_id - (String) Association ID corresponding to the VPC elastic IP address you want to disassociate.

Response Structure:

This method returns no response data.

Returns:



2875
 
# File 'lib/aws/ec2/client.rb', line 2875

define_client_method :disassociate_address, 'DisassociateAddress'

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

Calls the DisassociateRouteTable API operation.

Options:

  • :association_id - required - (String) The association ID representing the current association between the route table and subnet.

Response Structure:

This method returns no response data.

Returns:



2892
 
# File 'lib/aws/ec2/client.rb', line 2892

define_client_method :disassociate_route_table, 'DisassociateRouteTable'

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

Calls the EnableVolumeIO API operation.

Options:

  • :volume_id - required - (String)

Response Structure:

This method returns no response data.

Returns:



2907
 
# File 'lib/aws/ec2/client.rb', line 2907

define_client_method :enable_volume_io, 'EnableVolumeIO'

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

Calls the GetConsoleOutput API operation.

Options:

  • :instance_id - required - (String) The ID of the instance for which you want console output.

Response Structure:

  • :instance_id - (String)

  • :timestamp - (Time)

  • :output - (String)

Returns:



2925
 
# File 'lib/aws/ec2/client.rb', line 2925

define_client_method :get_console_output, 'GetConsoleOutput'

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

Calls the GetPasswordData API operation.

Options:

  • :instance_id - required - (String) The ID of the instance for which you want the Windows administrator password.

Response Structure:

  • :instance_id - (String)

  • :timestamp - (Time)

  • :password_data - (String)

Returns:



2943
 
# File 'lib/aws/ec2/client.rb', line 2943

define_client_method :get_password_data, 'GetPasswordData'

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

Calls the ImportInstance API operation.

Options:

  • :description - (String)

  • :launch_specification - (Hash)

    • :architecture - (String)

    • :security_groups - (Array<String>)

    • :additional_info - (String)

    • :user_data - (String)

    • :instance_type - (String)

    • :placement - (Hash)

      • :availability_zone - (String) The availability zone in which an Amazon EC2 instance runs.

      • :group_name - (String) The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement groups are primarily used for launching High Performance Computing instances in the same group to ensure fast connection speeds.

      • :tenancy - (String) The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC will be launched as dedicated tenancy regardless of the tenancy assigned to the instance at launch.

    • :block_device_mappings - (Array<Hash>)

      • :virtual_name - (String) Specifies the virtual device name.

      • :device_name - (String) Specifies the device name (e.g., /dev/sdh).

      • :ebs - (Hash) Specifies parameters used to automatically setup Amazon EBS volumes when the instance is launched.

        • :snapshot_id - (String) The ID of the snapshot from which the volume will be created.

        • :volume_size - (Integer) The size of the volume, in gigabytes.

        • :delete_on_termination - (Boolean) Specifies whether the Amazon EBS volume is deleted on instance termination.

      • :no_device - (String) Specifies the device name to suppress during instance launch.

    • :monitoring - (Boolean)

    • :subnet_id - (String)

    • :disable_api_termination - (Boolean)

    • :instance_initiated_shutdown_behavior - (String)

    • :private_ip_address - (String)

  • :disk_images - (Array<Hash>)

    • :image - (Hash)

      • :format - required - (String)

      • :bytes - required - (Integer)

      • :import_manifest_url - required - (String)

    • :description - (String)

    • :volume - (Hash)

      • :size - required - (Integer)

  • :platform - required - (String)

Response Structure:

  • :conversion_task - (Hash)

    • :conversion_task_id - (String)

    • :expiration_time - (String)

    • :import_instance - (Hash)

      • :volumes - (Array<Hash>)

        • :bytes_converted - (Integer)

        • :availability_zone - (String)

        • :image - (Hash)

          • :format - (String)

          • :size - (Integer)

          • :import_manifest_url - (String)

          • :checksum - (String)

        • :volume - (Hash)

          • :size - (Integer)

          • :id - (String)

        • :status - (String)

        • :status_message - (String)

        • :description - (String)

      • :instance_id - (String)

      • :platform - (String)

      • :description - (String)

    • :import_volume - (Hash)

      • :bytes_converted - (Integer)

      • :availability_zone - (String)

      • :description - (String)

      • :image - (Hash)

        • :format - (String)

        • :size - (Integer)

        • :import_manifest_url - (String)

        • :checksum - (String)

      • :volume - (Hash)

        • :size - (Integer)

        • :id - (String)

    • :state - (String)

    • :status_message - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



3041
 
# File 'lib/aws/ec2/client.rb', line 3041

define_client_method :import_instance, 'ImportInstance'

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

Calls the ImportKeyPair API operation.

Options:

  • :key_name - required - (String) The unique name for the key pair.

  • :public_key_material - required - (String) The public key portion of the key pair being imported.

Response Structure:

  • :key_name - (String)

  • :key_fingerprint - (String)

Returns:



3059
 
# File 'lib/aws/ec2/client.rb', line 3059

define_client_method :import_key_pair, 'ImportKeyPair'

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

Calls the ImportVolume API operation.

Options:

  • :availability_zone - (String)

  • :image - (Hash)

    • :format - required - (String)

    • :bytes - required - (Integer)

    • :import_manifest_url - required - (String)

  • :description - (String)

  • :volume - (Hash)

    • :size - required - (Integer)

Response Structure:

  • :conversion_task - (Hash)

    • :conversion_task_id - (String)

    • :expiration_time - (String)

    • :import_instance - (Hash)

      • :volumes - (Array<Hash>)

        • :bytes_converted - (Integer)

        • :availability_zone - (String)

        • :image - (Hash)

          • :format - (String)

          • :size - (Integer)

          • :import_manifest_url - (String)

          • :checksum - (String)

        • :volume - (Hash)

          • :size - (Integer)

          • :id - (String)

        • :status - (String)

        • :status_message - (String)

        • :description - (String)

      • :instance_id - (String)

      • :platform - (String)

      • :description - (String)

    • :import_volume - (Hash)

      • :bytes_converted - (Integer)

      • :availability_zone - (String)

      • :description - (String)

      • :image - (Hash)

        • :format - (String)

        • :size - (Integer)

        • :import_manifest_url - (String)

        • :checksum - (String)

      • :volume - (Hash)

        • :size - (Integer)

        • :id - (String)

    • :state - (String)

    • :status_message - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

Returns:



3118
 
# File 'lib/aws/ec2/client.rb', line 3118

define_client_method :import_volume, 'ImportVolume'

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

Calls the ModifyImageAttribute API operation.

Options:

  • :image_id - required - (String) The ID of the AMI whose attribute you want to modify.

  • :attribute - (String) The name of the AMI attribute you want to modify. Available attributes: launchPermission, productCodes

  • :operation_type - (String) The type of operation being requested. Available operation types: add, remove

  • :user_ids - (Array<String>) The AWS user ID being added to or removed from the list of users with launch permissions for this AMI. Only valid when the launchPermission attribute is being modified.

  • :user_groups - (Array<String>) The user group being added to or removed from the list of user groups with launch permissions for this AMI. Only valid when the launchPermission attribute is being modified. Available user groups: all

  • :product_codes - (Array<String>) The list of product codes being added to or removed from the specified AMI. Only valid when the productCodes attribute is being modified.

  • :value - (String) The value of the attribute being modified. Only valid when the description attribute is being modified.

  • :launch_permission - (Hash)

    • :add - (Array<Hash>)

      • :user_id - (String) The AWS user ID of the user involved in this launch permission.

      • :group - (String) The AWS group of the user involved in this launch permission. Available groups: all

    • :remove - (Array<Hash>)

      • :user_id - (String) The AWS user ID of the user involved in this launch permission.

      • :group - (String) The AWS group of the user involved in this launch permission. Available groups: all

  • :description - (Hash)

    • :value - (String) String value

Response Structure:

This method returns no response data.

Returns:



3163
 
# File 'lib/aws/ec2/client.rb', line 3163

define_client_method :modify_image_attribute, 'ModifyImageAttribute'

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

Calls the ModifyInstanceAttribute API operation.

Options:

  • :instance_id - required - (String) The ID of the instance whose attribute is being modified.

  • :attribute - (String) The name of the attribute being modified. Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDevice, blockDeviceMapping

  • :value - (String) The new value of the instance attribute being modified. Only valid when kernel, ramdisk, userData, disableApiTermination or instanceInitiateShutdownBehavior is specified as the attribute being modified.

  • :block_device_mappings - (Array<Hash>) The new block device mappings for the instance whose attributes are being modified. Only valid when blockDeviceMapping is specified as the attribute being modified.

    • :device_name - (String) The device name (e.g., /dev/sdh) at which the block device is exposed on the instance.

    • :ebs - (Hash) The EBS instance block device specification describing the EBS block device to map to the specified device name on a running instance.

      • :volume_id - (String) The ID of the EBS volume that should be mounted as a block device on an Amazon EC2 instance.

      • :delete_on_termination - (Boolean) Specifies whether the Amazon EBS volume is deleted on instance termination.

    • :virtual_name - (String) The virtual device name.

    • :no_device - (String) When set to the empty string, specifies that the device name in this object should not be mapped to any real device.

  • :source_dest_check - (Hash)

    • :value - (Boolean) Boolean value

  • :disable_api_termination - (Hash)

    • :value - (Boolean) Boolean value

  • :instance_type - (Hash)

    • :value - (String) String value

  • :kernel - (Hash)

    • :value - (String) String value

  • :ramdisk - (Hash)

    • :value - (String) String value

  • :user_data - (Hash)

    • :value - (String) String value

  • :instance_initiated_shutdown_behavior - (Hash)

    • :value - (String) String value

  • :groups - (Array<String>)

Response Structure:

This method returns no response data.

Returns:



3219
 
# File 'lib/aws/ec2/client.rb', line 3219

define_client_method :modify_instance_attribute, 'ModifyInstanceAttribute'

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

Calls the ModifyNetworkInterfaceAttribute API operation.

Options:

  • :network_interface_id - required - (String)

  • :description - (Hash)

    • :value - (String) String value

  • :source_dest_check - (Hash)

    • :value - (Boolean) Boolean value

  • :groups - (Array<String>)

  • :attachment - (Hash)

    • :attachment_id - (String)

    • :delete_on_termination - (Boolean)

Response Structure:

This method returns no response data.

Returns:



3242
 
# File 'lib/aws/ec2/client.rb', line 3242

define_client_method :modify_network_interface_attribute, 'ModifyNetworkInterfaceAttribute'

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

Calls the ModifySnapshotAttribute API operation.

Options:

  • :snapshot_id - required - (String) The ID of the EBS snapshot whose attributes are being modified.

  • :attribute - (String) The name of the attribute being modified. Available attribute names: createVolumePermission

  • :operation_type - (String) The operation to perform on the attribute. Available operation names: add, remove

  • :user_ids - (Array<String>) The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports “all”. Only valid when the createVolumePermission attribute is being modified.

  • :group_names - (Array<String>) The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports “all”. Only valid when the createVolumePermission attribute is being modified.

  • :create_volume_permission - (Hash)

    • :add - (Array<Hash>)

      • :user_id - (String) The user ID of the user that can create volumes from the snapshot.

      • :group - (String) The group that is allowed to create volumes from the snapshot (currently supports “all”).

    • :remove - (Array<Hash>)

      • :user_id - (String) The user ID of the user that can create volumes from the snapshot.

      • :group - (String) The group that is allowed to create volumes from the snapshot (currently supports “all”).

Response Structure:

This method returns no response data.

Returns:



3281
 
# File 'lib/aws/ec2/client.rb', line 3281

define_client_method :modify_snapshot_attribute, 'ModifySnapshotAttribute'

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

Calls the ModifyVolumeAttribute API operation.

Options:

  • :volume_id - required - (String)

  • :auto_enable_io - (Boolean)

Response Structure:

This method returns no response data.

Returns:



3297
 
# File 'lib/aws/ec2/client.rb', line 3297

define_client_method :modify_volume_attribute, 'ModifyVolumeAttribute'

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

Calls the MonitorInstances API operation.

Options:

  • :instance_ids - required - (Array<String>) The list of Amazon EC2 instances on which to enable monitoring.

Response Structure:

  • :instances_set - (Array<Hash>)

    • :instance_id - (String)

    • :monitoring - (Hash)

      • :state - (String)

Returns:



3316
 
# File 'lib/aws/ec2/client.rb', line 3316

define_client_method :monitor_instances, 'MonitorInstances'

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

Calls the PurchaseReservedInstancesOffering API operation.

Options:

  • :reserved_instances_offering_id - required - (String) The unique ID of the Reserved Instances offering being purchased.

  • :instance_count - required - (Integer) The number of Reserved Instances to purchase.

Response Structure:

  • :reserved_instances_id - (String)

Returns:



3334
 
# File 'lib/aws/ec2/client.rb', line 3334

define_client_method :purchase_reserved_instances_offering, 'PurchaseReservedInstancesOffering'

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

Calls the RebootInstances API operation.

Options:

  • :instance_ids - required - (Array<String>) The list of instances to terminate.

Response Structure:

This method returns no response data.

Returns:



3350
 
# File 'lib/aws/ec2/client.rb', line 3350

define_client_method :reboot_instances, 'RebootInstances'

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

Calls the RegisterImage API operation.

Options:

  • :image_location - (String) The full path to your AMI manifest in Amazon S3 storage.

  • :name - (String) The name to give the new Amazon Machine Image. Constraints: 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores(_)

  • :description - (String) The description describing the new AMI.

  • :architecture - (String) The architecture of the image. Valid Values: i386, x86_64

  • :kernel_id - (String) The optional ID of a specific kernel to register with the new AMI.

  • :ramdisk_id - (String) The optional ID of a specific ramdisk to register with the new AMI. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk.

  • :root_device_name - (String) The root device name (e.g., /dev/sda1).

  • :block_device_mappings - (Array<Hash>) The block device mappings for the new AMI, which specify how different block devices (ex: EBS volumes and ephemeral drives) will be exposed on instances launched from the new image.

    • :virtual_name - (String) Specifies the virtual device name.

    • :device_name - (String) Specifies the device name (e.g., /dev/sdh).

    • :ebs - (Hash) Specifies parameters used to automatically setup Amazon EBS volumes when the instance is launched.

      • :snapshot_id - (String) The ID of the snapshot from which the volume will be created.

      • :volume_size - (Integer) The size of the volume, in gigabytes.

      • :delete_on_termination - (Boolean) Specifies whether the Amazon EBS volume is deleted on instance termination.

    • :no_device - (String) Specifies the device name to suppress during instance launch.

Response Structure:

  • :image_id - (String)

Returns:



3396
 
# File 'lib/aws/ec2/client.rb', line 3396

define_client_method :register_image, 'RegisterImage'

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

Calls the ReleaseAddress API operation.

Options:

  • :public_ip - (String) The elastic IP address that you are releasing from your account.

  • :allocation_id - (String) The allocation ID that AWS provided when you allocated the address for use with Amazon VPC.

Response Structure:

This method returns no response data.

Returns:



3414
 
# File 'lib/aws/ec2/client.rb', line 3414

define_client_method :release_address, 'ReleaseAddress'

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

Calls the ReplaceNetworkAclAssociation API operation.

Options:

  • :association_id - required - (String) The ID representing the current association between the original network ACL and the subnet.

  • :network_acl_id - required - (String) The ID of the new ACL to associate with the subnet.

Response Structure:

  • :new_association_id - (String)

Returns:



3432
 
# File 'lib/aws/ec2/client.rb', line 3432

define_client_method :replace_network_acl_association, 'ReplaceNetworkAclAssociation'

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

Calls the ReplaceNetworkAclEntry API operation.

Options:

  • :network_acl_id - required - (String) ID of the ACL where the entry will be replaced.

  • :rule_number - required - (Integer) Rule number of the entry to replace.

  • :protocol - required - (String) IP protocol the rule applies to. Valid Values: tcp, udp, icmp or an IP protocol number.

  • :rule_action - required - (String) Whether to allow or deny traffic that matches the rule.

  • :egress - required - (Boolean) Whether this rule applies to egress traffic from the subnet ( true ) or ingress traffic ( false ).

  • :cidr_block - required - (String) The CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).

  • :icmp_type_code - (Hash) ICMP values.

    • :type - (Integer) For the ICMP protocol, the ICMP type. A value of -1 is a wildcard meaning all types. Required if specifying icmp for the protocol.

    • :code - (Integer) For the ICMP protocol, the ICMP code. A value of -1 is a wildcard meaning all codes. Required if specifying icmp for the protocol.

  • :port_range - (Hash) Port ranges.

    • :from - (Integer) The first port in the range. Required if specifying tcp or udp for the protocol.

    • :to - (Integer) The last port in the range. Required if specifying tcp or udp for the protocol.

Response Structure:

This method returns no response data.

Returns:



3471
 
# File 'lib/aws/ec2/client.rb', line 3471

define_client_method :replace_network_acl_entry, 'ReplaceNetworkAclEntry'

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

Calls the ReplaceRoute API operation.

Options:

  • :route_table_id - required - (String) The ID of the route table where the route will be replaced.

  • :destination_cidr_block - required - (String) The CIDR address block used for the destination match. For example: 0.0.0.0/0. The value you provide must match the CIDR of an existing route in the table.

  • :gateway_id - (String) The ID of a VPN or Internet gateway attached to your VPC.

  • :instance_id - (String) The ID of a NAT instance in your VPC.

  • :network_interface_id - (String)

Response Structure:

This method returns no response data.

Returns:



3495
 
# File 'lib/aws/ec2/client.rb', line 3495

define_client_method :replace_route, 'ReplaceRoute'

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

Calls the ReplaceRouteTableAssociation API operation.

Options:

  • :association_id - required - (String) The ID representing the current association between the original route table and the subnet.

  • :route_table_id - required - (String) The ID of the new route table to associate with the subnet.

Response Structure:

  • :new_association_id - (String)

Returns:



3513
 
# File 'lib/aws/ec2/client.rb', line 3513

define_client_method :replace_route_table_association, 'ReplaceRouteTableAssociation'

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

Calls the ReportInstanceStatus API operation.

Options:

  • :instances - (Array<String>)

  • :status - (String)

  • :start_time - (String<ISO8601 datetime>)

  • :end_time - (String<ISO8601 datetime>)

  • :reason_codes - (Array<String>)

  • :description - (String)

Response Structure:

This method returns no response data.

Returns:



3533
 
# File 'lib/aws/ec2/client.rb', line 3533

define_client_method :report_instance_status, 'ReportInstanceStatus'

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

Calls the RequestSpotInstances API operation.

Options:

  • :spot_price - required - (String) Specifies the maximum hourly price for any Spot Instance launched to fulfill the request.

  • :instance_count - (Integer) Specifies the maximum number of Spot Instances to launch.

  • :type - (String) Specifies the Spot Instance type.

  • :valid_from - (String<ISO8601 datetime>) Defines the start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

  • :valid_until - (String<ISO8601 datetime>) End date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

  • :launch_group - (String) Specifies the instance launch group. Launch groups are Spot Instances that launch and terminate together.

  • :availability_zone_group - (String) Specifies the Availability Zone group. When specifying the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

  • :launch_specification - (Hash) Specifies additional launch instance information.

    • :image_id - (String) The AMI ID.

    • :key_name - (String) The name of the key pair.

    • :security_groups - (Array<Hash>)

      • :group_name - (String)

      • :group_id - (String)

    • :user_data - (String) Optional data, specific to a user’s application, to provide in the launch request. All instances that collectively comprise the launch request have access to this data. User data is never returned through API responses.

    • :addressing_type - (String) Deprecated.

    • :instance_type - (String) Specifies the instance type.

    • :placement - (Hash) Defines a placement item.

      • :availability_zone - (String) The availability zone in which an Amazon EC2 instance runs.

      • :group_name - (String) The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement groups are primarily used for launching High Performance Computing instances in the same group to ensure fast connection speeds.

    • :kernel_id - (String) Specifies the ID of the kernel to select.

    • :ramdisk_id - (String) Specifies the ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether or not you need to specify a RAM disk and search for the kernel ID.

    • :block_device_mappings - (Array<Hash>) Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.

      • :virtual_name - (String) Specifies the virtual device name.

      • :device_name - (String) Specifies the device name (e.g., /dev/sdh).

      • :ebs - (Hash) Specifies parameters used to automatically setup Amazon EBS volumes when the instance is launched.

        • :snapshot_id - (String) The ID of the snapshot from which the volume will be created.

        • :volume_size - (Integer) The size of the volume, in gigabytes.

        • :delete_on_termination - (Boolean) Specifies whether the Amazon EBS volume is deleted on instance termination.

      • :no_device - (String) Specifies the device name to suppress during instance launch.

    • :monitoring_enabled - (Boolean) Enables monitoring for the instance.

    • :subnet_id - (String) Specifies the Amazon VPC subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud.

    • :network_interfaces - (Array<Hash>)

      • :network_interface_id - (String)

      • :device_index - (Integer)

      • :subnet_id - (String)

      • :description - (String)

      • :private_ip_address - (String)

      • :groups - (Array<String>)

      • :delete_on_termination - (Boolean)

Response Structure:

  • :spot_instance_request_set - (Array<Hash>)

    • :spot_instance_request_id - (String)

    • :spot_price - (String)

    • :type - (String)

    • :state - (String)

    • :fault - (Hash)

      • :code - (String)

      • :message - (String)

    • :valid_from - (Time)

    • :valid_until - (Time)

    • :launch_group - (String)

    • :availability_zone_group - (String)

    • :launch_specification - (Hash)

      • :image_id - (String)

      • :key_name - (String)

      • :group_set - (Array<Hash>)

        • :group_name - (String)

        • :group_id - (String)

      • :user_data - (String)

      • :addressing_type - (String)

      • :instance_type - (String)

      • :placement - (Hash)

        • :availability_zone - (String)

        • :group_name - (String)

      • :kernel_id - (String)

      • :ramdisk_id - (String)

      • :block_device_mapping - (Array<Hash>)

        • :virtual_name - (String)

        • :device_name - (String)

        • :ebs - (Hash)

          • :snapshot_id - (String)

          • :volume_size - (Integer)

          • :delete_on_termination - (Boolean)

        • :no_device - (String)

      • :monitoring_enabled - (Boolean)

      • :subnet_id - (String)

      • :network_interface_set - (Array<Hash>)

        • :network_interface_id - (String)

        • :device_index - (Integer)

        • :subnet_id - (String)

        • :description - (String)

        • :private_ip_address - (String)

        • :security_group_id - (Array<String>)

        • :delete_on_termination - (Boolean)

    • :instance_id - (String)

    • :create_time - (Time)

    • :product_description - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

    • :launched_availability_zone - (String)

Returns:



3672
 
# File 'lib/aws/ec2/client.rb', line 3672

define_client_method :request_spot_instances, 'RequestSpotInstances'

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

Calls the ResetImageAttribute API operation.

Options:

  • :image_id - required - (String) The ID of the AMI whose attribute is being reset.

  • :attribute - required - (String) The name of the attribute being reset. Available attribute names: launchPermission

Response Structure:

This method returns no response data.

Returns:



3690
 
# File 'lib/aws/ec2/client.rb', line 3690

define_client_method :reset_image_attribute, 'ResetImageAttribute'

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

Calls the ResetInstanceAttribute API operation.

Options:

  • :instance_id - required - (String) The ID of the Amazon EC2 instance whose attribute is being reset.

  • :attribute - required - (String) The name of the attribute being reset. Available attribute names: kernel, ramdisk

Response Structure:

This method returns no response data.

Returns:



3708
 
# File 'lib/aws/ec2/client.rb', line 3708

define_client_method :reset_instance_attribute, 'ResetInstanceAttribute'

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

Calls the ResetNetworkInterfaceAttribute API operation.

Options:

  • :network_interface_id - required - (String)

  • :source_dest_check - (String)

Response Structure:

This method returns no response data.

Returns:



3724
 
# File 'lib/aws/ec2/client.rb', line 3724

define_client_method :reset_network_interface_attribute, 'ResetNetworkInterfaceAttribute'

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

Calls the ResetSnapshotAttribute API operation.

Options:

  • :snapshot_id - required - (String) The ID of the snapshot whose attribute is being reset.

  • :attribute - required - (String) The name of the attribute being reset. Available attribute names: createVolumePermission

Response Structure:

This method returns no response data.

Returns:



3742
 
# File 'lib/aws/ec2/client.rb', line 3742

define_client_method :reset_snapshot_attribute, 'ResetSnapshotAttribute'

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

Calls the RevokeSecurityGroupEgress API operation.

Options:

  • :group_id - required - (String) ID of the VPC security group to modify.

  • :source_security_group_name - (String) Deprecated.

  • :source_security_group_owner_id - (String) Deprecated.

  • :ip_protocol - (String) Deprecated.

  • :from_port - (Integer) Deprecated.

  • :to_port - (Integer) Deprecated.

  • :cidr_ip - (String) Deprecated.

  • :ip_permissions - (Array<Hash>) List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

    • :ip_protocol - (String) The IP protocol of this permission. Valid protocol values: tcp, udp, icmp

    • :from_port - (Integer) Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

    • :to_port - (Integer) End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

    • :user_id_group_pairs - (Array<Hash>) The list of AWS user IDs and groups included in this permission.

      • :user_id - (String) The AWS user ID of an account.

      • :group_name - (String) Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

      • :group_id - (String) ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

    • :ip_ranges - (Array<Hash>) The list of CIDR IP ranges included in this permission.

      • :cidr_ip - (String) The list of CIDR IP ranges.

Response Structure:

This method returns no response data.

Returns:



3788
 
# File 'lib/aws/ec2/client.rb', line 3788

define_client_method :revoke_security_group_egress, 'RevokeSecurityGroupEgress'

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

Calls the RevokeSecurityGroupIngress API operation.

Options:

  • :group_name - (String) Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.

  • :group_id - (String) ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.

  • :source_security_group_name - (String) Deprecated

  • :source_security_group_owner_id - (String) Deprecated

  • :ip_protocol - (String) Deprecated

  • :from_port - (Integer) Deprecated

  • :to_port - (Integer) Deprecated

  • :cidr_ip - (String) Deprecated

  • :ip_permissions - (Array<Hash>) List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.

    • :ip_protocol - (String) The IP protocol of this permission. Valid protocol values: tcp, udp, icmp

    • :from_port - (Integer) Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

    • :to_port - (Integer) End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

    • :user_id_group_pairs - (Array<Hash>) The list of AWS user IDs and groups included in this permission.

      • :user_id - (String) The AWS user ID of an account.

      • :group_name - (String) Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

      • :group_id - (String) ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

    • :ip_ranges - (Array<Hash>) The list of CIDR IP ranges included in this permission.

      • :cidr_ip - (String) The list of CIDR IP ranges.

Response Structure:

This method returns no response data.

Returns:



3841
 
# File 'lib/aws/ec2/client.rb', line 3841

define_client_method :revoke_security_group_ingress, 'RevokeSecurityGroupIngress'

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

Calls the RunInstances API operation.

Options:

  • :image_id - required - (String) Unique ID of a machine image, returned by a call to DescribeImages.

  • :min_count - required - (Integer) Minimum number of instances to launch. If the value is more than Amazon EC2 can launch, no instances are launched at all.

  • :max_count - required - (Integer) Maximum number of instances to launch. If the value is more than Amazon EC2 can launch, the largest possible number above minCount will be launched instead. Between 1 and the maximum number allowed for your account (default: 20).

  • :key_name - (String) The name of the key pair.

  • :security_groups - (Array<String>) The names of the security groups into which the instances will be launched.

  • :security_group_ids - (Array<String>)

  • :user_data - (String) Specifies additional information to make available to the instance(s).

  • :addressing_type - (String)

  • :instance_type - (String) Specifies the instance type for the launched instances.

  • :placement - (Hash) Specifies the placement constraints (Availability Zones) for launching the instances.

    • :availability_zone - (String) The availability zone in which an Amazon EC2 instance runs.

    • :group_name - (String) The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement groups are primarily used for launching High Performance Computing instances in the same group to ensure fast connection speeds.

    • :tenancy - (String) The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC will be launched as dedicated tenancy regardless of the tenancy assigned to the instance at launch.

  • :kernel_id - (String) The ID of the kernel with which to launch the instance.

  • :ramdisk_id - (String) The ID of the RAM disk with which to launch the instance. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk. To find kernel requirements, go to the Resource Center and search for the kernel ID.

  • :block_device_mappings - (Array<Hash>) Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.

    • :virtual_name - (String) Specifies the virtual device name.

    • :device_name - (String) Specifies the device name (e.g., /dev/sdh).

    • :ebs - (Hash) Specifies parameters used to automatically setup Amazon EBS volumes when the instance is launched.

      • :snapshot_id - (String) The ID of the snapshot from which the volume will be created.

      • :volume_size - (Integer) The size of the volume, in gigabytes.

      • :delete_on_termination - (Boolean) Specifies whether the Amazon EBS volume is deleted on instance termination.

    • :no_device - (String) Specifies the device name to suppress during instance launch.

  • :monitoring - (Hash) Enables monitoring for the instance.

    • :enabled - required - (Boolean)

  • :subnet_id - (String) Specifies the subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud.

  • :disable_api_termination - (Boolean) Specifies whether the instance can be terminated using the APIs. You must modify this attribute before you can terminate any “locked” instances from the APIs.

  • :instance_initiated_shutdown_behavior - (String) Specifies whether the instance’s Amazon EBS volumes are stopped or terminated when the instance is shut down.

  • :license - (Hash) Specifies active licenses in use and attached to an Amazon EC2 instance.

    • :pool - (String) The license pool from which to take a license when starting Amazon EC2 instances in the associated RunInstances request.

  • :private_ip_address - (String) If you’re using Amazon Virtual Private Cloud, you can optionally use this parameter to assign the instance a specific available IP address from the subnet.

  • :client_token - (String) Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, go to How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

  • :additional_info - (String)

  • :network_interfaces - (Array<Hash>)

    • :network_interface_id - (String)

    • :device_index - (Integer)

    • :subnet_id - (String)

    • :description - (String)

    • :private_ip_address - (String)

    • :groups - (Array<String>)

    • :delete_on_termination - (Boolean)

Response Structure:

  • :reservation_id - (String)

  • :owner_id - (String)

  • :requester_id - (String)

  • :group_set - (Array<Hash>)

    • :group_name - (String)

    • :group_id - (String)

  • :instances_set - (Array<Hash>)

    • :instance_id - (String)

    • :image_id - (String)

    • :instance_state - (Hash)

      • :code - (Integer)

      • :name - (String)

    • :private_dns_name - (String)

    • :dns_name - (String)

    • :reason - (String)

    • :key_name - (String)

    • :ami_launch_index - (Integer)

    • :product_codes - (Array<Hash>)

      • :product_code - (String)

      • :type - (String)

    • :instance_type - (String)

    • :launch_time - (Time)

    • :placement - (Hash)

      • :availability_zone - (String)

      • :group_name - (String)

      • :tenancy - (String)

    • :kernel_id - (String)

    • :ramdisk_id - (String)

    • :platform - (String)

    • :monitoring - (Hash)

      • :state - (String)

    • :subnet_id - (String)

    • :vpc_id - (String)

    • :private_ip_address - (String)

    • :ip_address - (String)

    • :state_reason - (Hash)

      • :code - (String)

      • :message - (String)

    • :architecture - (String)

    • :root_device_type - (String)

    • :root_device_name - (String)

    • :block_device_mapping - (Array<Hash>)

      • :device_name - (String)

      • :ebs - (Hash)

        • :volume_id - (String)

        • :status - (String)

        • :attach_time - (Time)

        • :delete_on_termination - (Boolean)

    • :virtualization_type - (String)

    • :instance_lifecycle - (String)

    • :spot_instance_request_id - (String)

    • :license - (Hash)

      • :pool - (String)

    • :client_token - (String)

    • :tag_set - (Array<Hash>)

      • :key - (String)

      • :value - (String)

    • :group_set - (Array<Hash>)

      • :group_name - (String)

      • :group_id - (String)

    • :source_dest_check - (Boolean)

    • :hypervisor - (String)

    • :network_interface_set - (Array<Hash>)

      • :network_interface_id - (String)

      • :subnet_id - (String)

      • :vpc_id - (String)

      • :description - (String)

      • :owner_id - (String)

      • :status - (String)

      • :private_ip_address - (String)

      • :private_dns_name - (String)

      • :source_dest_check - (Boolean)

      • :group_set - (Array<Hash>)

        • :group_name - (String)

        • :group_id - (String)

      • :attachment - (Hash)

        • :attachment_id - (String)

        • :device_index - (Integer)

        • :status - (String)

        • :attach_time - (Time)

        • :delete_on_termination - (Boolean)

      • :association - (Hash)

        • :public_ip - (String)

        • :ip_owner_id - (String)

Returns:



4022
 
# File 'lib/aws/ec2/client.rb', line 4022

define_client_method :run_instances, 'RunInstances'

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

Calls the StartInstances API operation.

Options:

  • :instance_ids - required - (Array<String>) The list of Amazon EC2 instances to start.

Response Structure:

  • :instances_set - (Array<Hash>)

    • :instance_id - (String)

    • :current_state - (Hash)

      • :code - (Integer)

      • :name - (String)

    • :previous_state - (Hash)

      • :code - (Integer)

      • :name - (String)

Returns:



4045
 
# File 'lib/aws/ec2/client.rb', line 4045

define_client_method :start_instances, 'StartInstances'

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

Calls the StopInstances API operation.

Options:

  • :instance_ids - required - (Array<String>) The list of Amazon EC2 instances to stop.

  • :force - (Boolean) Forces the instance to stop. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Response Structure:

  • :instances_set - (Array<Hash>)

    • :instance_id - (String)

    • :current_state - (Hash)

      • :code - (Integer)

      • :name - (String)

    • :previous_state - (Hash)

      • :code - (Integer)

      • :name - (String)

Returns:



4073
 
# File 'lib/aws/ec2/client.rb', line 4073

define_client_method :stop_instances, 'StopInstances'

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

Calls the TerminateInstances API operation.

Options:

  • :instance_ids - required - (Array<String>) The list of instances to terminate.

Response Structure:

  • :instances_set - (Array<Hash>)

    • :instance_id - (String)

    • :current_state - (Hash)

      • :code - (Integer)

      • :name - (String)

    • :previous_state - (Hash)

      • :code - (Integer)

      • :name - (String)

Returns:



4096
 
# File 'lib/aws/ec2/client.rb', line 4096

define_client_method :terminate_instances, 'TerminateInstances'

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

Calls the UnmonitorInstances API operation.

Options:

  • :instance_ids - required - (Array<String>) The list of Amazon EC2 instances on which to disable monitoring.

Response Structure:

  • :instances_set - (Array<Hash>)

    • :instance_id - (String)

    • :monitoring - (Hash)

      • :state - (String)

Returns:



4115
 
# File 'lib/aws/ec2/client.rb', line 4115

define_client_method :unmonitor_instances, 'UnmonitorInstances'