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

Class: AWS::EC2::Client

Inherits:
Core::QueryClient show all
Defined in:
lib/aws/ec2/client.rb

Overview

Client class for Amazon Elastic Compute Cloud (EC2).

Defined Under Namespace

Classes: V20130815, V20131001, V20131015, V20140201, V20140501, V20140901, V20141001

Constant Summary

API_VERSION = 
'2014-10-01'

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

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

Instance Method Details

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

Calls the AcceptVpcPeeringConnection API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_peering_connection_id - (String) The ID of the VPC peering connection.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpc_peering_connection - (Hash)
      • :accepter_vpc_info - (Hash)
        • :cidr_block - (String)
        • :owner_id - (String)
        • :vpc_id - (String)
      • :expiration_time - (Time)
      • :requester_vpc_info - (Hash)
        • :cidr_block - (String)
        • :owner_id - (String)
        • :vpc_id - (String)
      • :status - (Hash)
        • :code - (String)
        • :message - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :vpc_peering_connection_id - (String)

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

Calls the AllocateAddress API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :domain - (String) Set to vpc to allocate the address for use with instances in a VPC. Default: The address is for use with instances in EC2-Classic. Valid values include:
      • vpc
      • standard

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :public_ip - (String)
    • :domain - (String)
    • :allocation_id - (String)

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

Calls the AssignPrivateIpAddresses API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :network_interface_id - required - (String) The ID of the network interface.
    • :private_ip_addresses - (Array<) One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses. If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
    • :secondary_private_ip_address_count - (Integer) The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
    • :allow_reassignment - (Boolean) Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Returns:

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

Calls the AssociateAddress API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - (String) The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
    • :public_ip - (String) The Elastic IP address. This is required for EC2-Classic.
    • :allocation_id - (String) [EC2-VPC] The allocation ID. This is required for EC2-VPC.
    • :network_interface_id - (String) [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
    • :private_ip_address - (String) [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
    • :allow_reassociation - (Boolean) [EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails. Default: false

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :association_id - (String)

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

Calls the AssociateDhcpOptions API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :dhcp_options_id - required - (String) The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

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

Calls the AssociateRouteTable API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :subnet_id - required - (String) The ID of the subnet.
    • :route_table_id - required - (String) The ID of the route table.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :association_id - (String)

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

Calls the AttachClassicLinkVpc API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - required - (String) The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
    • :vpc_id - required - (String) The ID of a ClassicLink-enabled VPC.
    • :groups - required - (Array<) The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :return - (Boolean)

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

Calls the AttachInternetGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :internet_gateway_id - required - (String) The ID of the Internet gateway.
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

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

Calls the AttachNetworkInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_interface_id - required - (String) The ID of the network interface.
    • :instance_id - required - (String) The ID of the instance.
    • :device_index - required - (Integer) The index of the device for the network interface attachment.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :attachment_id - (String)

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

Calls the AttachVolume API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :volume_id - required - (String) The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.
    • :instance_id - required - (String) The ID of the instance.
    • :device - required - (String) The device name to expose to the instance (for example, /dev/sdh or xvdh).

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_id - (String)
    • :instance_id - (String)
    • :device - (String)
    • :status - (String)
    • :attach_time - (Time)
    • :delete_on_termination - (Boolean)

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

Calls the AttachVpnGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpn_gateway_id - required - (String) The ID of the virtual private gateway.
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :attachment - (Hash)
      • :vpc_id - (String)
      • :state - (String)

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

Calls the AuthorizeSecurityGroupEgress API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_id - required - (String) The ID of the security group.
    • :source_security_group_name - (String) [EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.
    • :source_security_group_owner_id - (String) The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.
    • :ip_protocol - (String) The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
    • :from_port - (Integer) The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    • :to_port - (Integer) The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    • :cidr_ip - (String) The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    • :ip_permissions - (Array<) A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
      • :ip_protocol - (String) The protocol. When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers.
      • :from_port - (Integer) The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
      • :to_port - (Integer) The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.
      • :user_id_group_pairs - (Array<) One or more security group and AWS account ID pairs.
        • :user_id - (String) The ID of an AWS account.
        • :group_name - (String) The ID of the security group owned by the specified AWS account.
        • :group_id - (String) The name of the security group in the specified AWS account.
      • :ip_ranges - (Array<) One or more IP ranges.
        • :cidr_ip - (String) The CIDR range. You can either specify a CIDR range or a source security group, not both.

Returns:

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

Calls the AuthorizeSecurityGroupIngress API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_name - (String) [EC2-Classic, default VPC] The name of the security group.
    • :group_id - (String) The ID of the security group.
    • :source_security_group_name - (String) [EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
    • :source_security_group_owner_id - (String) The ID of the source security group. You can't specify a source security group and a CIDR IP address range.
    • :ip_protocol - (String) The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
    • :from_port - (Integer) The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    • :to_port - (Integer) The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    • :cidr_ip - (String) The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    • :ip_permissions - (Array<) A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
      • :ip_protocol - (String) The protocol. When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers.
      • :from_port - (Integer) The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
      • :to_port - (Integer) The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.
      • :user_id_group_pairs - (Array<) One or more security group and AWS account ID pairs.
        • :user_id - (String) The ID of an AWS account.
        • :group_name - (String) The ID of the security group owned by the specified AWS account.
        • :group_id - (String) The name of the security group in the specified AWS account.
      • :ip_ranges - (Array<) One or more IP ranges.
        • :cidr_ip - (String) The CIDR range. You can either specify a CIDR range or a source security group, not both.

Returns:

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

Calls the BundleInstance API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - required - (String) The ID of the instance to bundle. Type: String Default: None Required: Yes
    • :storage - required - (Hash) 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.
      • :s3 - (Hash) An Amazon S3 storage location.
        • :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 beginning of the file name of the AMI.
        • :aws_access_key_id - (String) The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.
        • :upload_policy - (String) A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
        • :upload_policy_signature - (String) The signature of the Base64 encoded JSON document.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)

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

Calls the CancelBundleTask API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :bundle_id - required - (String) The ID of the bundle task.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)

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

Calls the CancelConversionTask API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :conversion_task_id - required - (String) The ID of the conversion task.
    • :reason_message - (String)

Returns:

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

Calls the CancelExportTask API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :export_task_id - required - (String) The ID of the export task. This is the ID returned by CreateInstanceExportTask.

Returns:

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

Calls the CancelReservedInstancesListing API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :reserved_instances_listing_id - required - (String) The ID of the Reserved Instance listing.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reserved_instances_listings_set - (Array)
      • :reserved_instances_listing_id - (String)
      • :reserved_instances_id - (String)
      • :create_date - (Time)
      • :update_date - (Time)
      • :status - (String)
      • :status_message - (String)
      • :instance_counts - (Array)
        • :state - (String)
        • :instance_count - (Integer)
      • :price_schedules - (Array)
        • :term - (Integer)
        • :price - (Numeric)
        • :currency_code - (String)
        • :active - (Boolean)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :client_token - (String)

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

Calls the CancelSpotInstanceRequests API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :spot_instance_request_ids - required - (Array<) One or more Spot Instance request IDs.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :spot_instance_request_set - (Array)
      • :spot_instance_request_id - (String)
      • :state - (String)

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

Calls the ConfirmProductInstance API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :product_code - required - (String) The product code. This must be a product code that you own.
    • :instance_id - required - (String) The ID of the instance.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :owner_id - (String)

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

Calls the CopyImage API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :source_region - required - (String) The name of the region that contains the AMI to copy.
    • :source_image_id - required - (String) The ID of the AMI to copy.
    • :name - required - (String) The name of the new AMI in the destination region.
    • :description - (String) A description for the new AMI in the destination region.
    • :client_token - (String) Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :image_id - (String)

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

Calls the CopySnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :source_region - required - (String) The ID of the region that contains the snapshot to be copied.
    • :source_snapshot_id - required - (String) The ID of the Amazon EBS snapshot to copy.
    • :description - (String) A description for the new Amazon EBS snapshot.
    • :destination_region - (String) The destination region of the snapshot copy operation. This parameter is required in the PresignedUrl.
    • :presigned_url - (String) The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_id - (String)

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

Calls the CreateCustomerGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :type - required - (String) The type of VPN connection that this customer gateway supports (ipsec.1). Valid values include:
      • ipsec.1
    • :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) For devices that support BGP, the customer gateway's BGP ASN. Default: 65000

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :customer_gateway - (Hash)
      • :customer_gateway_id - (String)
      • :state - (String)
      • :type - (String)
      • :ip_address - (String)
      • :bgp_asn - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the CreateDhcpOptions API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :dhcp_configurations - required - (Array<) A DHCP configuration option.
      • :key - (String) The name of a DHCP option.
      • :values - (Array<) One or more values for the DHCP option.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :dhcp_options - (Hash)
      • :dhcp_options_id - (String)
      • :dhcp_configuration_set - (Array)
        • :key - (String)
        • :value_set - (Array)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the CreateImage API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - required - (String) The ID of the instance.
    • :name - required - (String) A name for the new image. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
    • :description - (String) A description for the new image.
    • :no_reboot - (Boolean) By default, this parameter is set to false , which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true , Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.
    • :block_device_mappings - (Array<) Information about one or more block device mappings.
      • :virtual_name - (String) The virtual device name (ephemeral[0..3]). The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
      • :device_name - (String) The device name exposed to the instance (for example, /dev/sdh).
      • :ebs - (Hash) Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
        • :snapshot_id - (String) The ID of the snapshot.
        • :volume_size - (Integer) The size of the volume, in GiB. Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
        • :delete_on_termination - (Boolean) Indicates whether the Amazon EBS volume is deleted on instance termination.
        • :volume_type - (String) The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes. Default: standard Valid values include:
          • standard
          • io1
          • gp2
        • :iops - (Integer) The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes. Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.
        • :encrypted - (Boolean) Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
      • :no_device - (String) Suppresses the specified device included in the block device mapping of the AMI.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :image_id - (String)

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

Calls the CreateInstanceExportTask API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :description - (String) A description for the conversion task or the resource being exported. The maximum length is 255 bytes.
    • :instance_id - required - (String) The ID of the instance.
    • :target_environment - (String) The target virtualization environment. Valid values include:
      • citrix
      • vmware
      • microsoft
    • :export_to_s3_task - (Hash)
      • :disk_image_format - (String) Valid values include:
        • VMDK
        • RAW
        • VHD
      • :container_format - (String) Valid values include:
        • ova
      • :s3_bucket - (String)
      • :s3_prefix - (String) The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :export_task - (Hash)
      • :export_task_id - (String)
      • :description - (String)
      • :state - (String)
      • :status_message - (String)
      • :instance_export - (Hash)
        • :instance_id - (String)
        • :target_environment - (String)
      • :export_to_s3 - (Hash)
        • :disk_image_format - (String)
        • :container_format - (String)
        • :s3_bucket - (String)
        • :s3_key - (String)

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

Calls the CreateInternetGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :internet_gateway - (Hash)
      • :internet_gateway_id - (String)
      • :attachment_set - (Array)
        • :vpc_id - (String)
        • :state - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the CreateKeyPair API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :key_name - required - (String) A unique name for the key pair. Constraints: Up to 255 ASCII characters

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :key_pair - (Hash)
      • :key_name - (String)
      • :key_fingerprint - (String)
      • :key_material - (String)

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

Calls the CreateNetworkAcl API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :network_acl - (Hash)
      • :network_acl_id - (String)
      • :vpc_id - (String)
      • :default - (Boolean)
      • :entry_set - (Array)
        • :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)
        • :network_acl_association_id - (String)
        • :network_acl_id - (String)
        • :subnet_id - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the CreateNetworkAclEntry API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_acl_id - required - (String) The ID of the network ACL.
    • :rule_number - required - (Integer) The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number. Constraints: Positive integer from 1 to 32766
    • :protocol - required - (String) The protocol. A value of -1 means all protocols.
    • :rule_action - required - (String) Indicates whether to allow or deny the traffic that matches the rule. Valid values include:
      • allow
      • deny
    • :egress - required - (Boolean) Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
    • :cidr_block - required - (String) The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
    • :icmp_type_code - (Hash) ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.
      • :type - (Integer) The ICMP code. A value of -1 means all codes for the specified ICMP type.
      • :code - (Integer) The ICMP type. A value of -1 means all types.
    • :port_range - (Hash) TCP or UDP protocols: The range of ports the rule applies to.
      • :from - (Integer) The first port in the range.
      • :to - (Integer) The last port in the range.

Returns:

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

Calls the CreateNetworkInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :subnet_id - required - (String) The ID of the subnet to associate with the network interface.
    • :description - (String) A description for the network interface.
    • :private_ip_address - (String) The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
    • :groups - (Array<) The IDs of one or more security groups.
    • :private_ip_addresses - (Array<) One or more private IP addresses.
      • :private_ip_address - required - (String) The private IP addresses.
      • :primary - (Boolean) Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.
    • :secondary_private_ip_address_count - (Integer) The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses. The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
    • :dry_run - (Boolean)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)
        • :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)
        • :public_dns_name - (String)
        • :ip_owner_id - (String)
        • :allocation_id - (String)
        • :association_id - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :private_ip_addresses_set - (Array)
        • :private_ip_address - (String)
        • :private_dns_name - (String)
        • :primary - (Boolean)
        • :association - (Hash)
          • :public_ip - (String)
          • :public_dns_name - (String)
          • :ip_owner_id - (String)
          • :allocation_id - (String)
          • :association_id - (String)

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

Calls the CreatePlacementGroup API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_name - required - (String) A name for the placement group. Constraints: Up to 255 ASCII characters
    • :strategy - required - (String) The placement strategy. Valid values include:
      • cluster

Returns:

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

Calls the CreateReservedInstancesListing API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :reserved_instances_id - required - (String) The ID of the active Reserved Instance.
    • :instance_count - required - (Integer) The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
    • :price_schedules - required - (Array<) A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.
      • :term - (Integer) The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
      • :price - (Float) The fixed price for the term.
      • :currency_code - (String) The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD. Valid values include:
        • USD
    • :client_token - required - (String) Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency in the Amazon Elastic Compute Cloud User Guide for Linux.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reserved_instances_listings_set - (Array)
      • :reserved_instances_listing_id - (String)
      • :reserved_instances_id - (String)
      • :create_date - (Time)
      • :update_date - (Time)
      • :status - (String)
      • :status_message - (String)
      • :instance_counts - (Array)
        • :state - (String)
        • :instance_count - (Integer)
      • :price_schedules - (Array)
        • :term - (Integer)
        • :price - (Numeric)
        • :currency_code - (String)
        • :active - (Boolean)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :client_token - (String)

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

Calls the CreateRoute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :route_table_id - required - (String) The ID of the route table for the route.
    • :destination_cidr_block - required - (String) The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
    • :gateway_id - (String) The ID of an Internet gateway or virtual private gateway attached to your VPC.
    • :instance_id - (String) The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
    • :network_interface_id - (String) The ID of a network interface.
    • :vpc_peering_connection_id - (String) The ID of a VPC peering connection.

Returns:

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

Calls the CreateRouteTable API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :route_table - (Hash)
      • :route_table_id - (String)
      • :vpc_id - (String)
      • :route_set - (Array)
        • :destination_cidr_block - (String)
        • :gateway_id - (String)
        • :instance_id - (String)
        • :instance_owner_id - (String)
        • :network_interface_id - (String)
        • :vpc_peering_connection_id - (String)
        • :state - (String)
        • :origin - (String)
      • :association_set - (Array)
        • :route_table_association_id - (String)
        • :route_table_id - (String)
        • :subnet_id - (String)
        • :main - (Boolean)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :propagating_vgw_set - (Array)
        • :gateway_id - (String)

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

Calls the CreateSecurityGroup API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_name - required - (String) The name of the security group. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
    • :description - required - (String) A description for the security group. This is informational only. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
    • :vpc_id - (String) [EC2-VPC] The ID of the VPC. Required for EC2-VPC.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :group_id - (String)

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

Calls the CreateSnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :volume_id - required - (String) The ID of the Amazon EBS volume.
    • :description - (String) A description for the snapshot.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)
      • :key - (String)
      • :value - (String)
    • :encrypted - (Boolean)
    • :kms_key_id - (String)

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

Calls the CreateSpotDatafeedSubscription API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :bucket - required - (String) The Amazon S3 bucket in which to store the Spot Instance datafeed. Constraints: Must be a valid bucket associated with your AWS account.
    • :prefix - (String) A prefix for the datafeed file names.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :spot_datafeed_subscription - (Hash)
      • :owner_id - (String)
      • :bucket - (String)
      • :prefix - (String)
      • :state - (String)
      • :fault - (Hash)
        • :code - (String)
        • :message - (String)

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

Calls the CreateSubnet API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_id - required - (String) The ID of the VPC.
    • :cidr_block - required - (String) The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.
    • :availability_zone - (String) The Availability Zone for the subnet. Default: Amazon EC2 selects one for you (recommended).

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :subnet - (Hash)
      • :subnet_id - (String)
      • :state - (String)
      • :vpc_id - (String)
      • :cidr_block - (String)
      • :available_ip_address_count - (Integer)
      • :availability_zone - (String)
      • :default_for_az - (Boolean)
      • :map_public_ip_on_launch - (Boolean)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the CreateTags API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :resources - required - (Array<) The IDs of one or more resources to tag. For example, ami-1a2b3c4d.
    • :tags - required - (Array<) One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
      • :key - (String) The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:
      • :value - (String) The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Returns:

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

Calls the CreateVolume API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :size - (Integer) The size of the volume, in GiBs. Constraints: If the volume type is io1, the minimum size of the volume is 4 GiB. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    • :snapshot_id - (String) The snapshot from which to create the volume.
    • :availability_zone - required - (String) The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
    • :volume_type - (String) The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes. Default: standard Valid values include:
      • standard
      • io1
      • gp2
    • :iops - (Integer) Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume.
    • :encrypted - (Boolean) Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.
    • :kms_key_id - (String) The full ARN of the AWS Key Management Service (KMS) master key to use when creating the encrypted volume. This parameter is only required if you want to use a non-default master key; if this parameter is not specified, the default master key is used. The ARN contains the arn:aws:kms namespace, followed by the region of the master key, the AWS account ID of the master key owner, the key namespace, and then the master key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_id - (String)
    • :size - (Integer)
    • :snapshot_id - (String)
    • :availability_zone - (String)
    • :status - (String)
    • :create_time - (Time)
    • :attachment_set - (Array)
      • :volume_id - (String)
      • :instance_id - (String)
      • :device - (String)
      • :status - (String)
      • :attach_time - (Time)
      • :delete_on_termination - (Boolean)
    • :tag_set - (Array)
      • :key - (String)
      • :value - (String)
    • :volume_type - (String)
    • :iops - (Integer)
    • :encrypted - (Boolean)
    • :kms_key_id - (String)

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

Calls the CreateVpc API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :cidr_block - required - (String) The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.
    • :instance_tenancy - (String) The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware. Default: default Valid values include:
      • default
      • dedicated

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpc - (Hash)
      • :vpc_id - (String)
      • :state - (String)
      • :cidr_block - (String)
      • :dhcp_options_id - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :instance_tenancy - (String)
      • :is_default - (Boolean)

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

Calls the CreateVpcPeeringConnection API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_id - (String) The ID of the requester VPC.
    • :peer_vpc_id - (String) The ID of the VPC with which you are creating the VPC peering connection.
    • :peer_owner_id - (String) The AWS account ID of the owner of the peer VPC. Default: Your AWS account ID

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpc_peering_connection - (Hash)
      • :accepter_vpc_info - (Hash)
        • :cidr_block - (String)
        • :owner_id - (String)
        • :vpc_id - (String)
      • :expiration_time - (Time)
      • :requester_vpc_info - (Hash)
        • :cidr_block - (String)
        • :owner_id - (String)
        • :vpc_id - (String)
      • :status - (Hash)
        • :code - (String)
        • :message - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :vpc_peering_connection_id - (String)

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

Calls the CreateVpnConnection API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :type - required - (String) The type of VPN connection (ipsec.1).
    • :customer_gateway_id - required - (String) The ID of the customer gateway.
    • :vpn_gateway_id - required - (String) The ID of the virtual private gateway.
    • :options - (Hash) Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true . Default: false
      • :static_routes_only - (Boolean) Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)
        • :key - (String)
        • :value - (String)
      • :vgw_telemetry - (Array)
        • :outside_ip_address - (String)
        • :status - (String)
        • :last_status_change - (Time)
        • :status_message - (String)
        • :accepted_route_count - (Integer)
      • :options - (Hash)
        • :static_routes_only - (Boolean)
      • :routes - (Array)
        • :destination_cidr_block - (String)
        • :source - (String)
        • :state - (String)

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

Calls the CreateVpnConnectionRoute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :vpn_connection_id - required - (String) The ID of the VPN connection.
    • :destination_cidr_block - required - (String) The CIDR block associated with the local subnet of the customer network.

Returns:

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

Calls the CreateVpnGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :type - required - (String) The type of VPN connection this virtual private gateway supports. Valid values include:
      • ipsec.1
    • :availability_zone - (String) The Availability Zone for the virtual private gateway.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpn_gateway - (Hash)
      • :vpn_gateway_id - (String)
      • :state - (String)
      • :vpn_type - (String)
      • :availability_zone - (String)
      • :attachments - (Array)
        • :vpc_id - (String)
        • :state - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the DeleteCustomerGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :customer_gateway_id - required - (String) The ID of the customer gateway.

Returns:

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

Calls the DeleteDhcpOptions API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :dhcp_options_id - required - (String) The ID of the DHCP options set.

Returns:

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

Calls the DeleteInternetGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :internet_gateway_id - required - (String) The ID of the Internet gateway.

Returns:

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

Calls the DeleteKeyPair API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :key_name - required - (String) The name of the key pair.

Returns:

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

Calls the DeleteNetworkAcl API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_acl_id - required - (String) The ID of the network ACL.

Returns:

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

Calls the DeleteNetworkAclEntry API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_acl_id - required - (String) The ID of the network ACL.
    • :rule_number - required - (Integer) The rule number of the entry to delete.
    • :egress - required - (Boolean) Indicates whether the rule is an egress rule.

Returns:

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

Calls the DeleteNetworkInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_interface_id - required - (String) The ID of the network interface.

Returns:

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

Calls the DeletePlacementGroup API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_name - required - (String) The name of the placement group.

Returns:

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

Calls the DeleteRoute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :route_table_id - required - (String) The ID of the route table.
    • :destination_cidr_block - required - (String) The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

Returns:

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

Calls the DeleteRouteTable API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :route_table_id - required - (String) The ID of the route table.

Returns:

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

Calls the DeleteSecurityGroup API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_name - (String) [EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.
    • :group_id - (String) The ID of the security group. Required for a nondefault VPC.

Returns:

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

Calls the DeleteSnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :snapshot_id - required - (String) The ID of the Amazon EBS snapshot.

Returns:

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

Calls the DeleteSpotDatafeedSubscription API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)

Returns:

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

Calls the DeleteSubnet API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :subnet_id - required - (String) The ID of the subnet.

Returns:

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

Calls the DeleteTags API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :resources - required - (Array<) The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.
    • :tags - (Array<) One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.
      • :key - (String) The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:
      • :value - (String) The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Returns:

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

Calls the DeleteVolume API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :volume_id - required - (String) The ID of the volume.

Returns:

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

Calls the DeleteVpc API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

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

Calls the DeleteVpcPeeringConnection API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_peering_connection_id - required - (String) The ID of the VPC peering connection.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :return - (Boolean)

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

Calls the DeleteVpnConnection API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpn_connection_id - required - (String) The ID of the VPN connection.

Returns:

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

Calls the DeleteVpnConnectionRoute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :vpn_connection_id - required - (String) The ID of the VPN connection.
    • :destination_cidr_block - required - (String) The CIDR block associated with the local subnet of the customer network.

Returns:

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

Calls the DeleteVpnGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpn_gateway_id - required - (String) The ID of the virtual private gateway.

Returns:

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

Calls the DeregisterImage API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :image_id - required - (String) The ID of the AMI.

Returns:

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

Calls the DescribeAccountAttributes API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :attribute_names - (Array<) One or more account attribute names.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :account_attribute_set - (Array)
      • :attribute_name - (String)
      • :attribute_value_set - (Array)
        • :attribute_value - (String)

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

Calls the DescribeAddresses API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :public_ips - (Array<) [EC2-Classic] One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses.
    • :filters - (Array<) One or more filters. Filter names and values are case-sensitive. allocation-id - [EC2-VPC] The allocation ID for the address. association-id - [EC2-VPC] The association ID for the address. domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc). instance-id - The ID of the instance the address is associated with, if any. network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any. network-interface-owner-id - The AWS account ID of the owner. private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address. public-ip - The Elastic IP address.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :allocation_ids - (Array<) [EC2-VPC] One or more allocation IDs. Default: Describes all your Elastic IP addresses.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :addresses_set - (Array)
      • :instance_id - (String)
      • :public_ip - (String)
      • :allocation_id - (String)
      • :association_id - (String)
      • :domain - (String)
      • :network_interface_id - (String)
      • :network_interface_owner_id - (String)
      • :private_ip_address - (String)

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

Calls the DescribeAvailabilityZones API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :zone_names - (Array<) The names of one or more Availability Zones.
    • :filters - (Array<) One or more filters. message - Information about the Availability Zone. region-name - The name of the region for the Availability Zone (for example, us-east-1). state - The state of the Availability Zone (available | impaired | unavailable). zone-name - The name of the Availability Zone (for example, us-east-1a).
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :availability_zone_info - (Array)
      • :zone_name - (String)
      • :zone_state - (String)
      • :region_name - (String)
      • :message_set - (Array)
        • :message - (String)

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

Calls the DescribeBundleTasks API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :bundle_ids - (Array<) One or more bundle task IDs. Default: Describes all your bundle tasks.
    • :filters - (Array<) One or more filters. bundle-id - The ID of the bundle task. error-code - If the task failed, the error code returned. error-message - If the task failed, the error message returned. instance-id - The ID of the instance. progress - The level of task completion, as a percentage (for example, 20%). s3-bucket - The Amazon S3 bucket to store the AMI. s3-prefix - The beginning of the AMI name. start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z). state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed). update-time - The time of the most recent update for the task.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :bundle_instance_tasks_set - (Array)
      • :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)

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

Calls the DescribeClassicLinkInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_ids - (Array<) One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
    • :filters - (Array<) One or more filters. group-id - The ID of a VPC security group that's associated with the instance. instance-id - The ID of the instance. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. vpc-id - The ID of the VPC that the instance is linked to.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :next_token - (String) The token for the next set of items to return. (You received this token from a prior call.)
    • :max_results - (Integer) The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value is greater than 1000, we return only 1000 items.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :instances_set - (Array)
      • :instance_id - (String)
      • :vpc_id - (String)
      • :group_set - (Array)
        • :group_name - (String)
        • :group_id - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
    • :next_token - (String)

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

Calls the DescribeConversionTasks API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :filters - (Array<)
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :conversion_task_ids - (Array<) One or more conversion task IDs.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :conversion_tasks - (Array)
      • :conversion_task_id - (String)
      • :expiration_time - (String)
      • :import_instance - (Hash)
        • :volumes - (Array)
          • :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)
        • :key - (String)
        • :value - (String)

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

Calls the DescribeCustomerGateways API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :customer_gateway_ids - (Array<) One or more customer gateway IDs. Default: Describes all your customer gateways.
    • :filters - (Array<) One or more filters. bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). customer-gateway-id - The ID of the customer gateway. ip-address - The IP address of the customer gateway's Internet-routable external interface. state - The state of the customer gateway (pending | available | deleting | deleted). type - The type of customer gateway. Currently, the only supported type is ipsec.1. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :customer_gateway_set - (Array)
      • :customer_gateway_id - (String)
      • :state - (String)
      • :vpn_type - (String)
      • :ip_address - (String)
      • :bgp_asn - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the DescribeDhcpOptions API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :dhcp_options_ids - (Array<) The IDs of one or more DHCP options sets. Default: Describes all your DHCP options sets.
    • :filters - (Array<) One or more filters. dhcp-options-id - The ID of a set of DHCP options. key - The key for one of the options (for example, domain-name). value - The value for one of the options. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :dhcp_options_set - (Array)
      • :dhcp_options_id - (String)
      • :dhcp_configuration_set - (Array)
        • :key - (String)
        • :value_set - (Array)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the DescribeExportTasks API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :export_task_ids - (Array<) One or more export task IDs.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :export_task_set - (Array)
      • :export_task_id - (String)
      • :description - (String)
      • :state - (String)
      • :status_message - (String)
      • :instance_export - (Hash)
        • :instance_id - (String)
        • :target_environment - (String)
      • :export_to_s3 - (Hash)
        • :disk_image_format - (String)
        • :container_format - (String)
        • :s3_bucket - (String)
        • :s3_key - (String)

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

Calls the DescribeImageAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :image_id - required - (String) The ID of the AMI.
    • :attribute - required - (String) The AMI attribute. Valid values include:
      • description
      • kernel
      • ramdisk
      • launchPermission
      • productCodes
      • blockDeviceMapping

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :image_id - (String)
    • :launch_permission - (Array)
      • :user_id - (String)
      • :group - (String)
    • :product_codes - (Array)
      • :product_code - (String)
      • :type - (String)
    • :kernel - (Hash)
      • :value - (String)
    • :ramdisk - (Hash)
      • :value - (String)
    • :description - (Hash)
      • :value - (String)
    • :sriov_net_support - (Hash)
      • :value - (String)
    • :block_device_mapping - (Array)
      • :virtual_name - (String)
      • :device_name - (String)
      • :ebs - (Hash)
        • :snapshot_id - (String)
        • :volume_size - (Integer)
        • :delete_on_termination - (Boolean)
        • :volume_type - (String)
        • :iops - (Integer)
        • :encrypted - (Boolean)
      • :no_device - (String)

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

Calls the DescribeImages API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :image_ids - (Array<) One or more image IDs. Default: Describes all images available to you.
    • :owners - (Array<) Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request), or all (all owners).
    • :executable_users - (Array<) Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
    • :filters - (Array<) One or more filters. architecture - The image architecture (i386 | x86_64). block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh). block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume. block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB. block-device-mapping.volume-type - The volume type of the Amazon EBS volume (gp2 | standard | io1). description - The description of the image (provided during image creation). hypervisor - The hypervisor type (ovm | xen). image-id - The ID of the image. image-type - The image type (machine | kernel | ramdisk). is-public - A Boolean that indicates whether the image is public. kernel-id - The kernel ID. manifest-location - The location of the image manifest. name - The name of the AMI (provided during image creation). owner-alias - The AWS account alias (for example, amazon). owner-id - The AWS account ID of the image owner. platform - The platform. To only list Windows-based AMIs, use windows. product-code - The product code. product-code.type - The type of the product code (devpay | marketplace). ramdisk-id - The RAM disk ID. root-device-name - The name of the root device volume (for example, /dev/sda1). root-device-type - The type of the root device volume (ebs | instance-store). state - The state of the image (available | pending | failed). state-reason-code - The reason code for the state change. state-reason-message - The message for the state change. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. virtualization-type - The virtualization type (paravirtual | hvm).
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :images_set - (Array)
      • :image_id - (String)
      • :image_location - (String)
      • :image_state - (String)
      • :image_owner_id - (String)
      • :is_public - (Boolean)
      • :product_codes - (Array)
        • :product_code - (String)
        • :type - (String)
      • :architecture - (String)
      • :image_type - (String)
      • :kernel_id - (String)
      • :ramdisk_id - (String)
      • :platform - (String)
      • :sriov_net_support - (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)
        • :virtual_name - (String)
        • :device_name - (String)
        • :ebs - (Hash)
          • :snapshot_id - (String)
          • :volume_size - (Integer)
          • :delete_on_termination - (Boolean)
          • :volume_type - (String)
          • :iops - (Integer)
          • :encrypted - (Boolean)
        • :no_device - (String)
      • :virtualization_type - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :hypervisor - (String)

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

Calls the DescribeInstanceAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - required - (String) The ID of the instance.
    • :attribute - required - (String) The instance attribute. Valid values include:
      • instanceType
      • kernel
      • ramdisk
      • userData
      • disableApiTermination
      • instanceInitiatedShutdownBehavior
      • rootDeviceName
      • blockDeviceMapping
      • productCodes
      • sourceDestCheck
      • groupSet
      • ebsOptimized
      • sriovNetSupport

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)
      • :device_name - (String)
      • :ebs - (Hash)
        • :volume_id - (String)
        • :status - (String)
        • :attach_time - (Time)
        • :delete_on_termination - (Boolean)
    • :product_codes - (Array)
      • :product_code - (String)
      • :type - (String)
    • :ebs_optimized - (Hash)
      • :value - (Boolean)
    • :sriov_net_support - (Hash)
      • :value - (String)
    • :source_dest_check - (Hash)
      • :value - (Boolean)
    • :group_set - (Array)
      • :group_name - (String)
      • :group_id - (String)

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

Calls the DescribeInstanceStatus API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_ids - (Array<) One or more instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs.
    • :filters - (Array<) One or more filters. availability-zone - The Availability Zone of the instance. event.code - The code identifying the type of event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop). event.description - A description of the event. event.not-after - The latest end time for the scheduled event, for example: 2010-09-15T17:15:20.000Z. event.not-before - The earliest start time for the scheduled event, for example: 2010-09-15T17:15:20.000Z. instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data). instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data). system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :next_token - (String) The next paginated set of results to return. (You received this token from a prior call.)
    • :max_results - (Integer) The maximum number of paginated instance items per response. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items. Default: 1000
    • :include_all_instances - (Boolean) When true , includes the health status for all instances. When false , includes the health status for running instances only. Default: false

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :instance_status_set - (Array)
      • :instance_id - (String)
      • :availability_zone - (String)
      • :events_set - (Array)
        • :code - (String)
        • :description - (String)
        • :not_before - (Time)
        • :not_after - (Time)
      • :instance_state - (Hash)
        • :code - (Integer)
        • :name - (String)
      • :system_status - (Hash)
        • :status - (String)
        • :details - (Array)
          • :name - (String)
          • :status - (String)
          • :impaired_since - (Time)
      • :instance_status - (Hash)
        • :status - (String)
        • :details - (Array)
          • :name - (String)
          • :status - (String)
          • :impaired_since - (Time)
    • :next_token - (String)

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

Calls the DescribeInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_ids - (Array<) One or more instance IDs. Default: Describes all your instances.
    • :filters - (Array<) One or more filters. architecture - The instance architecture (i386 | x86_64). availability-zone - The Availability Zone of the instance. block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z. block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh). block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached). block-device-mapping.volume-id - The volume ID of the Amazon EBS volume. client-token - The idempotency token you provided when you launched the instance. dns-name - The public DNS name of the instance. group-id - The ID of the security group for the instance. EC2-Classic only. group-name - The name of the security group for the instance. EC2-Classic only. hypervisor - The hypervisor type of the instance (ovm | xen). iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN. image-id - The ID of the image used to launch the instance. instance-id - The ID of the instance. instance-lifecycle - Indicates whether this is a Spot Instance (spot). instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-type - The type of instance (for example, m1.small). instance.group-id - The ID of the security group for the instance. instance.group-name - The name of the security group for the instance. ip-address - The public IP address of the instance. kernel-id - The kernel ID. key-name - The name of the key pair used when the instance was launched. launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on). launch-time - The time when the instance was launched. monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled). owner-id - The AWS account ID of the instance owner. placement-group-name - The name of the placement group for the instance. platform - The platform. Use windows if you have Windows instances; otherwise, leave blank. private-dns-name - The private DNS name of the instance. private-ip-address - The private IP address of the instance. product-code - The product code associated with the AMI used to launch the instance. product-code.type - The type of product code (devpay | marketplace). ramdisk-id - The RAM disk ID. reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID. root-device-name - The name of the root device for the instance (for example, /dev/sda1). root-device-type - The type of root device that the instance uses (ebs | instance-store). source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC. spot-instance-request-id - The ID of the Spot Instance request. state-reason-code - The reason code for the state change. state-reason-message - A message that describes the state change. subnet-id - The ID of the subnet for the instance. tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. tenancy - The tenancy of an instance (dedicated | default). virtualization-type - The virtualization type of the instance (paravirtual | hvm). vpc-id - The ID of the VPC that the instance is running in. network-interface.description - The description of the network interface. network-interface.subnet-id - The ID of the subnet for the network interface. network-interface.vpc-id - The ID of the VPC for the network interface. network-interface.network-interface.id - The ID of the network interface. network-interface.owner-id - The ID of the owner of the network interface. network-interface.availability-zone - The Availability Zone for the network interface. network-interface.requester-id - The requester ID for the network interface. network-interface.requester-managed - Indicates whether the network interface is being managed by AWS. network-interface.status - The status of the network interface (available) | in-use). network-interface.mac-address - The MAC address of the network interface. network-interface-private-dns-name - The private DNS name of the network interface. network-interface.source-destination-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC. network-interface.group-id - The ID of a security group associated with the network interface. network-interface.group-name - The name of a security group associated with the network interface. network-interface.attachment.attachment-id - The ID of the interface attachment. network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached. network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached. network-interface.addresses.private-ip-address - The private IP address associated with the network interface. network-interface.attachment.device-index - The device index to which the network interface is attached. network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached). network-interface.attachment.attach-time - The time that the network interface was attached to an instance. network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated. network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address. network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface. network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface. association.public-ip - The address of the Elastic IP address bound to the network interface. association.ip-owner-id - The owner of the Elastic IP address associated with the network interface. association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface. association.association-id - The association ID returned when the network interface was associated with an IP address.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :next_token - (String) The token for the next set of items to return. (You received this token from a prior call.)
    • :max_results - (Integer) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reservation_set - (Array)
      • :reservation_id - (String)
      • :owner_id - (String)
      • :requester_id - (String)
      • :group_set - (Array)
        • :group_name - (String)
        • :group_id - (String)
      • :instances_set - (Array)
        • :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)
          • :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)
          • :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)
        • :client_token - (String)
        • :tag_set - (Array)
          • :key - (String)
          • :value - (String)
        • :group_set - (Array)
          • :group_name - (String)
          • :group_id - (String)
        • :source_dest_check - (Boolean)
        • :hypervisor - (String)
        • :network_interface_set - (Array)
          • :network_interface_id - (String)
          • :subnet_id - (String)
          • :vpc_id - (String)
          • :description - (String)
          • :owner_id - (String)
          • :status - (String)
          • :mac_address - (String)
          • :private_ip_address - (String)
          • :private_dns_name - (String)
          • :source_dest_check - (Boolean)
          • :group_set - (Array)
            • :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)
            • :public_dns_name - (String)
            • :ip_owner_id - (String)
          • :private_ip_addresses_set - (Array)
            • :private_ip_address - (String)
            • :private_dns_name - (String)
            • :primary - (Boolean)
            • :association - (Hash)
              • :public_ip - (String)
              • :public_dns_name - (String)
              • :ip_owner_id - (String)
        • :iam_instance_profile - (Hash)
          • :arn - (String)
          • :id - (String)
        • :ebs_optimized - (Boolean)
        • :sriov_net_support - (String)
    • :next_token - (String)

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

Calls the DescribeInternetGateways API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :internet_gateway_ids - (Array<) One or more Internet gateway IDs. Default: Describes all your Internet gateways.
    • :filters - (Array<) One or more filters. attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached. attachment.vpc-id - The ID of an attached VPC. internet-gateway-id - The ID of the Internet gateway. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :internet_gateway_set - (Array)
      • :internet_gateway_id - (String)
      • :attachment_set - (Array)
        • :vpc_id - (String)
        • :state - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the DescribeKeyPairs API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :key_names - (Array<) One or more key pair names. Default: Describes all your key pairs.
    • :filters - (Array<) One or more filters. fingerprint - The fingerprint of the key pair. key-name - The name of the key pair.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :key_set - (Array)
      • :key_name - (String)
      • :key_fingerprint - (String)

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

Calls the DescribeNetworkAcls API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_acl_ids - (Array<) One or more network ACL IDs. Default: Describes all your network ACLs.
    • :filters - (Array<) One or more filters. association.association-id - The ID of an association ID for the ACL. association.network-acl-id - The ID of the network ACL involved in the association. association.subnet-id - The ID of the subnet involved in the association. default - Indicates whether the ACL is the default network ACL for the VPC. entry.cidr - The CIDR range specified in the entry. entry.egress - Indicates whether the entry applies to egress traffic. entry.icmp.code - The ICMP code specified in the entry, if any. entry.icmp.type - The ICMP type specified in the entry, if any. entry.port-range.from - The start of the port range specified in the entry. entry.port-range.to - The end of the port range specified in the entry. entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number). entry.rule-action - Allows or denies the matching traffic (allow | deny). entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries. network-acl-id - The ID of the network ACL. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. vpc-id - The ID of the VPC for the network ACL.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :network_acl_set - (Array)
      • :network_acl_id - (String)
      • :vpc_id - (String)
      • :default - (Boolean)
      • :entry_set - (Array)
        • :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)
        • :network_acl_association_id - (String)
        • :network_acl_id - (String)
        • :subnet_id - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the DescribeNetworkInterfaceAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_interface_id - required - (String) The ID of the network interface.
    • :attribute - (String) The attribute of the network interface. Valid values include:
      • description
      • groupSet
      • sourceDestCheck
      • attachment

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :network_interface_id - (String)
    • :description - (Hash)
      • :value - (String)
    • :source_dest_check - (Hash)
      • :value - (Boolean)
    • :group_set - (Array)
      • :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)

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

Calls the DescribeNetworkInterfaces API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_interface_ids - (Array<) One or more network interface IDs. Default: Describes all your network interfaces.
    • :filters - (Array<) One or more filters. addresses.private-ip-address - The private IP addresses associated with the network interface. addresses.primary - Whether the private IP address is the primary IP address associated with the network interface. addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address. addresses.association.owner-id - The owner ID of the addresses associated with the network interface. association.association-id - The association ID returned when the network interface was associated with an IP address. association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface. association.ip-owner-id - The owner of the Elastic IP address associated with the network interface. association.public-ip - The address of the Elastic IP address bound to the network interface. association.public-dns-name - The public DNS name for the network interface. attachment.attachment-id - The ID of the interface attachment. attachment.instance-id - The ID of the instance to which the network interface is attached. attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached. attachment.device-index - The device index to which the network interface is attached. attachment.status - The status of the attachment (attaching | attached | detaching | detached). attachment.attach.time - The time that the network interface was attached to an instance. attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated. availability-zone - The Availability Zone of the network interface. description - The description of the network interface. group-id - The ID of a security group associated with the network interface. group-name - The name of a security group associated with the network interface. mac-address - The MAC address of the network interface. network-interface-id - The ID of the network interface. owner-id - The AWS account ID of the network interface owner. private-ip-address - The private IP address or addresses of the network interface. private-dns-name - The private DNS name of the network interface. requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on). source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC. status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use. subnet-id - The ID of the subnet for the network interface. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. vpc-id - The ID of the VPC for the network interface.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :network_interface_set - (Array)
      • :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)
        • :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)
        • :public_dns_name - (String)
        • :ip_owner_id - (String)
        • :allocation_id - (String)
        • :association_id - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :private_ip_addresses_set - (Array)
        • :private_ip_address - (String)
        • :private_dns_name - (String)
        • :primary - (Boolean)
        • :association - (Hash)
          • :public_ip - (String)
          • :public_dns_name - (String)
          • :ip_owner_id - (String)
          • :allocation_id - (String)
          • :association_id - (String)

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

Calls the DescribePlacementGroups API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_names - (Array<) One or more placement group names. Default: Describes all your placement groups, or only those otherwise specified.
    • :filters - (Array<) One or more filters. group-name - The name of the placement group. state - The state of the placement group (pending | available | deleting | deleted). strategy - The strategy of the placement group (cluster).
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :placement_group_set - (Array)
      • :group_name - (String)
      • :strategy - (String)
      • :state - (String)

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

Calls the DescribeRegions API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :region_names - (Array<) The names of one or more regions.
    • :filters - (Array<) One or more filters. endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com). region-name - The name of the region (for example, us-east-1).
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :region_info - (Array)
      • :region_name - (String)
      • :region_endpoint - (String)

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

Calls the DescribeReservedInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :reserved_instances_ids - (Array<) One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified.
    • :filters - (Array<) One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000). end - The time when the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z). fixed-price - The purchase price of the Reserved Instance (for example, 9800.0). instance-type - The instance type on which the Reserved Instance can be used. product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)). reserved-instances-id - The ID of the Reserved Instance. start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired). tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :offering_type - (String) The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type. Valid values include:
      • Heavy Utilization
      • Medium Utilization
      • Light Utilization

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reserved_instances_set - (Array)
      • :reserved_instances_id - (String)
      • :instance_type - (String)
      • :availability_zone - (String)
      • :start - (Time)
      • :end - (Time)
      • :duration - (Integer)
      • :usage_price - (Numeric)
      • :fixed_price - (Numeric)
      • :instance_count - (Integer)
      • :product_description - (String)
      • :state - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :instance_tenancy - (String)
      • :currency_code - (String)
      • :offering_type - (String)
      • :recurring_charges - (Array)
        • :frequency - (String)
        • :amount - (Numeric)

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

Calls the DescribeReservedInstancesListings API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :reserved_instances_id - (String) One or more Reserved Instance IDs.
    • :reserved_instances_listing_id - (String) One or more Reserved Instance Listing IDs.
    • :filters - (Array<) One or more filters. reserved-instances-id - The ID of the Reserved Instances. reserved-instances-listing-id - The ID of the Reserved Instances listing. status - The status of the Reserved Instance listing (pending | active | cancelled | closed). status-message - The reason for the status.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reserved_instances_listings_set - (Array)
      • :reserved_instances_listing_id - (String)
      • :reserved_instances_id - (String)
      • :create_date - (Time)
      • :update_date - (Time)
      • :status - (String)
      • :status_message - (String)
      • :instance_counts - (Array)
        • :state - (String)
        • :instance_count - (Integer)
      • :price_schedules - (Array)
        • :term - (Integer)
        • :price - (Numeric)
        • :currency_code - (String)
        • :active - (Boolean)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :client_token - (String)

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

Calls the DescribeReservedInstancesModifications API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :reserved_instances_modification_ids - (Array<) IDs for the submitted modification request.
    • :next_token - (String) The token for the next page of data.
    • :filters - (Array<) One or more filters. client-token - The idempotency token for the modification request. create-date - The time when the modification request was created. effective-date - The time when the modification becomes effective. modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled. modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances. modification-result.target-configuration.instance-count - The number of new Reserved Instances. modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances. modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC). reserved-instances-id - The ID of the Reserved Instances modified. reserved-instances-modification-id - The ID of the modification request. status - The status of the Reserved Instances modification request (processing | fulfilled | failed). status-message - The reason for the status. update-date - The time when the modification request was last updated.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reserved_instances_modifications_set - (Array)
      • :reserved_instances_modification_id - (String)
      • :reserved_instances_set - (Array)
        • :reserved_instances_id - (String)
      • :modification_result_set - (Array)
        • :reserved_instances_id - (String)
        • :target_configuration - (Hash)
          • :availability_zone - (String)
          • :platform - (String)
          • :instance_count - (Integer)
          • :instance_type - (String)
      • :create_date - (Time)
      • :update_date - (Time)
      • :effective_date - (Time)
      • :status - (String)
      • :status_message - (String)
      • :client_token - (String)
    • :next_token - (String)

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

Calls the DescribeReservedInstancesOfferings API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :reserved_instances_offering_ids - (Array<) One or more Reserved Instances offering IDs.
    • :instance_type - (String) The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. Valid values include:
      • t1.micro
      • m1.small
      • m1.medium
      • m1.large
      • m1.xlarge
      • m3.medium
      • m3.large
      • m3.xlarge
      • m3.2xlarge
      • t2.micro
      • t2.small
      • t2.medium
      • m2.xlarge
      • m2.2xlarge
      • m2.4xlarge
      • cr1.8xlarge
      • i2.xlarge
      • i2.2xlarge
      • i2.4xlarge
      • i2.8xlarge
      • hi1.4xlarge
      • hs1.8xlarge
      • c1.medium
      • c1.xlarge
      • c3.large
      • c3.xlarge
      • c3.2xlarge
      • c3.4xlarge
      • c3.8xlarge
      • cc1.4xlarge
      • cc2.8xlarge
      • g2.2xlarge
      • cg1.4xlarge
      • r3.large
      • r3.xlarge
      • r3.2xlarge
      • r3.4xlarge
      • r3.8xlarge
    • :availability_zone - (String) The Availability Zone in which the Reserved Instance can be used.
    • :product_description - (String) The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC. Valid values include:
      • Linux/UNIX
      • Linux/UNIX (Amazon VPC)
      • Windows
      • Windows (Amazon VPC)
    • :filters - (Array<) One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000). fixed-price - The purchase price of the Reserved Instance (for example, 9800.0). instance-type - The instance type on which the Reserved Instance can be used. marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed. product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)). reserved-instances-offering-id - The Reserved Instances offering ID. usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :instance_tenancy - (String) The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC. Default: default Valid values include:
      • default
      • dedicated
    • :offering_type - (String) The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type. Valid values include:
      • Heavy Utilization
      • Medium Utilization
      • Light Utilization
    • :next_token - (String) The token to use when requesting the next paginated set of offerings.
    • :max_results - (Integer) The maximum number of offerings to return. The maximum is 100. Default: 100
    • :include_marketplace - (Boolean) Include Marketplace offerings in the response.
    • :min_duration - (Integer) The minimum duration (in seconds) to filter when searching for offerings. Default: 2592000 (1 month)
    • :max_duration - (Integer) The maximum duration (in seconds) to filter when searching for offerings. Default: 94608000 (3 years)
    • :max_instance_count - (Integer) The maximum number of instances to filter when searching for offerings. Default: 20

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reserved_instances_offerings_set - (Array)
      • :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)
        • :frequency - (String)
        • :amount - (Numeric)
      • :marketplace - (Boolean)
      • :pricing_details_set - (Array)
        • :price - (Numeric)
        • :count - (Integer)
    • :next_token - (String)

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

Calls the DescribeRouteTables API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :route_table_ids - (Array<) One or more route table IDs. Default: Describes all your route tables.
    • :filters - (Array<) One or more filters. association.route-table-association-id - The ID of an association ID for the route table. association.route-table-id - The ID of the route table involved in the association. association.subnet-id - The ID of the subnet involved in the association. association.main - Indicates whether the route table is the main route table for the VPC. route-table-id - The ID of the route table. route.destination-cidr-block - The CIDR range specified in a route in the table. route.gateway-id - The ID of a gateway specified in a route in the table. route.instance-id - The ID of an instance specified in a route in the table. route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation. route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on). route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. vpc-id - The ID of the VPC for the route table.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :route_table_set - (Array)
      • :route_table_id - (String)
      • :vpc_id - (String)
      • :route_set - (Array)
        • :destination_cidr_block - (String)
        • :gateway_id - (String)
        • :instance_id - (String)
        • :instance_owner_id - (String)
        • :network_interface_id - (String)
        • :vpc_peering_connection_id - (String)
        • :state - (String)
        • :origin - (String)
      • :association_set - (Array)
        • :route_table_association_id - (String)
        • :route_table_id - (String)
        • :subnet_id - (String)
        • :main - (Boolean)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :propagating_vgw_set - (Array)
        • :gateway_id - (String)

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

Calls the DescribeSecurityGroups API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_names - (Array<) [EC2-Classic, default VPC] One or more security group names. You can specify either the security group name or the security group ID. Default: Describes all your security groups.
    • :group_ids - (Array<) One or more security group IDs. Required for nondefault VPCs. Default: Describes all your security groups.
    • :filters - (Array<) One or more filters. description - The description of the security group. group-id - The ID of the security group. group-name - The name of the security group. ip-permission.cidr - A CIDR range that has been granted permission. ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number. ip-permission.group-id - The ID of a security group that has been granted permission. ip-permission.group-name - The name of a security group that has been granted permission. ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number). ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code. ip-permission.user-id - The ID of an AWS account that has been granted permission. owner-id - The AWS account ID of the owner of the security group. tag-key - The key of a tag assigned to the security group. tag-value - The value of a tag assigned to the security group. vpc-id - The ID of the VPC specified when the security group was created.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :security_group_info - (Array)
      • :owner_id - (String)
      • :group_name - (String)
      • :group_id - (String)
      • :group_description - (String)
      • :ip_permissions - (Array)
        • :ip_protocol - (String)
        • :from_port - (Integer)
        • :to_port - (Integer)
        • :groups - (Array)
          • :user_id - (String)
          • :group_name - (String)
          • :group_id - (String)
        • :ip_ranges - (Array)
          • :cidr_ip - (String)
      • :ip_permissions_egress - (Array)
        • :ip_protocol - (String)
        • :from_port - (Integer)
        • :to_port - (Integer)
        • :groups - (Array)
          • :user_id - (String)
          • :group_name - (String)
          • :group_id - (String)
        • :ip_ranges - (Array)
          • :cidr_ip - (String)
      • :vpc_id - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the DescribeSnapshotAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :snapshot_id - required - (String) The ID of the Amazon EBS snapshot.
    • :attribute - required - (String) The snapshot attribute you would like to view. Valid values include:
      • productCodes
      • createVolumePermission

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_id - (String)
    • :create_volume_permission - (Array)
      • :user_id - (String)
      • :group - (String)
    • :product_codes - (Array)
      • :product_code - (String)
      • :type - (String)

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

Calls the DescribeSnapshots API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :snapshot_ids - (Array<) One or more snapshot IDs. Default: Describes snapshots for which you have launch permissions.
    • :owner_ids - (Array<) Returns the snapshots owned by the specified owner. Multiple owners can be specified.
    • :restorable_by_user_ids - (Array<) One or more AWS accounts IDs that can create volumes from the snapshot.
    • :filters - (Array<) One or more filters. description - A description of the snapshot. owner-alias - The AWS account alias (for example, amazon) that owns the snapshot. owner-id - The ID of the AWS account that owns the snapshot. progress - The progress of the snapshot, as a percentage (for example, 80%). snapshot-id - The snapshot ID. start-time - The time stamp when the snapshot was initiated. status - The status of the snapshot (pending | completed | error). tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. volume-id - The ID of the volume the snapshot is for. volume-size - The size of the volume, in GiB.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_set - (Array)
      • :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)
        • :key - (String)
        • :value - (String)
      • :encrypted - (Boolean)
      • :kms_key_id - (String)

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

Calls the DescribeSpotDatafeedSubscription API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :spot_datafeed_subscription - (Hash)
      • :owner_id - (String)
      • :bucket - (String)
      • :prefix - (String)
      • :state - (String)
      • :fault - (Hash)
        • :code - (String)
        • :message - (String)

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

Calls the DescribeSpotInstanceRequests API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :spot_instance_request_ids - (Array<) One or more Spot Instance request IDs.
    • :filters - (Array<) One or more filters. availability-zone-group - The Availability Zone group. create-time - The time stamp when the Spot Instance request was created. fault-code - The fault code related to the request. fault-message - The fault message related to the request. instance-id - The ID of the instance that fulfilled the request. launch-group - The Spot Instance launch group. launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination. launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh). launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume. launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB. launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1). launch.group-id - The security group for the instance. launch.image-id - The ID of the AMI. launch.instance-type - The type of instance (for example, m1.small). launch.kernel-id - The kernel ID. launch.key-name - The name of the key pair the instance launched with. launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance. launch.ramdisk-id - The RAM disk ID. network-interface.network-interface-id - The ID of the network interface. network-interface.device-index - The index of the device for the network interface attachment on the instance. network-interface.subnet-id - The ID of the subnet for the instance. network-interface.description - A description of the network interface. network-interface.private-ip-address - The primary private IP address of the network interface. network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated. network-interface.group-id - The ID of the security group associated with the network interface. network-interface.group-name - The name of the security group associated with the network interface. network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address. product-description - The product description associated with the instance (Linux/UNIX | Windows). spot-instance-request-id - The Spot Instance request ID. spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request. state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide for Linux. status-code - The short code describing the most recent evaluation of your Spot Instance request. status-message - The message explaining the status of the Spot Instance request. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. type - The type of Spot Instance request (one-time | persistent). launched-availability-zone - The Availability Zone in which the bid is launched. valid-from - The start date of the request. valid-until - The end date of the request.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :spot_instance_request_set - (Array)
      • :spot_instance_request_id - (String)
      • :spot_price - (String)
      • :type - (String)
      • :state - (String)
      • :fault - (Hash)
        • :code - (String)
        • :message - (String)
      • :status - (Hash)
        • :code - (String)
        • :update_time - (Time)
        • :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)
          • :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)
          • :virtual_name - (String)
          • :device_name - (String)
          • :ebs - (Hash)
            • :snapshot_id - (String)
            • :volume_size - (Integer)
            • :delete_on_termination - (Boolean)
            • :volume_type - (String)
            • :iops - (Integer)
            • :encrypted - (Boolean)
          • :no_device - (String)
        • :monitoring_enabled - (Boolean)
        • :subnet_id - (String)
        • :network_interface_set - (Array)
          • :network_interface_id - (String)
          • :device_index - (Integer)
          • :subnet_id - (String)
          • :description - (String)
          • :private_ip_address - (String)
          • :security_group_id - (Array)
          • :delete_on_termination - (Boolean)
          • :private_ip_addresses_set - (Array)
            • :private_ip_address - (String)
            • :primary - (Boolean)
          • :secondary_private_ip_address_count - (Integer)
          • :associate_public_ip_address - (Boolean)
        • :iam_instance_profile - (Hash)
          • :arn - (String)
          • :name - (String)
        • :ebs_optimized - (Boolean)
      • :instance_id - (String)
      • :create_time - (Time)
      • :product_description - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :launched_availability_zone - (String)

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

Calls the DescribeSpotPriceHistory API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :start_time - (String<) The start date and time of the Spot Price history data.
    • :end_time - (String<) The end date and time of the Spot Price history data.
    • :instance_types - (Array<) One or more instance types.
    • :product_descriptions - (Array<) One or more basic product descriptions.
    • :filters - (Array<) One or more filters. availability-zone - The Availability Zone for which prices should be returned. instance-type - The type of instance (for example, m1.small). product-description - The product description for the Spot Price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)). spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported). timestamp - The timestamp of the Spot Price history (for example, 2010-08-16T05:06:11.000Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :availability_zone - (String) The Availability Zone.
    • :max_results - (Integer) The number of rows to return.
    • :next_token - (String) The next set of rows to return.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :spot_price_history_set - (Array)
      • :instance_type - (String)
      • :product_description - (String)
      • :spot_price - (String)
      • :timestamp - (Time)
      • :availability_zone - (String)
    • :next_token - (String)

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

Calls the DescribeSubnets API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :subnet_ids - (Array<) One or more subnet IDs. Default: Describes all your subnets.
    • :filters - (Array<) One or more filters. availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name. available-ip-address-count - The number of IP addresses in the subnet that are available. cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names. defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name. state - The state of the subnet (pending | available). subnet-id - The ID of the subnet. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. vpc-id - The ID of the VPC for the subnet.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :subnet_set - (Array)
      • :subnet_id - (String)
      • :state - (String)
      • :vpc_id - (String)
      • :cidr_block - (String)
      • :available_ip_address_count - (Integer)
      • :availability_zone - (String)
      • :default_for_az - (Boolean)
      • :map_public_ip_on_launch - (Boolean)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the DescribeTags API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :filters - (Array<) One or more filters. key - The tag key. resource-id - The resource ID. resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway). value - The tag value.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :max_results - (Integer) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.
    • :next_token - (String) The token for the next set of items to return. (You received this token from a prior call.)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :tag_set - (Array)
      • :resource_id - (String)
      • :resource_type - (String)
      • :key - (String)
      • :value - (String)
    • :next_token - (String)

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

Calls the DescribeVolumeAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :volume_id - required - (String) The ID of the volume.
    • :attribute - (String) The instance attribute. Valid values include:
      • autoEnableIO
      • productCodes

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_id - (String)
    • :auto_enable_io - (Hash)
      • :value - (Boolean)
    • :product_codes - (Array)
      • :product_code - (String)
      • :type - (String)

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

Calls the DescribeVolumeStatus API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :volume_ids - (Array<) One or more volume IDs. Default: Describes all your volumes.
    • :filters - (Array<) One or more filters. action.code - The action code for the event (for example, enable-volume-io). action.description - A description of the action. action.event-id - The event ID associated with the action. availability-zone - The Availability Zone of the instance. event.description - A description of the event. event.event-id - The event ID. event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled). event.not-after - The latest end time for the event. event.not-before - The earliest start time for the event. volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance). volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled). volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :next_token - (String) The next paginated set of results to return using the pagination token returned by a previous call.
    • :max_results - (Integer) The maximum number of paginated volume items per response.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_status_set - (Array)
      • :volume_id - (String)
      • :availability_zone - (String)
      • :volume_status - (Hash)
        • :status - (String)
        • :details - (Array)
          • :name - (String)
          • :status - (String)
      • :events_set - (Array)
        • :event_type - (String)
        • :description - (String)
        • :not_before - (Time)
        • :not_after - (Time)
        • :event_id - (String)
      • :actions_set - (Array)
        • :code - (String)
        • :description - (String)
        • :event_type - (String)
        • :event_id - (String)
    • :next_token - (String)

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

Calls the DescribeVolumes API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :volume_ids - (Array<) One or more volume IDs.
    • :filters - (Array<) One or more filters. attachment.attach-time - The time stamp when the attachment initiated. attachment.delete-on-termination - Whether the volume is deleted on instance termination. attachment.device - The device name that is exposed to the instance (for example, /dev/sda1). attachment.instance-id - The ID of the instance the volume is attached to. attachment.status - The attachment state (attaching | attached | detaching | detached). availability-zone - The Availability Zone in which the volume was created. create-time - The time stamp when the volume was created. encrypted - The encryption status of the volume. size - The size of the volume, in GiB. snapshot-id - The snapshot from which the volume was created. status - The status of the volume (creating | available | in-use | deleting | deleted | error). tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. volume-id - The volume ID. volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.
    • :next_token - (String) The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
    • :max_results - (Integer) The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_set - (Array)
      • :volume_id - (String)
      • :size - (Integer)
      • :snapshot_id - (String)
      • :availability_zone - (String)
      • :status - (String)
      • :create_time - (Time)
      • :attachment_set - (Array)
        • :volume_id - (String)
        • :instance_id - (String)
        • :device - (String)
        • :status - (String)
        • :attach_time - (Time)
        • :delete_on_termination - (Boolean)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :volume_type - (String)
      • :iops - (Integer)
      • :encrypted - (Boolean)
      • :kms_key_id - (String)
    • :next_token - (String)

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

Calls the DescribeVpcAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_id - required - (String) The ID of the VPC.
    • :attribute - (String) The VPC attribute. Valid values include:
      • enableDnsSupport
      • enableDnsHostnames

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpc_id - (String)
    • :enable_dns_support - (Hash)
      • :value - (Boolean)
    • :enable_dns_hostnames - (Hash)
      • :value - (Boolean)

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

Calls the DescribeVpcClassicLink API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_ids - (Array<) One or more VPCs for which you want to describe the ClassicLink status.
    • :filters - (Array<) One or more filters. is-classic-link-enabled - Whether the VPC is enabled for ClassicLink ( true | false ). tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpc_set - (Array)
      • :vpc_id - (String)
      • :classic_link_enabled - (Boolean)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the DescribeVpcPeeringConnections API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_peering_connection_ids - (Array<) One or more VPC peering connection IDs. Default: Describes all your VPC peering connections.
    • :filters - (Array<) One or more filters. accepter-vpc-info.cidr-block - The CIDR block of the peer VPC. accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC. accepter-vpc-info.vpc-id - The ID of the peer VPC. expiration-time - The expiration date and time for the VPC peering connection. requester-vpc-info.cidr-block - The CIDR block of the requester's VPC. requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC. requester-vpc-info.vpc-id - The ID of the requester VPC. status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected). status-message - A message that provides more information about the status of the VPC peering connection, if applicable. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. vpc-peering-connection-id - The ID of the VPC peering connection.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpc_peering_connection_set - (Array)
      • :accepter_vpc_info - (Hash)
        • :cidr_block - (String)
        • :owner_id - (String)
        • :vpc_id - (String)
      • :expiration_time - (Time)
      • :requester_vpc_info - (Hash)
        • :cidr_block - (String)
        • :owner_id - (String)
        • :vpc_id - (String)
      • :status - (Hash)
        • :code - (String)
        • :message - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :vpc_peering_connection_id - (String)

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

Calls the DescribeVpcs API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_ids - (Array<) One or more VPC IDs. Default: Describes all your VPCs.
    • :filters - (Array<) One or more filters. cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28). dhcp-options-id - The ID of a set of DHCP options. isDefault - Indicates whether the VPC is the default VPC. state - The state of the VPC (pending | available). tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. vpc-id - The ID of the VPC.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpc_set - (Array)
      • :vpc_id - (String)
      • :state - (String)
      • :cidr_block - (String)
      • :dhcp_options_id - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :instance_tenancy - (String)
      • :is_default - (Boolean)

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

Calls the DescribeVpnConnections API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpn_connection_ids - (Array<) One or more VPN connection IDs. Default: Describes your VPN connections.
    • :filters - (Array<) One or more filters. customer-gateway-configuration - The configuration information for the customer gateway. customer-gateway-id - The ID of a customer gateway associated with the VPN connection. state - The state of the VPN connection (pending | available | deleting | deleted). option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP). route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center. bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device. tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. type - The type of VPN connection. Currently the only supported type is ipsec.1. vpn-connection-id - The ID of the VPN connection. vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpn_connection_set - (Array)
      • :vpn_connection_id - (String)
      • :state - (String)
      • :customer_gateway_configuration - (String)
      • :vpn_type - (String)
      • :customer_gateway_id - (String)
      • :vpn_gateway_id - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :vgw_telemetry - (Array)
        • :outside_ip_address - (String)
        • :status - (String)
        • :last_status_change - (Time)
        • :status_message - (String)
        • :accepted_route_count - (Integer)
      • :options - (Hash)
        • :static_routes_only - (Boolean)
      • :routes - (Array)
        • :destination_cidr_block - (String)
        • :source - (String)
        • :state - (String)

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

Calls the DescribeVpnGateways API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpn_gateway_ids - (Array<) One or more virtual private gateway IDs. Default: Describes all your virtual private gateways.
    • :filters - (Array<) One or more filters. attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached). attachment.vpc-id - The ID of an attached VPC. availability-zone - The Availability Zone for the virtual private gateway. state - The state of the virtual private gateway (pending | available | deleting | deleted). tag:key=value - The key/value combination of a tag assigned to the resource. tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter. tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. type - The type of virtual private gateway. Currently the only supported type is ipsec.1. vpn-gateway-id - The ID of the virtual private gateway.
      • :name - (String) The name of the filter. Filter names are case-sensitive.
      • :values - (Array<) One or more filter values. Filter values are case-sensitive.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :vpn_gateway_set - (Array)
      • :vpn_gateway_id - (String)
      • :state - (String)
      • :vpn_type - (String)
      • :availability_zone - (String)
      • :attachments - (Array)
        • :vpc_id - (String)
        • :state - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)

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

Calls the DetachClassicLinkVpc API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - required - (String) The ID of the instance to unlink from the VPC.
    • :vpc_id - required - (String) The ID of the VPC to which the instance is linked.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :return - (Boolean)

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

Calls the DetachInternetGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :internet_gateway_id - required - (String) The ID of the Internet gateway.
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

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

Calls the DetachNetworkInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :attachment_id - required - (String) The ID of the attachment.
    • :force - (Boolean) Specifies whether to force a detachment.

Returns:

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

Calls the DetachVolume API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :volume_id - required - (String) The ID of the volume.
    • :instance_id - (String) The ID of the instance.
    • :device - (String) The device name.
    • :force - (Boolean) Forces detachment if the previous detachment attempt did not occur cleanly (for example, 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 won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_id - (String)
    • :instance_id - (String)
    • :device - (String)
    • :status - (String)
    • :attach_time - (Time)
    • :delete_on_termination - (Boolean)

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

Calls the DetachVpnGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpn_gateway_id - required - (String) The ID of the virtual private gateway.
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

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

Calls the DisableVgwRoutePropagation API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :route_table_id - required - (String) The ID of the route table.
    • :gateway_id - required - (String) The ID of the virtual private gateway.

Returns:

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

Calls the DisableVpcClassicLink API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :return - (Boolean)

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

Calls the DisassociateAddress API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :public_ip - (String) [EC2-Classic] The Elastic IP address. Required for EC2-Classic.
    • :association_id - (String) [EC2-VPC] The association ID. Required for EC2-VPC.

Returns:

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

Calls the DisassociateRouteTable API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :association_id - required - (String) The association ID representing the current association between the route table and subnet.

Returns:

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

Calls the EnableVgwRoutePropagation API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :route_table_id - required - (String) The ID of the route table.
    • :gateway_id - required - (String) The ID of the virtual private gateway.

Returns:

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

Calls the EnableVolumeIO API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :volume_id - required - (String) The ID of the volume.

Returns:

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

Calls the EnableVpcClassicLink API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_id - required - (String) The ID of the VPC.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :return - (Boolean)

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

Calls the GetConsoleOutput API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - required - (String) The ID of the instance.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :instance_id - (String)
    • :timestamp - (Time)
    • :output - (String)

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

Calls the GetPasswordData API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - required - (String) The ID of the Windows instance.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :instance_id - (String)
    • :timestamp - (Time)
    • :password_data - (String)

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

Calls the ImportInstance API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :description - (String) A description for the instance being imported.
    • :launch_specification - (Hash)
      • :architecture - (String) The architecture of the instance. Valid values include:
        • i386
        • x86_64
      • :group_names - (Array<) One or more security group names.
      • :group_ids - (Array<)
      • :additional_info - (String)
      • :user_data - (Hash) User data to be made available to the instance.
        • :data - (String)
      • :instance_type - (String) The instance type. This is not supported for VMs imported into a VPC, which are assigned the default security group. After a VM is imported into a VPC, you can specify another security group using the AWS Management Console. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about the Linux instance types you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide for Linux. Valid values include:
        • t1.micro
        • m1.small
        • m1.medium
        • m1.large
        • m1.xlarge
        • m3.medium
        • m3.large
        • m3.xlarge
        • m3.2xlarge
        • t2.micro
        • t2.small
        • t2.medium
        • m2.xlarge
        • m2.2xlarge
        • m2.4xlarge
        • cr1.8xlarge
        • i2.xlarge
        • i2.2xlarge
        • i2.4xlarge
        • i2.8xlarge
        • hi1.4xlarge
        • hs1.8xlarge
        • c1.medium
        • c1.xlarge
        • c3.large
        • c3.xlarge
        • c3.2xlarge
        • c3.4xlarge
        • c3.8xlarge
        • cc1.4xlarge
        • cc2.8xlarge
        • g2.2xlarge
        • cg1.4xlarge
        • r3.large
        • r3.xlarge
        • r3.2xlarge
        • r3.4xlarge
        • r3.8xlarge
      • :placement - (Hash)
        • :availability_zone - (String) The Availability Zone of the instance.
        • :group_name - (String) The name of the placement group the instance is in (for cluster compute instances).
        • :tenancy - (String) The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. Valid values include:
          • default
          • dedicated
      • :monitoring - (Boolean)
      • :subnet_id - (String) [EC2-VPC] The ID of the subnet to launch the instance into.
      • :instance_initiated_shutdown_behavior - (String) Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Valid values include:
        • stop
        • terminate
      • :private_ip_address - (String) [EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet.
    • :disk_images - (Array<)
      • :image - (Hash)
        • :format - required - (String) The disk image format. Valid values include:
          • VMDK
          • RAW
          • VHD
        • :bytes - required - (Integer)
        • :import_manifest_url - required - (String) A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
      • :description - (String)
      • :volume - (Hash)
        • :size - required - (Integer) The size of the volume, in GiB.
    • :platform - required - (String) The instance operating system. Valid values include:
      • Windows

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :conversion_task - (Hash)
      • :conversion_task_id - (String)
      • :expiration_time - (String)
      • :import_instance - (Hash)
        • :volumes - (Array)
          • :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)
        • :key - (String)
        • :value - (String)

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

Calls the ImportKeyPair API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :key_name - required - (String) A unique name for the key pair.
    • :public_key_material - required - (String) The public key. You must base64 encode the public key material before sending it to AWS.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :key_name - (String)
    • :key_fingerprint - (String)

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

Calls the ImportVolume API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :availability_zone - required - (String) The Availability Zone for the resulting Amazon EBS volume.
    • :image - required - (Hash)
      • :format - required - (String) The disk image format. Valid values include:
        • VMDK
        • RAW
        • VHD
      • :bytes - required - (Integer)
      • :import_manifest_url - required - (String) A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
    • :description - (String) An optional description for the volume being imported.
    • :volume - required - (Hash)
      • :size - required - (Integer) The size of the volume, in GiB.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :conversion_task - (Hash)
      • :conversion_task_id - (String)
      • :expiration_time - (String)
      • :import_instance - (Hash)
        • :volumes - (Array)
          • :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)
        • :key - (String)
        • :value - (String)

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

Calls the ModifyImageAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :image_id - required - (String) The ID of the AMI.
    • :attribute - (String) The name of the attribute to modify.
    • :operation_type - (String) The operation type.
    • :user_ids - (Array<) One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
    • :user_groups - (Array<) One or more user groups. This is only valid when modifying the launchPermission attribute.
    • :product_codes - (Array<) One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
    • :value - (String) The value of the attribute being modified. This is only valid when modifying the description attribute.
    • :launch_permission - (Hash)
      • :add - (Array<) The AWS account ID to add to the list of launch permissions for the AMI.
        • :user_id - (String) The AWS account ID.
        • :group - (String) The name of the group. Valid values include:
          • all
      • :remove - (Array<) The AWS account ID to remove from the list of launch permissions for the AMI.
        • :user_id - (String) The AWS account ID.
        • :group - (String) The name of the group. Valid values include:
          • all
    • :description - (Hash) A description for the AMI.
      • :value - (String) Valid values are case-sensitive and vary by action.

Returns:

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

Calls the ModifyInstanceAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - required - (String) The ID of the instance.
    • :attribute - (String) The name of the attribute. Valid values include:
      • instanceType
      • kernel
      • ramdisk
      • userData
      • disableApiTermination
      • instanceInitiatedShutdownBehavior
      • rootDeviceName
      • blockDeviceMapping
      • productCodes
      • sourceDestCheck
      • groupSet
      • ebsOptimized
      • sriovNetSupport
    • :value - (String) A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.
    • :block_device_mappings - (Array<) Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated. To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
      • :device_name - (String) The device name exposed to the instance (for example, /dev/sdh).
      • :ebs - (Hash) Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
        • :volume_id - (String) The ID of the Amazon EBS volume.
        • :delete_on_termination - (Boolean) Indicates whether the volume is deleted on instance termination.
      • :virtual_name - (String) The virtual device name.
      • :no_device - (String) suppress the specified device included in the block device mapping.
    • :source_dest_check - (Hash) Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.
      • :value - (Boolean) Valid values are true or false .
    • :disable_api_termination - (Hash) If the value is true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
      • :value - (Boolean) Valid values are true or false .
    • :instance_type - (Hash) Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
      • :value - (String) Valid values are case-sensitive and vary by action.
    • :kernel - (Hash) Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
      • :value - (String) Valid values are case-sensitive and vary by action.
    • :ramdisk - (Hash) Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
      • :value - (String) Valid values are case-sensitive and vary by action.
    • :user_data - (Hash) Changes the instance's user data to the specified value.
      • :value - (String) Valid values are case-sensitive and vary by action.
    • :instance_initiated_shutdown_behavior - (Hash) Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
      • :value - (String) Valid values are case-sensitive and vary by action.
    • :groups - (Array<) [EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name. For example, if you want the instance to be in sg-1a1a1a1a and sg-9b9b9b9b, specify GroupId.1=sg-1a1a1a1a and GroupId.2=sg-9b9b9b9b.
    • :ebs_optimized - (Hash) Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
      • :value - (Boolean) Valid values are true or false .
    • :sriov_net_support - (Hash) Set to simple to enable enhanced networking for the instance. There is no way to disable enhanced networking at this time. This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
      • :value - (String) Valid values are case-sensitive and vary by action.

Returns:

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

Calls the ModifyNetworkInterfaceAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_interface_id - required - (String) The ID of the network interface.
    • :description - (Hash) A description for the network interface.
      • :value - (String) Valid values are case-sensitive and vary by action.
    • :source_dest_check - (Hash) Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
      • :value - (Boolean) Valid values are true or false .
    • :groups - (Array<) Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
    • :attachment - (Hash) Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
      • :attachment_id - (String) The ID of the network interface attachment.
      • :delete_on_termination - (Boolean) Indicates whether the network interface is deleted when the instance is terminated.

Returns:

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

Calls the ModifyReservedInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :client_token - (String) A unique, case-sensitive token you provide to ensure idempotency of your modification request.
    • :reserved_instances_ids - required - (Array<) The IDs of the Reserved Instances to modify.
    • :target_configurations - required - (Array<) The configuration settings for the Reserved Instances to modify.
      • :availability_zone - (String) The Availability Zone for the modified Reserved Instances.
      • :platform - (String) The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
      • :instance_count - (Integer) The number of modified Reserved Instances.
      • :instance_type - (String) The instance type for the modified Reserved Instances. Valid values include:
        • t1.micro
        • m1.small
        • m1.medium
        • m1.large
        • m1.xlarge
        • m3.medium
        • m3.large
        • m3.xlarge
        • m3.2xlarge
        • t2.micro
        • t2.small
        • t2.medium
        • m2.xlarge
        • m2.2xlarge
        • m2.4xlarge
        • cr1.8xlarge
        • i2.xlarge
        • i2.2xlarge
        • i2.4xlarge
        • i2.8xlarge
        • hi1.4xlarge
        • hs1.8xlarge
        • c1.medium
        • c1.xlarge
        • c3.large
        • c3.xlarge
        • c3.2xlarge
        • c3.4xlarge
        • c3.8xlarge
        • cc1.4xlarge
        • cc2.8xlarge
        • g2.2xlarge
        • cg1.4xlarge
        • r3.large
        • r3.xlarge
        • r3.2xlarge
        • r3.4xlarge
        • r3.8xlarge

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reserved_instances_modification_id - (String)

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

Calls the ModifySnapshotAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :snapshot_id - required - (String) The ID of the snapshot.
    • :attribute - (String) The snapshot attribute to modify. Valid values include:
      • productCodes
      • createVolumePermission
    • :operation_type - (String) The type of operation to perform to the attribute.
    • :user_ids - (Array<) The account ID to modify for the snapshot.
    • :group_names - (Array<) The group to modify for the snapshot.
    • :create_volume_permission - (Hash) A JSON representation of the snapshot attribute modification.
      • :add - (Array<) Adds a specific AWS account ID or group to a volume's list of create volume permissions.
        • :user_id - (String) The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.
        • :group - (String) The specific group that is to be added or removed from a volume's list of create volume permissions. Valid values include:
          • all
      • :remove - (Array<) Removes a specific AWS account ID or group from a volume's list of create volume permissions.
        • :user_id - (String) The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.
        • :group - (String) The specific group that is to be added or removed from a volume's list of create volume permissions. Valid values include:
          • all

Returns:

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

Calls the ModifySubnetAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :subnet_id - required - (String) The ID of the subnet.
    • :map_public_ip_on_launch - (Hash)
      • :value - (Boolean) Valid values are true or false .

Returns:

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

Calls the ModifyVolumeAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :volume_id - required - (String) The ID of the volume.
    • :auto_enable_io - (Hash) Indicates whether the volume should be auto-enabled for I/O operations.
      • :value - (Boolean) Valid values are true or false .

Returns:

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

Calls the ModifyVpcAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :vpc_id - required - (String) The ID of the VPC.
    • :enable_dns_support - (Hash) Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
      • :value - (Boolean) Valid values are true or false .
    • :enable_dns_hostnames - (Hash) Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. You can only enable DNS hostnames if you also enable DNS support.
      • :value - (Boolean) Valid values are true or false .

Returns:

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

Calls the MonitorInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_ids - required - (Array<) One or more instance IDs.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :instances_set - (Array)
      • :instance_id - (String)
      • :monitoring - (Hash)
        • :state - (String)

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

Calls the PurchaseReservedInstancesOffering API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :reserved_instances_offering_id - required - (String) The ID of the Reserved Instance offering to purchase.
    • :instance_count - required - (Integer) The number of Reserved Instances to purchase.
    • :limit_price - (Hash) Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
      • :amount - (Float) Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
      • :currency_code - (String) The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD. Valid values include:
        • USD

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reserved_instances_id - (String)

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

Calls the RebootInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_ids - required - (Array<) One or more instance IDs.

Returns:

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

Calls the RegisterImage API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :image_location - (String) The full path to your AMI manifest in Amazon S3 storage.
    • :name - required - (String) A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
    • :description - (String) A description for your AMI.
    • :architecture - (String) The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file. Valid values include:
      • i386
      • x86_64
    • :kernel_id - (String) The ID of the kernel.
    • :ramdisk_id - (String) The ID of the RAM disk.
    • :root_device_name - (String) The name of the root device (for example, /dev/sda1, or xvda).
    • :block_device_mappings - (Array<) One or more block device mapping entries.
      • :virtual_name - (String) The virtual device name (ephemeral[0..3]). The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
      • :device_name - (String) The device name exposed to the instance (for example, /dev/sdh).
      • :ebs - (Hash) Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
        • :snapshot_id - (String) The ID of the snapshot.
        • :volume_size - (Integer) The size of the volume, in GiB. Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
        • :delete_on_termination - (Boolean) Indicates whether the Amazon EBS volume is deleted on instance termination.
        • :volume_type - (String) The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes. Default: standard Valid values include:
          • standard
          • io1
          • gp2
        • :iops - (Integer) The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes. Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.
        • :encrypted - (Boolean) Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
      • :no_device - (String) Suppresses the specified device included in the block device mapping of the AMI.
    • :virtualization_type - (String) The type of virtualization. Default: paravirtual
    • :sriov_net_support - (String) Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI. There is no way to disable enhanced networking at this time. This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :image_id - (String)

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

Calls the RejectVpcPeeringConnection API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :vpc_peering_connection_id - required - (String) The ID of the VPC peering connection.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :return - (Boolean)

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

Calls the ReleaseAddress API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :public_ip - (String) [EC2-Classic] The Elastic IP address. Required for EC2-Classic.
    • :allocation_id - (String) [EC2-VPC] The allocation ID. Required for EC2-VPC.

Returns:

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

Calls the ReplaceNetworkAclAssociation API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :association_id - required - (String) The ID of the current association between the original network ACL and the subnet.
    • :network_acl_id - required - (String) The ID of the new network ACL to associate with the subnet.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :new_association_id - (String)

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

Calls the ReplaceNetworkAclEntry API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_acl_id - required - (String) The ID of the ACL.
    • :rule_number - required - (Integer) The rule number of the entry to replace.
    • :protocol - required - (String) The IP protocol. You can specify all or -1 to mean all protocols.
    • :rule_action - required - (String) Indicates whether to allow or deny the traffic that matches the rule. Valid values include:
      • allow
      • deny
    • :egress - required - (Boolean) Indicates whether to replace the egress rule. Default: If no value is specified, we replace the ingress rule.
    • :cidr_block - required - (String) The network range to allow or deny, in CIDR notation.
    • :icmp_type_code - (Hash) ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.
      • :type - (Integer) The ICMP code. A value of -1 means all codes for the specified ICMP type.
      • :code - (Integer) The ICMP type. A value of -1 means all types.
    • :port_range - (Hash) TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.
      • :from - (Integer) The first port in the range.
      • :to - (Integer) The last port in the range.

Returns:

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

Calls the ReplaceRoute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :route_table_id - required - (String) The ID of the route table.
    • :destination_cidr_block - required - (String) The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.
    • :gateway_id - (String) The ID of an Internet gateway or virtual private gateway.
    • :instance_id - (String) The ID of a NAT instance in your VPC.
    • :network_interface_id - (String) The ID of a network interface.
    • :vpc_peering_connection_id - (String) The ID of a VPC peering connection.

Returns:

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

Calls the ReplaceRouteTableAssociation API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :association_id - required - (String) The association ID.
    • :route_table_id - required - (String) The ID of the new route table to associate with the subnet.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :new_association_id - (String)

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

Calls the ReportInstanceStatus API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instances - required - (Array<) One or more instances.
    • :status - required - (String) The status of all instances listed. Valid values include:
      • ok
      • impaired
    • :start_time - (String<) The time at which the reported instance health state began.
    • :end_time - (String<) The time at which the reported instance health state ended.
    • :reason_codes - required - (Array<) One or more reason codes that describes the health state of your instance. instance-stuck-in-state: My instance is stuck in a state. unresponsive: My instance is unresponsive. not-accepting-credentials: My instance is not accepting my credentials. password-not-available: A password is not available for my instance. performance-network: My instance is experiencing performance problems which I believe are network related. performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores. performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume. performance-other: My instance is experiencing performance problems. other: [explain using the description parameter]
    • :description - (String) Descriptive text about the health state of your instance.

Returns:

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

Calls the RequestSpotInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :spot_price - required - (String) The maximum hourly price for any Spot Instance launched to fulfill the request.
    • :instance_count - (Integer) The maximum number of Spot Instances to launch. Default: 1
    • :type - (String) The Spot Instance request type. Default: one-time Valid values include:
      • one-time
      • persistent
    • :valid_from - (String<) 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. Default: The request is effective indefinitely.
    • :valid_until - (String<) The 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. Default: The request is effective indefinitely.
    • :launch_group - (String) The instance launch group. Launch groups are Spot Instances that launch together and terminate together. Default: Instances are launched and terminated individually
    • :availability_zone_group - (String) The user-specified name for a logical grouping of bids. When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active. If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group. Default: Instances are launched in any available Availability Zone.
    • :launch_specification - (Hash) The launch specification.
      • :image_id - (String) The ID of the AMI.
      • :key_name - (String) The name of the key pair.
      • :user_data - (String) The Base64-encoded MIME user data to make available to the instances.
      • :addressing_type - (String) Deprecated.
      • :instance_type - (String) The instance type. Default: m1.small Valid values include:
        • t1.micro
        • m1.small
        • m1.medium
        • m1.large
        • m1.xlarge
        • m3.medium
        • m3.large
        • m3.xlarge
        • m3.2xlarge
        • t2.micro
        • t2.small
        • t2.medium
        • m2.xlarge
        • m2.2xlarge
        • m2.4xlarge
        • cr1.8xlarge
        • i2.xlarge
        • i2.2xlarge
        • i2.4xlarge
        • i2.8xlarge
        • hi1.4xlarge
        • hs1.8xlarge
        • c1.medium
        • c1.xlarge
        • c3.large
        • c3.xlarge
        • c3.2xlarge
        • c3.4xlarge
        • c3.8xlarge
        • cc1.4xlarge
        • cc2.8xlarge
        • g2.2xlarge
        • cg1.4xlarge
        • r3.large
        • r3.xlarge
        • r3.2xlarge
        • r3.4xlarge
        • r3.8xlarge
      • :placement - (Hash) The placement information for the instance.
        • :availability_zone - (String) The Availability Zone.
        • :group_name - (String) The name of the placement group (for cluster instances).
      • :kernel_id - (String) The ID of the kernel.
      • :ramdisk_id - (String) The ID of the RAM disk.
      • :block_device_mappings - (Array<) One or more block device mapping entries.
        • :virtual_name - (String) The virtual device name (ephemeral[0..3]). The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
        • :device_name - (String) The device name exposed to the instance (for example, /dev/sdh).
        • :ebs - (Hash) Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
          • :snapshot_id - (String) The ID of the snapshot.
          • :volume_size - (Integer) The size of the volume, in GiB. Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
          • :delete_on_termination - (Boolean) Indicates whether the Amazon EBS volume is deleted on instance termination.
          • :volume_type - (String) The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes. Default: standard Valid values include:
            • standard
            • io1
            • gp2
          • :iops - (Integer) The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes. Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.
          • :encrypted - (Boolean) Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
        • :no_device - (String) Suppresses the specified device included in the block device mapping of the AMI.
      • :monitoring - (Hash)
        • :enabled - required - (Boolean)
      • :subnet_id - (String) The ID of the subnet in which to launch the Spot Instance.
      • :network_interfaces - (Array<) One or more network interfaces.
        • :network_interface_id - (String) The ID of the network interface.
        • :device_index - (Integer) The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
        • :subnet_id - (String) The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
        • :description - (String) The description of the network interface. Applies only if creating a network interface when launching an instance.
        • :private_ip_address - (String) The private IP address of the network interface. Applies only if creating a network interface when launching an instance.
        • :groups - (Array<) The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
        • :delete_on_termination - (Boolean) If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
        • :private_ip_addresses - (Array<) One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.
          • :private_ip_address - required - (String) The private IP addresses.
          • :primary - (Boolean) Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.
        • :secondary_private_ip_address_count - (Integer) The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.
        • :associate_public_ip_address - (Boolean) Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If luanching into a default subnet, the default value is true .
      • :iam_instance_profile - (Hash) The IAM instance profile.
        • :arn - (String) The Amazon Resource Name (ARN) of the instance profile.
        • :name - (String) The name of the instance profile.
      • :ebs_optimized - (Boolean) Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. Default: false
      • :security_groups - (Array<)
      • :security_group_ids - (Array<)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :spot_instance_request_set - (Array)
      • :spot_instance_request_id - (String)
      • :spot_price - (String)
      • :type - (String)
      • :state - (String)
      • :fault - (Hash)
        • :code - (String)
        • :message - (String)
      • :status - (Hash)
        • :code - (String)
        • :update_time - (Time)
        • :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)
          • :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)
          • :virtual_name - (String)
          • :device_name - (String)
          • :ebs - (Hash)
            • :snapshot_id - (String)
            • :volume_size - (Integer)
            • :delete_on_termination - (Boolean)
            • :volume_type - (String)
            • :iops - (Integer)
            • :encrypted - (Boolean)
          • :no_device - (String)
        • :monitoring_enabled - (Boolean)
        • :subnet_id - (String)
        • :network_interface_set - (Array)
          • :network_interface_id - (String)
          • :device_index - (Integer)
          • :subnet_id - (String)
          • :description - (String)
          • :private_ip_address - (String)
          • :security_group_id - (Array)
          • :delete_on_termination - (Boolean)
          • :private_ip_addresses_set - (Array)
            • :private_ip_address - (String)
            • :primary - (Boolean)
          • :secondary_private_ip_address_count - (Integer)
          • :associate_public_ip_address - (Boolean)
        • :iam_instance_profile - (Hash)
          • :arn - (String)
          • :name - (String)
        • :ebs_optimized - (Boolean)
      • :instance_id - (String)
      • :create_time - (Time)
      • :product_description - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :launched_availability_zone - (String)

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

Calls the ResetImageAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :image_id - required - (String) The ID of the AMI.
    • :attribute - required - (String) The attribute to reset (currently you can only reset the launch permission attribute). Valid values include:
      • launchPermission

Returns:

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

Calls the ResetInstanceAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_id - required - (String) The ID of the instance.
    • :attribute - required - (String) The attribute to reset. Valid values include:
      • instanceType
      • kernel
      • ramdisk
      • userData
      • disableApiTermination
      • instanceInitiatedShutdownBehavior
      • rootDeviceName
      • blockDeviceMapping
      • productCodes
      • sourceDestCheck
      • groupSet
      • ebsOptimized
      • sriovNetSupport

Returns:

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

Calls the ResetNetworkInterfaceAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :network_interface_id - required - (String) The ID of the network interface.
    • :source_dest_check - (String) The source/destination checking attribute. Resets the value to true .

Returns:

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

Calls the ResetSnapshotAttribute API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :snapshot_id - required - (String) The ID of the snapshot.
    • :attribute - required - (String) The attribute to reset (currently only the attribute for permission to create volumes can be reset). Valid values include:
      • productCodes
      • createVolumePermission

Returns:

#retryable_error?(response) ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
27
28
29
30
 
# File 'lib/aws/ec2/client.rb', line 24

def retryable_error?(response)
  if response.error.is_a?(Errors::InsufficientInstanceCapacity)
    false
  else
    super
  end
end

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

Calls the RevokeSecurityGroupEgress API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_id - required - (String) The ID of the security group.
    • :source_security_group_name - (String) [EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.
    • :source_security_group_owner_id - (String) The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.
    • :ip_protocol - (String) The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
    • :from_port - (Integer) The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    • :to_port - (Integer) The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    • :cidr_ip - (String) The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    • :ip_permissions - (Array<) A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
      • :ip_protocol - (String) The protocol. When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers.
      • :from_port - (Integer) The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
      • :to_port - (Integer) The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.
      • :user_id_group_pairs - (Array<) One or more security group and AWS account ID pairs.
        • :user_id - (String) The ID of an AWS account.
        • :group_name - (String) The ID of the security group owned by the specified AWS account.
        • :group_id - (String) The name of the security group in the specified AWS account.
      • :ip_ranges - (Array<) One or more IP ranges.
        • :cidr_ip - (String) The CIDR range. You can either specify a CIDR range or a source security group, not both.

Returns:

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

Calls the RevokeSecurityGroupIngress API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :group_name - (String) [EC2-Classic, default VPC] The name of the security group.
    • :group_id - (String) The ID of the security group.
    • :source_security_group_name - (String) [EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
    • :source_security_group_owner_id - (String) The ID of the source security group. You can't specify a source security group and a CIDR IP address range.
    • :ip_protocol - (String) The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
    • :from_port - (Integer) The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    • :to_port - (Integer) The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    • :cidr_ip - (String) The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    • :ip_permissions - (Array<) A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
      • :ip_protocol - (String) The protocol. When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers.
      • :from_port - (Integer) The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
      • :to_port - (Integer) The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.
      • :user_id_group_pairs - (Array<) One or more security group and AWS account ID pairs.
        • :user_id - (String) The ID of an AWS account.
        • :group_name - (String) The ID of the security group owned by the specified AWS account.
        • :group_id - (String) The name of the security group in the specified AWS account.
      • :ip_ranges - (Array<) One or more IP ranges.
        • :cidr_ip - (String) The CIDR range. You can either specify a CIDR range or a source security group, not both.

Returns:

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

Calls the RunInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :image_id - required - (String) The ID of the AMI, which you can get by calling DescribeImages.
    • :min_count - required - (Integer) The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
    • :max_count - required - (Integer) The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
    • :key_name - (String) The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair. If you launch an instance without specifying a key pair, you can't connect to the instance.
    • :security_groups - (Array<) [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. Default: Amazon EC2 uses the default security group.
    • :security_group_ids - (Array<) One or more security group IDs. You can create a security group using CreateSecurityGroup. Default: Amazon EC2 uses the default security group.
    • :user_data - (String) The Base64-encoded MIME user data for the instances.
    • :instance_type - (String) The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide. Default: m1.small Valid values include:
      • t1.micro
      • m1.small
      • m1.medium
      • m1.large
      • m1.xlarge
      • m3.medium
      • m3.large
      • m3.xlarge
      • m3.2xlarge
      • t2.micro
      • t2.small
      • t2.medium
      • m2.xlarge
      • m2.2xlarge
      • m2.4xlarge
      • cr1.8xlarge
      • i2.xlarge
      • i2.2xlarge
      • i2.4xlarge
      • i2.8xlarge
      • hi1.4xlarge
      • hs1.8xlarge
      • c1.medium
      • c1.xlarge
      • c3.large
      • c3.xlarge
      • c3.2xlarge
      • c3.4xlarge
      • c3.8xlarge
      • cc1.4xlarge
      • cc2.8xlarge
      • g2.2xlarge
      • cg1.4xlarge
      • r3.large
      • r3.xlarge
      • r3.2xlarge
      • r3.4xlarge
      • r3.8xlarge
    • :placement - (Hash) The placement for the instance.
      • :availability_zone - (String) The Availability Zone of the instance.
      • :group_name - (String) The name of the placement group the instance is in (for cluster compute instances).
      • :tenancy - (String) The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. Valid values include:
        • default
        • dedicated
    • :kernel_id - (String) The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
    • :ramdisk_id - (String) The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
    • :block_device_mappings - (Array<) The block device mapping.
      • :virtual_name - (String) The virtual device name (ephemeral[0..3]). The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
      • :device_name - (String) The device name exposed to the instance (for example, /dev/sdh).
      • :ebs - (Hash) Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
        • :snapshot_id - (String) The ID of the snapshot.
        • :volume_size - (Integer) The size of the volume, in GiB. Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
        • :delete_on_termination - (Boolean) Indicates whether the Amazon EBS volume is deleted on instance termination.
        • :volume_type - (String) The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes. Default: standard Valid values include:
          • standard
          • io1
          • gp2
        • :iops - (Integer) The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes. Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.
        • :encrypted - (Boolean) Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
      • :no_device - (String) Suppresses the specified device included in the block device mapping of the AMI.
    • :monitoring - (Hash) The monitoring for the instance.
      • :enabled - required - (Boolean) Indicates whether monitoring is enabled for the instance.
    • :subnet_id - (String) [EC2-VPC] The ID of the subnet to launch the instance into.
    • :disable_api_termination - (Boolean) If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance. Default: false
    • :instance_initiated_shutdown_behavior - (String) Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Default: stop Valid values include:
      • stop
      • terminate
    • :private_ip_address - (String) [EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet. Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address. Default: We select an IP address from the IP address range of the subnet.
    • :client_token - (String) Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide. Constraints: Maximum 64 ASCII characters
    • :additional_info - (String) Reserved.
    • :network_interfaces - (Array<) One or more network interfaces.
      • :network_interface_id - (String) The ID of the network interface.
      • :device_index - (Integer) The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
      • :subnet_id - (String) The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
      • :description - (String) The description of the network interface. Applies only if creating a network interface when launching an instance.
      • :private_ip_address - (String) The private IP address of the network interface. Applies only if creating a network interface when launching an instance.
      • :groups - (Array<) The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
      • :delete_on_termination - (Boolean) If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
      • :private_ip_addresses - (Array<) One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.
        • :private_ip_address - required - (String) The private IP addresses.
        • :primary - (Boolean) Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.
      • :secondary_private_ip_address_count - (Integer) The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.
      • :associate_public_ip_address - (Boolean) Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If luanching into a default subnet, the default value is true .
    • :iam_instance_profile - (Hash) The IAM instance profile.
      • :arn - (String) The Amazon Resource Name (ARN) of the instance profile.
      • :name - (String) The name of the instance profile.
    • :ebs_optimized - (Boolean) Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. Default: false

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :reservation_id - (String)
    • :owner_id - (String)
    • :requester_id - (String)
    • :group_set - (Array)
      • :group_name - (String)
      • :group_id - (String)
    • :instances_set - (Array)
      • :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)
        • :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)
        • :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)
      • :client_token - (String)
      • :tag_set - (Array)
        • :key - (String)
        • :value - (String)
      • :group_set - (Array)
        • :group_name - (String)
        • :group_id - (String)
      • :source_dest_check - (Boolean)
      • :hypervisor - (String)
      • :network_interface_set - (Array)
        • :network_interface_id - (String)
        • :subnet_id - (String)
        • :vpc_id - (String)
        • :description - (String)
        • :owner_id - (String)
        • :status - (String)
        • :mac_address - (String)
        • :private_ip_address - (String)
        • :private_dns_name - (String)
        • :source_dest_check - (Boolean)
        • :group_set - (Array)
          • :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)
          • :public_dns_name - (String)
          • :ip_owner_id - (String)
        • :private_ip_addresses_set - (Array)
          • :private_ip_address - (String)
          • :private_dns_name - (String)
          • :primary - (Boolean)
          • :association - (Hash)
            • :public_ip - (String)
            • :public_dns_name - (String)
            • :ip_owner_id - (String)
      • :iam_instance_profile - (Hash)
        • :arn - (String)
        • :id - (String)
      • :ebs_optimized - (Boolean)
      • :sriov_net_support - (String)

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

Calls the StartInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :instance_ids - required - (Array<) One or more instance IDs.
    • :additional_info - (String) Reserved.
    • :dry_run - (Boolean)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :instances_set - (Array)
      • :instance_id - (String)
      • :current_state - (Hash)
        • :code - (Integer)
        • :name - (String)
      • :previous_state - (Hash)
        • :code - (Integer)
        • :name - (String)

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

Calls the StopInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_ids - required - (Array<) One or more instance IDs.
    • :force - (Boolean) Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. Default: false

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :instances_set - (Array)
      • :instance_id - (String)
      • :current_state - (Hash)
        • :code - (Integer)
        • :name - (String)
      • :previous_state - (Hash)
        • :code - (Integer)
        • :name - (String)

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

Calls the TerminateInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_ids - required - (Array<) One or more instance IDs.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :instances_set - (Array)
      • :instance_id - (String)
      • :current_state - (Hash)
        • :code - (Integer)
        • :name - (String)
      • :previous_state - (Hash)
        • :code - (Integer)
        • :name - (String)

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

Calls the UnassignPrivateIpAddresses API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :network_interface_id - required - (String) The ID of the network interface.
    • :private_ip_addresses - required - (Array<) The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

Returns:

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

Calls the UnmonitorInstances API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :dry_run - (Boolean)
    • :instance_ids - required - (Array<) One or more instance IDs.

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :instances_set - (Array)
      • :instance_id - (String)
      • :monitoring - (Hash)
        • :state - (String)