|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/boto/ec2/__pycache__/ |
Upload File : |
o
ckF[� � @ s d Z ddlZddlZddlmZ ddlmZ ddlZddlmZ ddlm Z ddl
m Z ddl m
Z
mZmZ dd lmZmZ dd
lmZmZ dd lmZ dd lmZ dd
lmZmZ ddl m Z ddl m Z ddl m Z ddl!m"Z" ddl#m$Z$ ddl%m&Z& ddl'm(Z( ddl'm)Z) ddl'm*Z* ddl'm+Z+ ddl'm,Z, ddl'm-Z- ddl.m/Z/ ddl0m1Z1 dd l2m3Z3 dd l4m5Z5 dd l6m7Z7 dd l8m9Z9 dd l:m;Z; dd!l<m=Z= dd"l>m?Z? dd#l@mAZA dd$lBmCZCmDZD dd%lEmFZFmGZG dd&lHmIZI dd'lJmKZK G d(d)� d)e �ZLdS )*z-
Represents a connection to the EC2 service.
� N)�datetime)� timedelta)�detect_potential_sigv4)�AWSQueryConnection)� ResultSet)�Image�ImageAttribute� CopyImage)� Reservation�Instance)�
ConsoleOutput�InstanceAttribute)�KeyPair)�Address)�Volume�VolumeAttribute)�Snapshot)�SnapshotAttribute)�Zone)�
SecurityGroup)�
RegionInfo)� InstanceInfo)�ReservedInstancesOffering)�ReservedInstance)�ReservedInstanceListing)� ReservedInstancesConfiguration)� ModifyReservedInstancesResult)� ReservedInstancesModification)�SpotInstanceRequest)�SpotPriceHistory)�SpotDatafeedSubscription)�BundleInstanceTask)�PlacementGroup)�Tag)� InstanceType)�InstanceStatusSet)�VolumeStatusSet)�NetworkInterface)�AccountAttribute� VPCAttribute)�BlockDeviceMapping�BlockDeviceType)�EC2ResponseError)�sixc s� e Zd Zej�ddd�Zej�ddd�Zej�ddd�Ze Z
d�� fd d
� Z dd� Z dd� Z
dd� Z d�dd�Zd�dd�Zd�dd�Zd�dd �Z d�d d �Zd�d d �Z d�d!d"�Z # d�d$d%�Z # �d d'd(�Z # d�d)d*�Z �dd+d,�Z �dd-d.�Z �dd/d0�Z �dd1d2�Z 3 �dd5d6�Z �dd7d8�Z �dd9d:�Z �dd;d<�Z d�d=d>�Z!�dd?d@�Z" d�dAdB�Z#d�dCdD�Z$ �ddEdF�Z% d�dGdH�Z&d�dIdJ�Z' d�dKdL�Z( �ddMdN�Z) O �ddPdQ�Z*d�dRdS�Z+d�dTdU�Z,d�dVdW�Z-d�dXdY�Z.d�dZd[�Z/ �d d\d]�Z0�dd^d_�Z1 �d
d`da�Z2 �d dbdc�Z3 �d ddde�Z4 �d dfdg�Z5 d�dhdi�Z6 d�djdk�Z7 d�dldm�Z8d�dndo�Z9 d�dpdq�Z:d�drds�Z; �d dudv�Z< d�dwdx�Z= �d
dydz�Z>d�d{d|�Z?d�d}d~�Z@ �ddd��ZA d�d�d��ZB�dd�d��ZCd�d�d��ZD �dd�d��ZE � �dd�d��ZF � �dd�d��ZG � �dd�d��ZH � �dd�d��ZId�d�d��ZJd�d�d��ZKd�d�d��ZLd�d�d��ZMd�d�d��ZN �d d�d��ZO �dd�d��ZPd�d�d��ZQ �dd�d��ZR �dd�d��ZS d�d�d��ZT �dd�d��ZU �dd�d��ZV d�d�d��ZWd�d�d��ZX �dd�d��ZY d�d�d��ZZ �dd�d��Z[ d�d�d��Z\ �dd�d��Z]d�d�� Z^d�d�� Z_ �dd�dZ`d�d�dĄZad�d�dƄZbd�d�dȄZcd�d�dʄZd d�d�d̄Ze d�d�d΄Zfd�d�dЄZgd�d�d҄Zh d�d�dԄZi�dd�dׄZjd�d�dلZkd�dۄ Zl�dd�d݄Zmd�d�d߄Znd�d�d�Zod�d�d�Zp �d d�d�Zq d�d�d�Zr d�d�d�Zsd�d�d�Ztd�d� Zu �dd�d�Zv�dd�d�Zw�dd�d�Zx d�d�d��Zy �dd�d��Zz� Z{S ( �
EC2Connection�Boto� ec2_versionz
2014-10-01�ec2_region_namez us-east-1�ec2_region_endpointzec2.us-east-1.amazonaws.comNTr �/c s^ | s
t | | j| j�} | | _tt| �j|||||||| | jj|
| |
|||d� |r-|| _dS dS )z@
Init method to create a new connection to EC2.
)�validate_certs� profile_nameN) r �DefaultRegionName�DefaultRegionEndpoint�region�superr. �__init__�endpoint�
APIVersion)�self�aws_access_key_id�aws_secret_access_key� is_secure�host�port�proxy�
proxy_port�
proxy_user�
proxy_pass�debug�https_connection_factoryr8 �path� api_version�security_tokenr4 r5 �� __class__� �5/usr/lib/python3/dist-packages/boto/ec2/connection.pyr: Q s$
� �
�zEC2Connection.__init__c C s dgS )Nzhmac-v4rN )r= rN rN rO �_required_auth_capabilityk s z'EC2Connection._required_auth_capabilityc C s( g d�}i }|D ] }t | |�||< q|S )z�
Returns a dictionary containing the value of all of the keyword
arguments passed when constructing this connection.
)
r> r? r@ rB rC rD rE rF rG rH )�getattr)r= � param_names�params�namerN rN rO �
get_paramsn s
zEC2Connection.get_paramsc C s� t |t�s t|�}d}|D ]8}|}|�d�s |�dd�}||d| < || }t |t�s.|g}d}|D ]}||d||f < |d7 }q2|d7 }q
d S )N� ztag:�_�-zFilter.%d.NamezFilter.%d.Value.%d)�
isinstance�dict�
startswith�replace�list) r= rS �filters�irT �aws_name�value�j�vrN rN rO �build_filter_params| s"
�z!EC2Connection.build_filter_paramsFc C �n i }|r | � ||d� |r| � ||d� |r | � ||d� |r%| �||� |r+d|d< | jd|dtfgdd �S )
a�
Retrieve all the EC2 images available on your account.
:type image_ids: list
:param image_ids: A list of strings with the image IDs wanted
:type owners: list
:param owners: A list of owner IDs, the special strings 'self',
'amazon', and 'aws-marketplace', may be used to describe
images owned by you, Amazon or AWS Marketplace
respectively
:type executable_by: list
:param executable_by: Returns AMIs for which the specified
user ID has explicit launch permissions
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.image.Image`
�ImageId�Owner� ExecutableBy�true�DryRun�DescribeImages�item�POST��verb��build_list_paramsrd �get_listr )r= � image_ids�owners�
executable_byr^ �dry_runrS rN rN rO �get_all_images� s
�z EC2Connection.get_all_imagesc C �` i }|r | � ||d� |r| � ||d� ddi}| �||� |r$d|d< | jd|dtfgd d
�S ) a�
Retrieve all the EC2 kernels available on your account.
Constructs a filter to allow the processing to happen server side.
:type kernel_ids: list
:param kernel_ids: A list of strings with the image IDs wanted
:type owners: list
:param owners: A list of owner IDs
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.image.Image`
rf rg �
image-type�kernelri rj rk rl rm rn rp )r= �
kernel_idsrt rv rS �filterrN rN rO �get_all_kernels� �
�z EC2Connection.get_all_kernelsc C rx ) a�
Retrieve all the EC2 ramdisks available on your account.
Constructs a filter to allow the processing to happen server side.
:type ramdisk_ids: list
:param ramdisk_ids: A list of strings with the image IDs wanted
:type owners: list
:param owners: A list of owner IDs
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.image.Image`
rf rg ry �ramdiskri rj rk rl rm rn rp )r= � ramdisk_idsrt rv rS r| rN rN rO �get_all_ramdisks� r~ z EC2Connection.get_all_ramdisksc C s, z | j |g|d�d W S ty Y dS w )a�
Shortcut method to retrieve a specific image (AMI).
:type image_id: string
:param image_id: the ID of the Image to retrieve
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.image.Image`
:return: The EC2 Image specified or None if the image is not found
)rs rv r N)rw �
IndexError)r= �image_idrv rN rN rO � get_image� s
�zEC2Connection.get_imagec C s� i }|r||d< |r||d< |r||d< |r||d< |r ||d< |r&||d< |r,||d< | r;t | |
d�}t� }|||< |rB|�|� | rHd |d
< |
rN|
|d < | rT| |d < | jd
|tdd�}t|dd�}|S )a?
Register an image.
:type name: string
:param name: The name of the AMI. Valid only for EBS-based images.
:type description: string
:param description: The description of the AMI.
:type image_location: string
:param image_location: Full path to your AMI manifest in
Amazon S3 storage. Only used for S3-based AMI's.
:type architecture: string
:param architecture: The architecture of the AMI. Valid choices are:
* i386
* x86_64
:type kernel_id: string
:param kernel_id: The ID of the kernel with which to launch
the instances
:type root_device_name: string
:param root_device_name: The root device name (e.g. /dev/sdh)
:type block_device_map: :class:`boto.ec2.blockdevicemapping.BlockDeviceMapping`
:param block_device_map: A BlockDeviceMapping data structure
describing the EBS volumes associated with the Image.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:type virtualization_type: string
:param virtualization_type: The virutalization_type of the image.
Valid choices are:
* paravirtual
* hvm
:type sriov_net_support: string
:param sriov_net_support: Advanced networking support.
Valid choices are:
* simple
:type snapshot_id: string
:param snapshot_id: A snapshot ID for the snapshot to be used
as root device for the image. Mutually exclusive with
block_device_map, requires root_device_name
:type delete_root_volume_on_termination: bool
:param delete_root_volume_on_termination: Whether to delete the root
volume of the image after instance termination. Only applies when
creating image from snapshot_id. Defaults to False. Note that
leaving volumes behind after instance termination is not free.
:rtype: string
:return: The new image id
�Name� Description� Architecture�KernelId� RamdiskId�
ImageLocation�RootDeviceName)� snapshot_id�delete_on_terminationri rj �VirtualizationType�SriovNetSupport�
RegisterImagerm rn �imageIdN)r+ r* �ec2_build_list_params�
get_objectr rQ )r= rT � description�image_location� architecture� kernel_id�
ramdisk_id�root_device_name�block_device_maprv �virtualization_type�sriov_net_supportr� �!delete_root_volume_on_terminationrS �root_vol�rsr� rN rN rO �register_image s@ @�
z EC2Connection.register_imagec C st d}|r| � |�}|jD ]}|dkr|j| j} nq d|i}|r%d|d< | jd|dd�}|r8|r8|o7| �|�S |S ) a�
Unregister an AMI.
:type image_id: string
:param image_id: the ID of the Image to unregister
:type delete_snapshot: bool
:param delete_snapshot: Set to True if we should delete the
snapshot associated with an EBS volume mounted at /dev/sda1
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
Nz /dev/sda1rf ri rj �DeregisterImagerm rn )r� �block_device_mappingr� �
get_status�delete_snapshot) r= r� r� rv r� �image�keyrS �resultrN rN rO �deregister_imagel s$
���z EC2Connection.deregister_imagec C sT ||d�}|r ||d< |rd|d< |r|� |� |r d|d< | jd|tdd�}|jS ) a�
Will create an AMI from the instance in the running or stopped
state.
:type instance_id: string
:param instance_id: the ID of the instance to image.
:type name: string
:param name: The name of the new image
:type description: string
:param description: An optional human-readable string describing
the contents and purpose of the AMI.
:type no_reboot: bool
:param no_reboot: An optional flag indicating that the
bundling process should not attempt to shutdown the
instance before bundling. If this flag is True, the
responsibility of maintaining file system integrity is
left to the owner of the instance.
:type block_device_mapping: :class:`boto.ec2.blockdevicemapping.BlockDeviceMapping`
:param block_device_mapping: A BlockDeviceMapping data structure
describing the EBS volumes associated with the Image.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: string
:return: The new image id
)�
InstanceIdr� r� ri �NoRebootrj � CreateImagerm rn )r� r� r �id) r= � instance_idrT r� � no_rebootr� rv rS �imgrN rN rO � create_image� s "�
zEC2Connection.create_image�launchPermissionc C �( ||d�}|r d|d< | j d|tdd�S )a�
Gets an attribute from an image.
:type image_id: string
:param image_id: The Amazon image id for which you want info about
:type attribute: string
:param attribute: The attribute you need information about.
Valid choices are:
* launchPermission
* productCodes
* blockDeviceMapping
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.image.ImageAttribute`
:return: An ImageAttribute object representing the value of the
attribute requested
�rf � Attributeri rj �DescribeImageAttributerm rn )r� r �r= r� � attributerv rS rN rN rO �get_image_attribute� s ��z!EC2Connection.get_image_attribute�addc C s^ |||d�}|r| � ||d� |r| � ||d� |r!| � ||d� |r'd|d< | jd|dd �S )
a�
Changes an attribute of an image.
:type image_id: string
:param image_id: The image id you wish to change
:type attribute: string
:param attribute: The attribute you wish to change
:type operation: string
:param operation: Either add or remove (this is required for changing
launchPermissions)
:type user_ids: list
:param user_ids: The Amazon IDs of users to add/remove attributes
:type groups: list
:param groups: The groups to add/remove attributes
:type product_codes: list
:param product_codes: Amazon DevPay product code. Currently only one
product code can be associated with an AMI. Once
set, the product code cannot be changed or reset.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
)rf r� �
OperationType�UserId� UserGroup� ProductCoderi rj �ModifyImageAttributerm rn �rq r� ) r= r� r� � operation�user_ids�groups�
product_codesrv rS rN rN rO �modify_image_attribute� s �z$EC2Connection.modify_image_attributec C �& ||d�}|r d|d< | j d|dd�S )a�
Resets an attribute of an AMI to its default value.
:type image_id: string
:param image_id: ID of the AMI for which an attribute will be described
:type attribute: string
:param attribute: The attribute to reset
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: Whether the operation succeeded or not
r� ri rj �ResetImageAttributerm rn �r� r� rN rN rO �reset_image_attribute � �z#EC2Connection.reset_image_attributec C s t �dt� | j||||d�S )a
Retrieve all the instance reservations associated with your account.
.. note::
This method's current behavior is deprecated in favor of
:meth:`get_all_reservations`. A future major release will change
:meth:`get_all_instances` to return a list of
:class:`boto.ec2.instance.Instance` objects as its name suggests.
To obtain that behavior today, use :meth:`get_only_instances`.
:type instance_ids: list
:param instance_ids: A list of strings of instance IDs
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:type max_results: int
:param max_results: The maximum number of paginated instance
items per response.
:rtype: list
:return: A list of :class:`boto.ec2.instance.Reservation`
zXThe current get_all_instances implementation will be replaced with get_all_reservations.)� instance_idsr^ rv � max_results)�warnings�warn�PendingDeprecationWarning�get_all_reservations)r= r� r^ rv r� rN rN rO �get_all_instances" s "��z EC2Connection.get_all_instancesc C sD d}g } | j |||||d�}|�dd� |D �� |j}|s! |S q)a�
Retrieve all the instances associated with your account.
:type instance_ids: list
:param instance_ids: A list of strings of instance IDs
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:type max_results: int
:param max_results: The maximum number of paginated instance
items per response.
:rtype: list
:return: A list of :class:`boto.ec2.instance.Instance`
NT)r� r^ rv r� �
next_tokenc S s g | ]
}|j D ]}|�qqS rN )� instances)�.0� reservation�instancerN rN rO �
<listcomp>o s
�
�z4EC2Connection.get_only_instances.<locals>.<listcomp>)r� �extendr� )r= r� r^ rv r� r� �retval� reservationsrN rN rO �get_only_instancesK s ��z EC2Connection.get_only_instancesc C s� i }|r | � ||d� |r-d|v r'|�d�}|�d�r!t|�dkr't�dt� | �||� |r3d|d< |dur;||d < |rA||d
< | jd |d t fgd
d�S )a-
Retrieve all the instance reservations associated with your account.
:type instance_ids: list
:param instance_ids: A list of strings of instance IDs
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:type max_results: int
:param max_results: The maximum number of paginated instance
items per response.
:type next_token: str
:param next_token: A string specifying the next paginated set
of results to return.
:rtype: list
:return: A list of :class:`boto.ec2.instance.Reservation`
r� zgroup-id�sg-� z�The group-id filter now requires a security group identifier (sg-*) instead of a group name. To filter by group name use the 'group-name' filter instead.ri rj N�
MaxResults� NextToken�DescribeInstancesrl rm rn )
rq �getr[ �lenr� r� � UserWarningrd rr r
)r= r� r^ rv r� r� rS �gidrN rN rO r� w s*
�
�z"EC2Connection.get_all_reservationsc C sh i }|r | � ||d� |r||d< |r||d< |r | �||� |r%d|d< |r+d|d< | jd|tdd �S )
a
Retrieve all the instances in your account scheduled for maintenance.
:type instance_ids: list
:param instance_ids: A list of strings of instance IDs
:type max_results: int
:param max_results: The maximum number of paginated instance
items per response.
:type next_token: str
:param next_token: A string specifying the next paginated set
of results to return.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:type include_all_instances: bool
:param include_all_instances: Set to True if all
instances should be returned. (Only running
instances are included by default.)
:rtype: list
:return: A list of instances that have maintenance scheduled.
r� r� r� ri rj �IncludeAllInstances�DescribeInstanceStatusrm rn )rq rd r� r% )r= r� r� r� r^ rv �include_all_instancesrS rN rN rO �get_all_instance_status� s ' �z%EC2Connection.get_all_instance_statusrV �m1.smallc C s� |||d�} |r || d< |r-g } |D ]} t | t�r | �| j� q| �| � q| �| | d� |rNg } |D ]} t | t�rA| �| j� q3| �| � q3| �| | d� |ret |tj�r[|�d�}t �
|�� d�| d< |rk|| d< |rq|| d< | rw| | d < |r}|| d
< |r�|| d < |
r�|
| d < | r�| | d
< | r�d| d< |
r�|
| d< |r�|| d< |r�|� | � |r�d| d< |r�|} | | d< |r�|| d< |r�|| d< |r�|| d< |r�|| d< |r�d| d< |r�|�| � |r�d| d< | j
d| tdd �S ) a
Runs an image on EC2.
:type image_id: string
:param image_id: The ID of the image to run.
:type min_count: int
:param min_count: The minimum number of instances to launch.
:type max_count: int
:param max_count: The maximum number of instances to launch.
:type key_name: string
:param key_name: The name of the key pair with which to
launch instances.
:type security_groups: list of strings
:param security_groups: The names of the EC2 classic security groups
with which to associate instances
:type user_data: string
:param user_data: The user data passed to the launched instances
:type instance_type: string
:param instance_type: The type of instance to run:
* t1.micro
* m1.small
* m1.medium
* m1.large
* m1.xlarge
* m3.medium
* m3.large
* m3.xlarge
* m3.2xlarge
* c1.medium
* c1.xlarge
* m2.xlarge
* m2.2xlarge
* m2.4xlarge
* cr1.8xlarge
* hi1.4xlarge
* hs1.8xlarge
* cc1.4xlarge
* cg1.4xlarge
* cc2.8xlarge
* g2.2xlarge
* c3.large
* c3.xlarge
* c3.2xlarge
* c3.4xlarge
* c3.8xlarge
* c4.large
* c4.xlarge
* c4.2xlarge
* c4.4xlarge
* c4.8xlarge
* i2.xlarge
* i2.2xlarge
* i2.4xlarge
* i2.8xlarge
* t2.micro
* t2.small
* t2.medium
:type placement: string
:param placement: The Availability Zone to launch the instance into.
:type kernel_id: string
:param kernel_id: The ID of the kernel with which to launch the
instances.
:type ramdisk_id: string
:param ramdisk_id: The ID of the RAM disk with which to launch the
instances.
:type monitoring_enabled: bool
:param monitoring_enabled: Enable detailed CloudWatch monitoring on
the instance.
:type subnet_id: string
:param subnet_id: The subnet ID within which to launch the instances
for VPC.
:type private_ip_address: string
:param private_ip_address: If you're using VPC, you can
optionally use this parameter to assign the instance a
specific available IP address from the subnet (e.g.,
10.0.0.25).
:type block_device_map: :class:`boto.ec2.blockdevicemapping.BlockDeviceMapping`
:param block_device_map: A BlockDeviceMapping data structure
describing the EBS volumes associated with the Image.
:type disable_api_termination: bool
:param disable_api_termination: If True, the instances will be locked
and will not be able to be terminated via the API.
:type instance_initiated_shutdown_behavior: string
:param instance_initiated_shutdown_behavior: Specifies whether the
instance stops or terminates on instance-initiated shutdown.
Valid values are:
* stop
* terminate
:type placement_group: string
:param placement_group: If specified, this is the name of the placement
group in which the instance(s) will be launched.
:type client_token: string
:param client_token: Unique, case-sensitive identifier you provide
to ensure idempotency of the request. Maximum 64 ASCII characters.
:type security_group_ids: list of strings
:param security_group_ids: The ID of the VPC security groups with
which to associate instances.
:type additional_info: string
:param additional_info: Specifies additional information to make
available to the instance(s).
:type tenancy: string
:param tenancy: The tenancy of the instance you want to
launch. An instance with a tenancy of 'dedicated' runs on
single-tenant hardware and can only be launched into a
VPC. Valid values are:"default" or "dedicated".
NOTE: To use dedicated tenancy you MUST specify a VPC
subnet-ID as well.
:type instance_profile_arn: string
:param instance_profile_arn: The Amazon resource name (ARN) of
the IAM Instance Profile (IIP) to associate with the instances.
:type instance_profile_name: string
:param instance_profile_name: The name of
the IAM Instance Profile (IIP) to associate with the instances.
:type ebs_optimized: bool
:param ebs_optimized: 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.
:type network_interfaces: :class:`boto.ec2.networkinterface.NetworkInterfaceCollection`
:param network_interfaces: A NetworkInterfaceCollection data
structure containing the ENI specifications for the instance.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: Reservation
:return: The :class:`boto.ec2.instance.Reservation` associated with
the request for machines
)rf �MinCount�MaxCount�KeyName�SecurityGroupIdr zutf-8�UserData�AddressingTyper$ zPlacement.AvailabilityZonezPlacement.GroupNamezPlacement.Tenancyr� r� ri zMonitoring.Enabled�SubnetId�PrivateIpAddress�DisableApiTermination�!InstanceInitiatedShutdownBehavior� ClientToken�AdditionalInfozIamInstanceProfile.NamezIamInstanceProfile.Arn� EbsOptimizedrj � RunInstancesrm rn )rY r �appendr� rq rT r- � text_type�encode�base64� b64encode�decoder� r� r
) r= r� � min_count� max_count�key_name�security_groups� user_data�addressing_type�
instance_type� placementr� r� �monitoring_enabled� subnet_idr� �disable_api_termination�$instance_initiated_shutdown_behavior�private_ip_address�placement_group� client_token�security_group_ids�additional_info�instance_profile_name�instance_profile_arn�tenancy�
ebs_optimized�network_interfacesrv rS �l�group�valrN rN rO �
run_instances� s� -�
�zEC2Connection.run_instancesc C �: i }|r | � ||d� |rd|d< | jd|dtfgdd�S )aZ
Terminate the instances specified
:type instance_ids: list
:param instance_ids: A list of strings of the Instance IDs to terminate
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of the instances terminated
r� ri rj �TerminateInstancesrl rm rn �rq rr r �r= r� rv rS rN rN rO �terminate_instances� �
�z!EC2Connection.terminate_instancesc C sF i }|rd|d< |r| � ||d� |rd|d< | jd|dtfgdd�S ) a�
Stop the instances specified
:type instance_ids: list
:param instance_ids: A list of strings of the Instance IDs to stop
:type force: bool
:param force: Forces the instance to stop
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of the instances stopped
ri �Forcer� rj �
StopInstancesrl rm rn r )r= r� �forcerv rS rN rN rO �stop_instances� s
�z EC2Connection.stop_instancesc C r )aO
Start the instances specified
:type instance_ids: list
:param instance_ids: A list of strings of the Instance IDs to start
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of the instances started
r� ri rj �StartInstancesrl rm rn r r rN rN rO �start_instances r z EC2Connection.start_instancesc C s2 i }| � ||gd� |rd|d< | jd|tdd�S )a�
Retrieves the console output for the specified instance.
:type instance_id: string
:param instance_id: The instance ID of a running instance on the cloud.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.instance.ConsoleOutput`
:return: The console output as a ConsoleOutput object
r� ri rj �GetConsoleOutputrm rn )rq r� r )r= r� rv rS rN rN rO �get_console_output s
�z EC2Connection.get_console_outputc C s. i }|r | � ||d� |rd|d< | �d|�S )a
Reboot the specified instances.
:type instance_ids: list
:param instance_ids: The instances to terminate and reboot
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
r� ri rj �RebootInstancesr� r rN rN rO �reboot_instances+ s z EC2Connection.reboot_instancesc C s4 ||d�}|r d|d< | j d|tdd�}|j|jfS )�t
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
)r� r� ri rj �ConfirmProductInstancerm rn )r� r �status�ownerId)r= � product_coder� rv rS r� rN rN rO �confirm_product_instance= s �� z&EC2Connection.confirm_product_instancec C �2 d|i}|r
||d< |rd|d< | j d|tdd�S )a�
Gets an attribute from an instance.
:type instance_id: string
:param instance_id: The Amazon id of the instance
:type attribute: string
:param attribute: The attribute you need information about
Valid choices are:
* instanceType
* kernel
* ramdisk
* userData
* disableApiTermination
* instanceInitiatedShutdownBehavior
* rootDeviceName
* blockDeviceMapping
* productCodes
* sourceDestCheck
* groupSet
* ebsOptimized
* sriovNetSupport
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.image.InstanceAttribute`
:return: An InstanceAttribute object representing the value of the
attribute requested
r� r� ri rj �DescribeInstanceAttributerm rn )r� r
�r= r� r� rv rS rN rN rO �get_instance_attributeN s �z$EC2Connection.get_instance_attributec
C s d}|� � |v r t|t�r|rd}n
d}n
|dvr td| ��d|i}|� � dkrCt|�D ]\}} t| t�r9| j} | |d|d < q-n2|� � d
krN||d < n'|� � d krY||d
< n |� � dkrn||d< |sitd��||d< ntd|f ��|r{d|d< | jd|dd�S )a3
Changes an attribute of a network interface.
:type interface_id: string
:param interface_id: The interface id. Looks like 'eni-xxxxxxxx'
:type attr: string
:param attr: The attribute you wish to change.
Learn more at http://docs.aws.amazon.com/AWSEC2/latest/API Reference/ApiReference-query-ModifyNetworkInterfaceAttribute.html
* description - Textual description of interface
* groupSet - List of security group ids or group objects
* sourceDestCheck - Boolean
* deleteOnTermination - Boolean. Must also specify attachment_id
:type value: string
:param value: The new value for the attribute
:rtype: bool
:return: Whether the operation succeeded or not
:type attachment_id: string
:param attachment_id: If you're modifying DeleteOnTermination you must
specify the attachment_id.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
)�deleteontermination�sourcedestcheckri �false)ri r3 z)%s must be a boolean, "true", or "false"!�NetworkInterfaceId�groupsetzSecurityGroupId.%srV r� zDescription.Valuer2 zSourceDestCheck.Valuer1 z Attachment.DeleteOnTerminationz&You must also specify an attachment_idzAttachment.AttachmentIdzUnknown attribute "%s"rj � ModifyNetworkInterfaceAttributerm rn )�lowerrY �bool�
ValueError� enumerater r� r� )
r= � interface_id�attrra �
attachment_idrv � bool_reqsrS �idx�sgrN rN rO �"modify_network_interface_attributev s@ !
�
�
�z0EC2Connection.modify_network_interface_attributec C s d}|� � |v rt|t�r|rd}nd}d|i}|� � dkr8t|�D ]\}}t|t�r.|j}||d|d < q"n>|� � dkrdt|�D ] \}} | �d �\}
} } d
|d }
|
|d |
< | p]d|d |
< qBn|d
�� |dd� }||d| < |r|d|d< | jd|dd�S )aR
Changes an attribute of an instance
:type instance_id: string
:param instance_id: The instance id you wish to change
:type attribute: string
:param attribute: The attribute you wish to change.
* instanceType - A valid instance type (m1.small)
* kernel - Kernel ID (None)
* ramdisk - Ramdisk ID (None)
* userData - Base64 encoded String (None)
* disableApiTermination - Boolean (true)
* instanceInitiatedShutdownBehavior - stop|terminate
* blockDeviceMapping - List of strings - ie: ['/dev/sda=false']
* sourceDestCheck - Boolean (true)
* groupSet - Set of Security Groups or IDs
* ebsOptimized - Boolean (false)
* sriovNetSupport - String - ie: 'simple'
:type value: string
:param value: The new value for the attribute
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: Whether the operation succeeded or not
)�disableapiterminationr2 � ebsoptimizedri r3 r� r5 z
GroupId.%srV �blockdevicemapping�=zBlockDeviceMapping.%dz
%s.DeviceNamez%s.Ebs.DeleteOnTerminationr Nz%s.Valuerj �ModifyInstanceAttributerm rn ) r7 rY r8 r: r r� � partition�upperr� )r= r� r� ra rv r> rS r? r@ �kv�dev_namerW �flag�prerN rN rO �modify_instance_attribute� s2 !
� � z'EC2Connection.modify_instance_attributec C r� )a�
Resets an attribute of an instance to its default value.
:type instance_id: string
:param instance_id: ID of the instance
:type attribute: string
:param attribute: The attribute to reset. Valid values are:
kernel|ramdisk
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: Whether the operation succeeded or not
)r� r� ri rj �ResetInstanceAttributerm rn r� r/ rN rN rO �reset_instance_attribute r� z&EC2Connection.reset_instance_attributec C s~ i }|r | � ||d� |r-d|v r'|�d�}|�d�r!t|�dkr't�dt� | �||� |r3d|d< | jd|d t fgd
d �S ) aQ
Retrieve all the spot instances requests associated with your account.
:type request_ids: list
:param request_ids: A list of strings of spot instance request IDs
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of
:class:`boto.ec2.spotinstancerequest.SpotInstanceRequest`
�SpotInstanceRequestIdzlaunch.group-idr� r� z�The 'launch.group-id' filter now requires a security group id (sg-*) and no longer supports filtering by group name. Please update your filters accordingly.ri rj � DescribeSpotInstanceRequestsrl rm rn )
rq r� r[ r� r� r� r� rd rr r )r= � request_idsr^ rv rS �lgidrN rN rO � get_all_spot_instance_requests s"
�
�z,EC2Connection.get_all_spot_instance_requestsc
C s� i }
|r||
d< |r||
d< |r||
d< |r||
d< |r ||
d< |r&d|
d< |dur.||
d < |r4||
d
< | r<| � |
| � | jd |
d tfgd
d�S )a�
Retrieve the recent history of spot instances pricing.
:type start_time: str
:param start_time: An indication of how far back to provide price
changes for. An ISO8601 DateTime string.
:type end_time: str
:param end_time: An indication of how far forward to provide price
changes for. An ISO8601 DateTime string.
:type instance_type: str
:param instance_type: Filter responses to a particular instance type.
:type product_description: str
:param product_description: Filter responses to a particular platform.
Valid values are currently:
* Linux/UNIX
* SUSE Linux
* Windows
* Linux/UNIX (Amazon VPC)
* SUSE Linux (Amazon VPC)
* Windows (Amazon VPC)
:type availability_zone: str
:param availability_zone: The availability zone for which prices
should be returned. If not specified, data for all
availability zones will be returned.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:type max_results: int
:param max_results: The maximum number of paginated items
per response.
:type next_token: str
:param next_token: The next set of rows to return. This should
be the value of the ``next_token`` attribute from a previous
call to ``get_spot_price_history``.
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:rtype: list
:return: A list tuples containing price and timestamp.
� StartTime�EndTimer$ �ProductDescription�AvailabilityZoneri rj Nr� r� �DescribeSpotPriceHistoryrl rm rn )rd rr r ) r= �
start_time�end_timer �product_description�availability_zonerv r� r� r^ rS rN rN rO �get_spot_price_historyB s, :
�z$EC2Connection.get_spot_price_history�one-timec C s d}d| |d|d|i} |r|| d< |r|| d< |r || d< |r$|| d< |r*|| d < | r2| | d
| < |rUg } |D ]} t | t�rF| �| j� q8| �| � q8| �| | d | � |
rxg } |
D ]} t | t�ri| �| j� q[| �| � q[| �| | d | � | r�t�| �| d
| < | r�| | d| < |
r�|
| d| < |r�|| d| < |r�|| d| < |r�|| d| < |r�d| d| < |r�|| d| < |r�|| d| < |r�|�| d| � |r�|| d| < |r�|| d| < |r�d| d| < |r�|j| |d d � |r�d| d < | j d | d t
fgd d!�S )"a�
Request instances on the spot market at a particular price.
:type price: str
:param price: The maximum price of your bid
:type image_id: string
:param image_id: The ID of the image to run
:type count: int
:param count: The of instances to requested
:type type: str
:param type: Type of request. Can be 'one-time' or 'persistent'.
Default is one-time.
:type valid_from: str
:param valid_from: Start date of the request. An ISO8601 time string.
:type valid_until: str
:param valid_until: End date of the request. An ISO8601 time string.
:type launch_group: str
:param launch_group: If supplied, all requests will be fulfilled
as a group.
:type availability_zone_group: str
:param availability_zone_group: If supplied, all requests will be
fulfilled within a single availability zone.
:type key_name: string
:param key_name: The name of the key pair with which to
launch instances
:type security_groups: list of strings
:param security_groups: The names of the security groups with which to
associate instances
:type user_data: string
:param user_data: The user data passed to the launched instances
:type instance_type: string
:param instance_type: The type of instance to run:
* t1.micro
* m1.small
* m1.medium
* m1.large
* m1.xlarge
* m3.medium
* m3.large
* m3.xlarge
* m3.2xlarge
* c1.medium
* c1.xlarge
* m2.xlarge
* m2.2xlarge
* m2.4xlarge
* cr1.8xlarge
* hi1.4xlarge
* hs1.8xlarge
* cc1.4xlarge
* cg1.4xlarge
* cc2.8xlarge
* g2.2xlarge
* c3.large
* c3.xlarge
* c3.2xlarge
* c3.4xlarge
* c3.8xlarge
* c4.large
* c4.xlarge
* c4.2xlarge
* c4.4xlarge
* c4.8xlarge
* i2.xlarge
* i2.2xlarge
* i2.4xlarge
* i2.8xlarge
* t2.micro
* t2.small
* t2.medium
:type placement: string
:param placement: The availability zone in which to launch
the instances
:type kernel_id: string
:param kernel_id: The ID of the kernel with which to launch the
instances
:type ramdisk_id: string
:param ramdisk_id: The ID of the RAM disk with which to launch the
instances
:type monitoring_enabled: bool
:param monitoring_enabled: Enable detailed CloudWatch monitoring on
the instance.
:type subnet_id: string
:param subnet_id: The subnet ID within which to launch the instances
for VPC.
:type placement_group: string
:param placement_group: If specified, this is the name of the placement
group in which the instance(s) will be launched.
:type block_device_map: :class:`boto.ec2.blockdevicemapping.BlockDeviceMapping`
:param block_device_map: A BlockDeviceMapping data structure
describing the EBS volumes associated with the Image.
:type security_group_ids: list of strings
:param security_group_ids: The ID of the VPC security groups with
which to associate instances.
:type instance_profile_arn: string
:param instance_profile_arn: The Amazon resource name (ARN) of
the IAM Instance Profile (IIP) to associate with the instances.
:type instance_profile_name: string
:param instance_profile_name: The name of
the IAM Instance Profile (IIP) to associate with the instances.
:type ebs_optimized: bool
:param ebs_optimized: 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.
:type network_interfaces: list
:param network_interfaces: A list of
:class:`boto.ec2.networkinterface.NetworkInterfaceSpecification`
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: Reservation
:return: The :class:`boto.ec2.spotinstancerequest.SpotInstanceRequest`
associated with the request for machines
�LaunchSpecificationz
%s.ImageId�Type� SpotPrice�
InstanceCount� ValidFrom�
ValidUntil� LaunchGroup�AvailabilityZoneGroupz
%s.KeyNamez%s.SecurityGroupIdz%s.SecurityGroupz %s.UserDataz%s.AddressingTypez%s.InstanceTypez %s.Placement.AvailabilityZonez %s.KernelIdz %s.RamdiskIdri z%s.Monitoring.Enabledz %s.SubnetIdz%s.Placement.GroupNamez%s.z%s.IamInstanceProfile.Namez%s.IamInstanceProfile.Arnz%s.EbsOptimized�.)�prefixrj �RequestSpotInstancesrl rm rn ) rY r r� r� rq rT r� r� r� rr r ) r= �pricer� �count�type�
valid_from� valid_until� launch_group�availability_zone_groupr� r r r r r r� r� r r r
r� r r r r r rv �lsrS r r rN rN rO �request_spot_instances� s� �
�
�z$EC2Connection.request_spot_instancesc C r )ab
Cancel the specified Spot Instance Requests.
:type request_ids: list
:param request_ids: A list of strings of the Request IDs to terminate
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of the instances terminated
rP ri rj �CancelSpotInstanceRequestsrl rm rn )rq rr r )r= rR rv rS rN rN rO � cancel_spot_instance_requestsq r z+EC2Connection.cancel_spot_instance_requestsc C s" i }|rd|d< | j d|tdd�S )aq
Return the current spot instance data feed subscription
associated with this account, if any.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.spotdatafeedsubscription.SpotDatafeedSubscription`
:return: The datafeed subscription object or None
ri rj � DescribeSpotDatafeedSubscriptionrm rn �r� r �r= rv rS rN rN rO � get_spot_datafeed_subscription� s �z,EC2Connection.get_spot_datafeed_subscriptionc C r- )a
Create a spot instance datafeed subscription for this account.
:type bucket: str or unicode
:param bucket: The name of the bucket where spot instance data
will be written. The account issuing this request
must have FULL_CONTROL access to the bucket
specified in the request.
:type prefix: str or unicode
:param prefix: An optional prefix that will be pre-pended to all
data files written to the bucket.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.spotdatafeedsubscription.SpotDatafeedSubscription`
:return: The datafeed subscription object or None
�Bucket�Prefixri rj � CreateSpotDatafeedSubscriptionrm rn rw )r= �bucketri rv rS rN rN rO �!create_spot_datafeed_subscription� s �z/EC2Connection.create_spot_datafeed_subscriptionc C s i }|rd|d< | j d|dd�S )a
Delete the current spot instance data feed subscription
associated with this account
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
ri rj � DeleteSpotDatafeedSubscriptionrm rn r� rx rN rN rO �!delete_spot_datafeed_subscription� s �z/EC2Connection.delete_spot_datafeed_subscriptionc C �J i }|r | � ||d� |r| �||� |rd|d< | jd|dtfgdd�S )a
Get all Availability Zones associated with the current region.
:type zones: list
:param zones: Optional list of zones. If this list is present,
only the Zones associated with these zone names
will be returned.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list of :class:`boto.ec2.zone.Zone`
:return: The requested Zone objects
�ZoneNameri rj �DescribeAvailabilityZonesrl rm rn )rq rd rr r )r= �zonesr^ rv rS rN rN rO �
get_all_zones� �
�zEC2Connection.get_all_zonesc C s\ i }|r | � ||d� |r| � ||d� |r | �||� |r"d|d< | jd|dtfgdd�S ) a
Get all EIP's associated with the current credentials.
:type addresses: list
:param addresses: Optional list of addresses. If this list is present,
only the Addresses associated with these addresses
will be returned.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type allocation_ids: list
:param allocation_ids: Optional list of allocation IDs. If this list is
present, only the Addresses associated with the given
allocation IDs will be returned.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list of :class:`boto.ec2.address.Address`
:return: The requested Address objects
�PublicIp� AllocationIdri rj �DescribeAddressesrl rm rn )rq rd rr r )r= � addressesr^ �allocation_idsrv rS rN rN rO �get_all_addresses� s z EC2Connection.get_all_addressesc C s2 i }|dur
||d< |rd|d< | j d|tdd�S )a�
Allocate a new Elastic IP address and associate it with your account.
:type domain: string
:param domain: Optional string. If domain is set to "vpc" the address
will be allocated to VPC . Will return address object with
allocation_id.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.address.Address`
:return: The newly allocated Address
N�Domainri rj �AllocateAddressrm rn )r� r )r= �domainrv rS rN rN rO �allocate_address s z EC2Connection.allocate_addressc C sd i }|dur
||d< |dur| � ||d� n|dur ||d< |r$d|d< |r*d|d< | jd|d d
�S ) a�
Assigns one or more secondary private IP addresses to a network
interface in Amazon VPC.
:type network_interface_id: string
:param network_interface_id: The network interface to which the IP
address will be assigned.
:type private_ip_addresses: list
:param private_ip_addresses: Assigns the specified IP addresses as
secondary IP addresses to the network interface.
:type secondary_private_ip_address_count: int
:param secondary_private_ip_address_count: The number of secondary IP
addresses to assign to the network interface. You cannot specify
this parameter when also specifying private_ip_addresses.
:type allow_reassignment: bool
:param allow_reassignment: Specifies whether to allow an IP address
that is already assigned to another network interface or instance
to be reassigned to the specified network interface.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
Nr4 r� � SecondaryPrivateIpAddressCountri �AllowReassignmentrj �AssignPrivateIpAddressesrm rn r� )r= �network_interface_id�private_ip_addresses�"secondary_private_ip_address_count�allow_reassignmentrv rS rN rN rO �assign_private_ip_addresses. s ��z)EC2Connection.assign_private_ip_addressesc
C s� i } |d ur || d< n|d ur|| d< |d ur || d< n|d ur$|| d< |d ur,|| d< |r2d| d< |r8d| d< |rB| j d | d
d �S | jd | td
d �S ) Nr� r4 r� r� r� ri �AllowReassociationrj �AssociateAddressrm rn )r� r� r )
r= r) r� � public_ip�
allocation_idr� r �allow_reassociationrv rS rN rN rO �_associate_addressb s(
�z EC2Connection._associate_addressc
C � | j d|||||||d�S )a
Associate an Elastic IP address with a currently running instance.
This requires one of ``public_ip`` or ``allocation_id`` depending
on if you're associating a VPC address or a plain EC2 address.
When using an Allocation ID, make sure to pass ``None`` for ``public_ip``
as EC2 expects a single parameter and if ``public_ip`` is passed boto
will preference that instead of ``allocation_id``.
:type instance_id: string
:param instance_id: The ID of the instance
:type public_ip: string
:param public_ip: The public IP address for EC2 based allocations.
:type allocation_id: string
:param allocation_id: The allocation ID for a VPC-based elastic IP.
:type network_interface_id: string
:param network_interface_id: The network interface ID to which
elastic IP is to be assigned to
:type private_ip_address: string
:param private_ip_address: The primary or secondary private IP address
to associate with the Elastic IP address.
:type allow_reassociation: bool
:param allow_reassociation: Specify this option to allow an Elastic IP
address that is already associated with another network interface
or instance to be re-associated with the specified instance or
interface.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
T�r� r� r� r� r r� rv �r� �r= r� r� r� r� r r� rv rN rN rO �associate_address� � *�z EC2Connection.associate_addressc
C r� )a8
Associate an Elastic IP address with a currently running instance.
This requires one of ``public_ip`` or ``allocation_id`` depending
on if you're associating a VPC address or a plain EC2 address.
When using an Allocation ID, make sure to pass ``None`` for ``public_ip``
as EC2 expects a single parameter and if ``public_ip`` is passed boto
will preference that instead of ``allocation_id``.
:type instance_id: string
:param instance_id: The ID of the instance
:type public_ip: string
:param public_ip: The public IP address for EC2 based allocations.
:type allocation_id: string
:param allocation_id: The allocation ID for a VPC-based elastic IP.
:type network_interface_id: string
:param network_interface_id: The network interface ID to which
elastic IP is to be assigned to
:type private_ip_address: string
:param private_ip_address: The primary or secondary private IP address
to associate with the Elastic IP address.
:type allow_reassociation: bool
:param allow_reassociation: Specify this option to allow an Elastic IP
address that is already associated with another network interface
or instance to be re-associated with the specified instance or
interface.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: class:`boto.ec2.address.Address`
:return: The associated address instance
Fr� r� r� rN rN rO �associate_address_object� r� z&EC2Connection.associate_address_objectc C sB i }|dur ||d< n|dur||d< |rd|d< | j d|dd�S ) a�
Disassociate an Elastic IP address from a currently running instance.
:type public_ip: string
:param public_ip: The public IP address for EC2 elastic IPs.
:type association_id: string
:param association_id: The association ID for a VPC based elastic ip.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
N�
AssociationIdr� ri rj �DisassociateAddressrm rn r� )r= r� �association_idrv rS rN rN rO �disassociate_address� s
z"EC2Connection.disassociate_addressc C �B i }|dur ||d< n|dur||d< |rd|d< | j d|dd�S ) a�
Free up an Elastic IP address. Pass a public IP address to
release an EC2 Elastic IP address and an AllocationId to
release a VPC Elastic IP address. You should only pass
one value.
This requires one of ``public_ip`` or ``allocation_id`` depending
on if you're associating a VPC address or a plain EC2 address.
When using an Allocation ID, make sure to pass ``None`` for ``public_ip``
as EC2 expects a single parameter and if ``public_ip`` is passed boto
will preference that instead of ``allocation_id``.
:type public_ip: string
:param public_ip: The public IP address for EC2 elastic IPs.
:type allocation_id: string
:param allocation_id: The Allocation ID for VPC elastic IPs.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
Nr� r� ri rj �ReleaseAddressrm rn r� )r= r� r� rv rS rN rN rO �release_address s
z EC2Connection.release_addressc C sF i }|dur
||d< |dur| � ||d� |rd|d< | jd|dd�S ) a�
Unassigns one or more secondary private IP addresses from a network
interface in Amazon VPC.
:type network_interface_id: string
:param network_interface_id: The network interface from which the
secondary private IP address will be unassigned.
:type private_ip_addresses: list
:param private_ip_addresses: Specifies the secondary private IP
addresses that you want to unassign from the network interface.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
Nr4 r� ri rj �UnassignPrivateIpAddressesrm rn r� )r= r� r� rv rS rN rN rO � unassign_private_ip_addresses' s ��z+EC2Connection.unassign_private_ip_addressesc C r� )a
Get all Volumes associated with the current credentials.
:type volume_ids: list
:param volume_ids: Optional list of volume ids. If this list
is present, only the volumes associated with
these volume ids will be returned.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list of :class:`boto.ec2.volume.Volume`
:return: The requested Volume objects
�VolumeIdri rj �DescribeVolumesrl rm rn )rq rd rr r )r= �
volume_idsr^ rv rS rN rN rO �get_all_volumesL r� z EC2Connection.get_all_volumesc C s\ i }|r | � ||d� |r||d< |r||d< |r | �||� |r%d|d< | jd|tdd�S ) a
Retrieve the status of one or more volumes.
:type volume_ids: list
:param volume_ids: A list of strings of volume IDs
:type max_results: int
:param max_results: The maximum number of paginated instance
items per response.
:type next_token: str
:param next_token: A string specifying the next paginated set
of results to return.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of volume status.
r� r� r� ri rj �DescribeVolumeStatusrm rn )rq rd r� r& )r= r� r� r� r^ rv rS rN rN rO �get_all_volume_statuso s ! �z#EC2Connection.get_all_volume_statusc C �$ d|i}|r
d|d< | j d|dd�S )a�
Enables I/O operations for a volume that had I/O operations
disabled because the data on the volume was potentially inconsistent.
:type volume_id: str
:param volume_id: The ID of the volume.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
r� ri rj �EnableVolumeIOrm rn r� �r= � volume_idrv rS rN rN rO �enable_volume_io� s z EC2Connection.enable_volume_io� autoEnableIOc C r� )a�
Describes attribute of the volume.
:type volume_id: str
:param volume_id: The ID of the volume.
:type attribute: str
:param attribute: The requested attribute. Valid values are:
* autoEnableIO
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list of :class:`boto.ec2.volume.VolumeAttribute`
:return: The requested Volume attribute
)r� r� ri rj �DescribeVolumeAttributerm rn )r� r )r= r� r� rv rS rN rN rO �get_volume_attribute� s
�z"EC2Connection.get_volume_attributec C s4 d|i}|dkr ||d< |rd|d< | j d|dd�S ) a�
Changes an attribute of an Volume.
:type volume_id: string
:param volume_id: The volume id you wish to change
:type attribute: string
:param attribute: The attribute you wish to change. Valid values are:
AutoEnableIO.
:type new_value: string
:param new_value: The new value of the attribute.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
r� � AutoEnableIOzAutoEnableIO.Valueri rj �ModifyVolumeAttributerm rn r� )r= r� r� � new_valuerv rS rN rN rO �modify_volume_attribute� s z%EC2Connection.modify_volume_attributec
C s� t |t�r|j}d|i} |r|| d< |r t |t�r |j}|| d< |r&|| d< |r.t|�| d< |r:d| d< |r:|| d< |r@d| d < | jd
| td d �S )
a�
Create a new EBS Volume.
:type size: int
:param size: The size of the new volume, in GiB
:type zone: string or :class:`boto.ec2.zone.Zone`
:param zone: The availability zone in which the Volume will be created.
:type snapshot: string or :class:`boto.ec2.snapshot.Snapshot`
:param snapshot: The snapshot from which the new Volume will be
created.
:type volume_type: string
:param volume_type: The type of the volume. (optional). Valid
values are: standard | io1 | gp2.
:type iops: int
:param iops: The provisioned IOPS you want to associate with
this volume. (optional)
:type encrypted: bool
:param encrypted: Specifies whether the volume should be encrypted.
(optional)
:type kms_key_id: string
:params kms_key_id: If encrypted is True, this KMS Key ID may be specified to
encrypt volume with this key (optional)
e.g.: arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
rX �Size�
SnapshotId�
VolumeType�Iopsri � Encrypted�KmsKeyIdrj � CreateVolumerm rn )rY r rT r r� �strr� r )
r= �size�zone�snapshot� volume_type�iops� encrypted�
kms_key_idrv rS rN rN rO �
create_volume� s(
$
zEC2Connection.create_volumec C r� )a'
Delete an EBS volume.
:type volume_id: str
:param volume_id: The ID of the volume to be delete.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
r� ri rj � DeleteVolumerm rn r� r� rN rN rO �
delete_volume s
zEC2Connection.delete_volumec C s( |||d�}|r d|d< | j d|dd�S )ao
Attach an EBS volume to an EC2 instance.
:type volume_id: str
:param volume_id: The ID of the EBS volume to be attached.
:type instance_id: str
:param instance_id: The ID of the EC2 instance to which it will
be attached.
:type device: str
:param device: The device on the instance through which the
volume will be exposted (e.g. /dev/sdh)
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
)r� r� �Deviceri rj � AttachVolumerm rn r� )r= r� r� �devicerv rS rN rN rO �
attach_volume/ s �zEC2Connection.attach_volumec C sH d|i}|r
||d< |r||d< |rd|d< |r d|d< | j d|dd �S )
ag
Detach an EBS volume from an EC2 instance.
:type volume_id: str
:param volume_id: The ID of the EBS volume to be attached.
:type instance_id: str
:param instance_id: The ID of the EC2 instance from which it will
be detached.
:type device: str
:param device: The device on the instance through which the
volume is exposted (e.g. /dev/sdh)
:type force: bool
:param force: Forces detachment if the previous detachment
attempt did not occur cleanly. This option can lead to
data loss or a corrupted file system. Use this option only
as a last resort to detach a volume from a failed
instance. The instance will not have an opportunity to
flush file system caches nor file system meta data. If you
use this option, you must perform file system check and
repair procedures.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
r� r� r� ri r rj � DetachVolumerm rn r� )r= r� r� r� r rv rS rN rN rO �
detach_volumeK s zEC2Connection.detach_volumec C re )
a
Get all EBS Snapshots associated with the current credentials.
:type snapshot_ids: list
:param snapshot_ids: Optional list of snapshot ids. If this list is
present, only the Snapshots associated with
these snapshot ids will be returned.
:type owner: str or list
:param owner: If present, only the snapshots owned by the specified user(s)
will be returned. Valid values are:
* self
* amazon
* AWS Account ID
:type restorable_by: str or list
:param restorable_by: If present, only the snapshots that are restorable
by the specified account id(s) will be returned.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list of :class:`boto.ec2.snapshot.Snapshot`
:return: The requested Snapshot objects
r� rg � RestorableByri rj �DescribeSnapshotsrl rm rn )rq rd rr r )r= � snapshot_ids�owner�
restorable_byr^ rv rS rN rN rO �get_all_snapshotsx s '
�z EC2Connection.get_all_snapshotsc C sn d|i}|r|dd� |d< |rd|d< | j d|tdd �}| j|g|d
�d }|j�d �}|r5|�d |� |S ) a�
Create a snapshot of an existing EBS Volume.
:type volume_id: str
:param volume_id: The ID of the volume to be snapshot'ed
:type description: str
:param description: A description of the snapshot.
Limited to 255 characters.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.snapshot.Snapshot`
:return: The created Snapshot object
r� r � r� ri rj �CreateSnapshotrm rn �rv r� )r� r r� �tagsr� �add_tag)r= r� r� rv rS r� �volume� volume_namerN rN rO �create_snapshot� s � z EC2Connection.create_snapshotc C r� )r' r� ri rj �DeleteSnapshotrm rn r� )r= r� rv rS rN rN rO r� � s z EC2Connection.delete_snapshotc C s> ||d�}|dur
||d< |rd|d< | j d|tdd�}|jS ) a�
Copies a point-in-time snapshot of an Amazon Elastic Block Store
(Amazon EBS) volume and stores it in Amazon Simple Storage Service
(Amazon S3). You can copy the snapshot within the same region or from
one region to another. You can use the snapshot to create new Amazon
EBS volumes or Amazon Machine Images (AMIs).
:type source_region: str
:param source_region: The ID of the AWS region that contains the
snapshot to be copied (e.g 'us-east-1', 'us-west-2', etc.).
:type source_snapshot_id: str
:param source_snapshot_id: The ID of the Amazon EBS snapshot to copy
:type description: str
:param description: A description of the new Amazon EBS snapshot.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: str
:return: The snapshot ID
)� SourceRegion�SourceSnapshotIdNr� ri rj � CopySnapshotrm rn )r� r r� )r= �
source_region�source_snapshot_idr� rv rS r� rN rN rO �
copy_snapshot� s �
�zEC2Connection.copy_snapshot� � � c
C s� t �� }t |j|j|j|j�}t |j|j|j�}t |j|j|j�t|�� d d d� }t |j|jd�} g }
t ddd�} td|�D ] } |
� |t| d� � qAtd|�D ] }
|
� |t|
d� � qStd|�D ] }|
� |t|d� � qetdd�}d}| | kr�|du s�||k r�|
� | � |d7 }| |8 } t | j| jd�} | | kr�|du s�||k s�g }|
D ]}|�
|�d kr�|� |� q�t |�}
| j d
d �}|j
d d
� d� i }|D ] }|j�d�}|r�|�|�}|s�g }|||< |� |� q�|D ]�}|| }|dd� }d}d }|D ]n}d}|�rm||
�� k �rmt �|jd�} | |
| k �r]|dk�rX|j�d��sWz| �|j� tj�d|jd |jf � W n t�yV tj�d|jd |jf � Y nw nd}d }n|d7 }d }|�rm||
�� k �s�q q�dS )a�
Trim excess snapshots, based on when they were taken. More current
snapshots are retained, with the number retained decreasing as you
move back in time.
If ebs volumes have a 'Name' tag with a value, their snapshots
will be assigned the same tag when they are created. The values
of the 'Name' tags for snapshots are used by this function to
group snapshots taken from the same volume (or from a series
of like-named volumes over time) for trimming.
For every group of like-named snapshots, this function retains
the newest and oldest snapshots, as well as, by default, the
first snapshots taken in each of the last eight hours, the first
snapshots taken in each of the last seven days, the first snapshots
taken in the last 4 weeks (counting Midnight Sunday morning as
the start of the week), and the first snapshot from the first
day of each month forever.
:type hourly_backups: int
:param hourly_backups: How many recent hourly backups should be saved.
:type daily_backups: int
:param daily_backups: How many recent daily backups should be saved.
:type weekly_backups: int
:param weekly_backups: How many recent weekly backups should be saved.
:type monthly_backups: int
:param monthly_backups: How many monthly backups should be saved. Use True for no limit.
rV r� )�daysi� r )�hours)�weeksTFr= )r� c S s | j S )N)rZ )�xrN rN rO �<lambda>]
s z.EC2Connection.trim_snapshots.<locals>.<lambda>)r� r� N���z%Y-%m-%dT%H:%M:%S.000Z�preserve_snapshotzTrimmed snapshot %s (%s)zmAttempt to trim snapshot %s (%s) failed. Possible result of a race condition with trimming on another server?)r �utcnow�year�month�day�hourr �weekday�ranger� � __contains__�sortedr� �sortr� r� �__len__�strptimerZ r� r� �boto�log�infor, �error) r= �hourly_backups�
daily_backups�weekly_backups�monthly_backups�now� last_hour�
last_midnight� last_sunday�start_of_month�target_backup_times�oldest_snapshot_dater� r� �week�one_day�monthly_snapshots_added�temp�t�
all_snapshots�snaps_for_each_volume�snapr� �snaps_for_volume�snaps�time_period_number� snap_found_for_this_time_period�check_this_snap� snap_daterN rN rO �trim_snapshots� s� -(
��
�
� �
������z EC2Connection.trim_snapshots�createVolumePermissionc C s2 d|i}|r
||d< |rd|d< | j d|tdd�S )aR
Get information about an attribute of a snapshot. Only one attribute
can be specified per call.
:type snapshot_id: str
:param snapshot_id: The ID of the snapshot.
:type attribute: str
:param attribute: The requested attribute. Valid values are:
* createVolumePermission
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list of :class:`boto.ec2.snapshotattribute.SnapshotAttribute`
:return: The requested Snapshot attribute
r� r� ri rj �DescribeSnapshotAttributerm rn )r� r �r= r� r� rv rS rN rN rO �get_snapshot_attribute�
s �z$EC2Connection.get_snapshot_attributec C sL |||d�}|r| � ||d� |r| � ||d� |r d|d< | jd|dd�S ) a
Changes an attribute of an image.
:type snapshot_id: string
:param snapshot_id: The snapshot id you wish to change
:type attribute: string
:param attribute: The attribute you wish to change. Valid values are:
createVolumePermission
:type operation: string
:param operation: Either add or remove (this is required for changing
snapshot ermissions)
:type user_ids: list
:param user_ids: The Amazon IDs of users to add/remove attributes
:type groups: list
:param groups: The groups to add/remove attributes. The only valid
value at this time is 'all'.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
)r� r� r� r� r� ri rj �ModifySnapshotAttributerm rn r� )r= r� r� r� r� r� rv rS rN rN rO �modify_snapshot_attribute�
s �z'EC2Connection.modify_snapshot_attributec C r� )a�
Resets an attribute of a snapshot to its default value.
:type snapshot_id: string
:param snapshot_id: ID of the snapshot
:type attribute: string
:param attribute: The attribute to reset
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: Whether the operation succeeded or not
)r� r� ri rj �ResetSnapshotAttributerm rn r� r$ rN rN rO �reset_snapshot_attribute�
s �z&EC2Connection.reset_snapshot_attributec C r� )aF
Get all key pairs associated with your account.
:type keynames: list
:param keynames: A list of the names of keypairs to retrieve.
If not provided, all key pairs will be returned.
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.keypair.KeyPair`
r� ri rj �DescribeKeyPairsrl rm rn )rq rd rr r )r= �keynamesr^ rv rS rN rN rO �get_all_key_pairs�
s
�z EC2Connection.get_all_key_pairsc
C sL z | j |g|d�d W S | jy% } z
|jdkr W Y d}~dS � d}~ww )a�
Convenience method to retrieve a specific keypair (KeyPair).
:type keyname: string
:param keyname: The name of the keypair to retrieve
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.keypair.KeyPair`
:return: The KeyPair specified or None if it is not found
)r+ rv r zInvalidKeyPair.NotFoundN)r, �
ResponseError�code)r= �keynamerv �erN rN rO � get_key_pair s
��
��zEC2Connection.get_key_pairc C �& d|i}|r
d|d< | j d|tdd�S )ac
Create a new key pair for your account.
This will create the key pair within the region you
are currently connected to.
:type key_name: string
:param key_name: The name of the new keypair
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.keypair.KeyPair`
:return: The newly created :class:`boto.ec2.keypair.KeyPair`.
The material attribute of the new KeyPair object
will contain the the unencrypted PEM encoded RSA private key.
r� ri rj �
CreateKeyPairrm rn )r� r �r= r� rv rS rN rN rO �create_key_pair. s z EC2Connection.create_key_pairc C r� )z�
Delete a key pair from your account.
:type key_name: string
:param key_name: The name of the keypair to delete
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
r� ri rj �
DeleteKeyPairrm rn r� r4 rN rN rO �delete_key_pairD � z EC2Connection.delete_key_pairc C s2 t �|�}||d�}|rd|d< | jd|tdd�S )a�
imports the public key from an RSA key pair that you created
with a third-party tool.
Supported formats:
* OpenSSH public key format (e.g., the format
in ~/.ssh/authorized_keys)
* Base64 encoded DER format
* SSH public key file format as specified in RFC4716
DSA keys are not supported. Make sure your key generator is
set up to create RSA keys.
Supported lengths: 1024, 2048, and 4096.
:type key_name: string
:param key_name: The name of the new keypair
:type public_key_material: string
:param public_key_material: The public key. You must base64 encode
the public key material before sending
it to AWS.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.keypair.KeyPair`
:return: A :class:`boto.ec2.keypair.KeyPair` object representing
the newly imported key pair. This object will contain only
the key name and the fingerprint.
)r� �PublicKeyMaterialri rj �
ImportKeyPairrm rn )r� r� r� r )r= r� �public_key_materialrv rS rN rN rO �import_key_pairT s
#�z EC2Connection.import_key_pairc C sh i }|dur
| � ||d� |dur| � ||d� |dur"| �||� |r(d|d< | jd|dtfgdd �S )
a�
Get all security groups associated with your account in a region.
:type groupnames: list
:param groupnames: A list of the names of security groups to retrieve.
If not provided, all security groups will be
returned.
:type group_ids: list
:param group_ids: A list of IDs of security groups to retrieve for
security groups within a VPC.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.securitygroup.SecurityGroup`
N� GroupName�GroupIdri rj �DescribeSecurityGroupsrl rm rn )rq rd rr r )r= �
groupnames� group_idsr^ rv rS rN rN rO �get_all_security_groups� s
�z%EC2Connection.get_all_security_groupsc C sV ||d�}|dur
||d< |rd|d< | j d|tdd�}||_||_|dur)||_|S ) a�
Create a new security group for your account.
This will create the security group within the region you
are currently connected to.
:type name: string
:param name: The name of the new security group
:type description: string
:param description: The description of the new security group
:type vpc_id: string
:param vpc_id: The ID of the VPC to create the security group in,
if any.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.securitygroup.SecurityGroup`
:return: The newly created :class:`boto.ec2.securitygroup.SecurityGroup`.
)r= �GroupDescriptionN�VpcIdri rj �CreateSecurityGrouprm rn )r� r rT r� �vpc_id)r= rT r� rF rv rS r rN rN rO �create_security_group� s ��z#EC2Connection.create_security_groupc C r� ) a�
Delete a security group from your account.
:type name: string
:param name: The name of the security group to delete.
:type group_id: string
:param group_id: The ID of the security group to delete within
a VPC.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful.
Nr= r> ri rj �DeleteSecurityGrouprm rn r� )r= rT �group_idrv rS rN rN rO �delete_security_group� s
z#EC2Connection.delete_security_groupc
C �h d|i} |r
|| d< |r|| d< |r|| d< |r || d< |r"|| d< |r(|| d< |r.d| d < | � d
| �S ) a�
NOTE: This method uses the old-style request parameters
that did not allow a port to be specified when
authorizing a group.
:type group_name: string
:param group_name: The name of the security group you are adding
the rule to.
:type src_security_group_name: string
:param src_security_group_name: The name of the security group you are
granting access to.
:type src_security_group_owner_id: string
:param src_security_group_owner_id: The ID of the owner of the security
group you are granting access to.
:type ip_protocol: string
:param ip_protocol: Either tcp | udp | icmp
:type from_port: int
:param from_port: The beginning port number you are enabling
:type to_port: int
:param to_port: The ending port number you are enabling
:type to_port: string
:param to_port: The CIDR block you are providing access to.
See http://goo.gl/Yj5QC
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful.
r= �SourceSecurityGroupName�SourceSecurityGroupOwnerId�
IpProtocol�FromPort�ToPort�CidrIpri rj � AuthorizeSecurityGroupIngressr� �
r= �
group_name�src_security_group_name�src_security_group_owner_id� ip_protocol� from_port�to_port�cidr_iprv rS rN rN rO �#authorize_security_group_deprecated� s * z1EC2Connection.authorize_security_group_deprecatedc C s� |r|du r|du r|du r| � |||�S i } |r || d< |r#|| d< |r+d} || | < |r3d} || | < | r;d} | | | < |rA|| d< |durI|| d< |durQ|| d < |rlt|t�s[|g}t|�D ] \}
}|| d
|
d < q_|
rrd | d
< | jd| dd�S )a:
Add a new rule to an existing security group.
You need to pass in either src_security_group_name and
src_security_group_owner_id OR ip_protocol, from_port, to_port,
and cidr_ip. In other words, either you are authorizing another
group or you are authorizing some ip-based rule.
:type group_name: string
:param group_name: The name of the security group you are adding
the rule to.
:type src_security_group_name: string
:param src_security_group_name: The name of the security group you are
granting access to.
:type src_security_group_owner_id: string
:param src_security_group_owner_id: The ID of the owner of the security
group you are granting access to.
:type ip_protocol: string
:param ip_protocol: Either tcp | udp | icmp
:type from_port: int
:param from_port: The beginning port number you are enabling
:type to_port: int
:param to_port: The ending port number you are enabling
:type cidr_ip: string or list of strings
:param cidr_ip: The CIDR block you are providing access to.
See http://goo.gl/Yj5QC
:type group_id: string
:param group_id: ID of the EC2 or VPC security group to
modify. This is required for VPC security groups and can
be used instead of group_name for EC2 security groups.
:type src_security_group_group_id: string
:param src_security_group_group_id: The ID of the security
group you are granting access to. Can be used instead of
src_security_group_name
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful.
Nr= r> �"IpPermissions.1.Groups.1.GroupName� IpPermissions.1.Groups.1.UserId� IpPermissions.1.Groups.1.GroupId�IpPermissions.1.IpProtocol�IpPermissions.1.FromPort�IpPermissions.1.ToPortz"IpPermissions.1.IpRanges.%d.CidrIprV ri rj rR rm rn )r[ rY r] r: r� )r= rT rU rV rW rX rY rZ rI �src_security_group_group_idrv rS �
param_namer_ �single_cidr_iprN rN rO �authorize_security_group* sJ 8�
��z&EC2Connection.authorize_security_groupc C sf ||d�}|dur
||d< |dur||d< |dur ||d< |dur%||d< |r+d|d< | j d |d
d �S ) a�
The action adds one or more egress rules to a VPC security
group. Specifically, this action permits instances in a
security group to send traffic to one or more destination
CIDR IP address ranges, or to one or more destination
security groups in the same VPC.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
)r> r_ Nr` ra r^ �!IpPermissions.1.IpRanges.1.CidrIpri rj � AuthorizeSecurityGroupEgressrm rn r� � r= rI rW rX rY � src_group_idrZ rv rS rN rN rO � authorize_security_group_egress� s ��z-EC2Connection.authorize_security_group_egressc
C rK ) a\
NOTE: This method uses the old-style request parameters
that did not allow a port to be specified when
authorizing a group.
Remove an existing rule from an existing security group.
You need to pass in either src_security_group_name and
src_security_group_owner_id OR ip_protocol, from_port, to_port,
and cidr_ip. In other words, either you are revoking another
group or you are revoking some ip-based rule.
:type group_name: string
:param group_name: The name of the security group you are removing
the rule from.
:type src_security_group_name: string
:param src_security_group_name: The name of the security group you are
revoking access to.
:type src_security_group_owner_id: string
:param src_security_group_owner_id: The ID of the owner of the security
group you are revoking access to.
:type ip_protocol: string
:param ip_protocol: Either tcp | udp | icmp
:type from_port: int
:param from_port: The beginning port number you are disabling
:type to_port: int
:param to_port: The ending port number you are disabling
:type to_port: string
:param to_port: The CIDR block you are revoking access to.
http://goo.gl/Yj5QC
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful.
r= rL rM rN rO rP rQ ri rj �RevokeSecurityGroupIngressr� rS rN rN rO � revoke_security_group_deprecated� s 0 z.EC2Connection.revoke_security_group_deprecatedc
C s� |r|du r|du r|du r| � |||�S i } |dur || d< |dur'|| d< |r/d} || | < | r7d} | | | < |r?d} || | < |rE|| d< |durM|| d< |durU|| d < |r[|| d
< |
rad | d < | jd
| dd�S )a8
Remove an existing rule from an existing security group.
You need to pass in either src_security_group_name and
src_security_group_owner_id OR ip_protocol, from_port, to_port,
and cidr_ip. In other words, either you are revoking another
group or you are revoking some ip-based rule.
:type group_name: string
:param group_name: The name of the security group you are removing
the rule from.
:type src_security_group_name: string
:param src_security_group_name: The name of the security group you are
revoking access to.
:type src_security_group_owner_id: string
:param src_security_group_owner_id: The ID of the owner of the security
group you are revoking access to.
:type ip_protocol: string
:param ip_protocol: Either tcp | udp | icmp
:type from_port: int
:param from_port: The beginning port number you are disabling
:type to_port: int
:param to_port: The ending port number you are disabling
:type cidr_ip: string
:param cidr_ip: The CIDR block you are revoking access to.
See http://goo.gl/Yj5QC
:type group_id: string
:param group_id: ID of the EC2 or VPC security group to
modify. This is required for VPC security groups and can
be used instead of group_name for EC2 security groups.
:type src_security_group_group_id: string
:param src_security_group_group_id: The ID of the security group
for which you are revoking access. Can be used instead
of src_security_group_name
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful.
Nr= r> r\ r^ r] r_ r` ra rf ri rj rk rm rn )rl r� )
r= rT rU rV rW rX rY rZ rI rb rv rS rc rN rN rO �revoke_security_group� sB 6��z#EC2Connection.revoke_security_groupc C st i }|r||d< |r||d< |dur||d< |dur ||d< |dur&||d< |r,||d< |r2d|d < | j d
|d d �S )
a|
Remove an existing egress rule from an existing VPC security
group. You need to pass in an ip_protocol, from_port and
to_port range only if the protocol you are using is
port-based. You also need to pass in either a src_group_id or
cidr_ip.
:type group_name: string
:param group_id: The name of the security group you are removing
the rule from.
:type ip_protocol: string
:param ip_protocol: Either tcp | udp | icmp | -1
:type from_port: int
:param from_port: The beginning port number you are disabling
:type to_port: int
:param to_port: The ending port number you are disabling
:type src_group_id: src_group_id
:param src_group_id: The source security group you are
revoking access to.
:type cidr_ip: string
:param cidr_ip: The CIDR block you are revoking access to.
See http://goo.gl/Yj5QC
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful.
r> r_ Nr` ra r^ rf ri rj �RevokeSecurityGroupEgressrm rn r� rh rN rN rO � revoke_security_group_egressF
s$ *�z*EC2Connection.revoke_security_group_egressc C s^ i }|r | � ||d� |r| �||� |rd|d< | jd|dtfgdd�}|D ]}t|_q'|S )a~
Get all available regions for the EC2 service.
:type region_names: list of str
:param region_names: Names of regions to limit output
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.regioninfo.RegionInfo`
�
RegionNameri rj �DescribeRegionsrl rm rn )rq rd rr r r. �connection_cls)r= � region_namesr^ rv rS �regionsr8 rN rN rO �get_all_regions�
s
�z EC2Connection.get_all_regionsc C s i }|dur
| � ||d� |r||d< |r||d< |r ||d< |r'| �||� |dur/||d< |dur7||d< |durF|rBd|d < nd
|d < | durPt| �|d < |
durZt|
�|d < | durdt| �|d
< | durl| |d< |
durvt|
�|d< |r|d|d< | jd|dtfgdd�S )a�
Describes Reserved Instance offerings that are available for purchase.
:type reserved_instances_offering_ids: list
:param reserved_instances_id: One or more Reserved Instances
offering IDs.
:type instance_type: str
:param instance_type: Displays Reserved Instances of the specified
instance type.
:type availability_zone: str
:param availability_zone: Displays Reserved Instances within the
specified Availability Zone.
:type product_description: str
:param product_description: Displays Reserved Instances with the
specified product description.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type instance_tenancy: string
:param instance_tenancy: The tenancy of the Reserved Instance offering.
A Reserved Instance with tenancy of dedicated will run on
single-tenant hardware and can only be launched within a VPC.
:type offering_type: string
:param offering_type: The Reserved Instance offering type. Valid
Values: `"Heavy Utilization" | "Medium Utilization" | "Light
Utilization"`
:type include_marketplace: bool
:param include_marketplace: Include Marketplace offerings in the
response.
:type min_duration: int :param min_duration: Minimum duration (in
seconds) to filter when searching for offerings.
:type max_duration: int
:param max_duration: Maximum duration (in seconds) to filter when
searching for offerings.
:type max_instance_count: int
:param max_instance_count: Maximum number of instances to filter when
searching for offerings.
:type next_token: string
:param next_token: Token to use when requesting the next paginated set
of offerings.
:type max_results: int
:param max_results: Maximum number of offerings to return per call.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of
:class:`boto.ec2.reservedinstance.ReservedInstancesOffering`.
N�ReservedInstancesOfferingIdr$ rX rW �InstanceTenancy� OfferingTyperi �IncludeMarketplacer3 � MinDuration� MaxDuration�MaxInstanceCountr� r� rj �"DescribeReservedInstancesOfferingsrl rm rn )rq rd r� rr r )r= � reserved_instances_offering_idsr r] r\ r^ �instance_tenancy�
offering_type�include_marketplace� min_duration� max_duration�max_instance_countr� r� rv rS rN rN rO �$get_all_reserved_instances_offerings�
sJ T�
�z2EC2Connection.get_all_reserved_instances_offeringsc C r� )a�
Describes one or more of the Reserved Instances that you purchased.
:type reserved_instance_ids: list
:param reserved_instance_ids: A list of the reserved instance ids that
will be returned. If not provided, all reserved instances
will be returned.
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.reservedinstance.ReservedInstance`
�ReservedInstancesIdri rj �DescribeReservedInstancesrl rm rn )rq rd rr r )r= �reserved_instances_idr^ rv rS rN rN rO �get_all_reserved_instances( s � �z(EC2Connection.get_all_reserved_instancesc C sP ||d�}|durt |d �|d< t |d �|d< |r d|d< | jd |td
d �S ) a�
Purchase a Reserved Instance for use with your account.
** CAUTION **
This request can result in large amounts of money being charged to your
AWS account. Use with caution!
:type reserved_instances_offering_id: string
:param reserved_instances_offering_id: The offering ID of the Reserved
Instance to purchase
:type instance_count: int
:param instance_count: The number of Reserved Instances to purchase.
Default value is 1.
:type limit_price: tuple
:param instance_count: Limit the price on the total order.
Must be a tuple of (amount, currency_code), for example:
(100.0, 'USD').
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.reservedinstance.ReservedInstance`
:return: The newly created Reserved Instance
)rv rc Nr zLimitPrice.AmountrV zLimitPrice.CurrencyCoderi rj �!PurchaseReservedInstancesOfferingrm rn )r� r� r )r= � reserved_instances_offering_id�instance_count� limit_pricerv rS rN rN rO �#purchase_reserved_instance_offeringK s ��z1EC2Connection.purchase_reserved_instance_offeringc C sn |t |�|d�}t|�D ]\}}|\} }
t | �|d| < t |
�|d| < q |r+d|d< | jd|dtfgdd �S )
a� Creates a new listing for Reserved Instances.
Creates a new listing for Amazon EC2 Reserved Instances that will be
sold in the Reserved Instance Marketplace. You can submit one Reserved
Instance listing at a time.
The Reserved Instance Marketplace matches sellers who want to resell
Reserved Instance capacity that they no longer need with buyers who
want to purchase additional capacity. Reserved Instances bought and
sold through the Reserved Instance Marketplace work like any other
Reserved Instances.
If you want to sell your Reserved Instances, you must first register as
a Seller in the Reserved Instance Marketplace. After completing the
registration process, you can create a Reserved Instance Marketplace
listing of some or all of your Reserved Instances, and specify the
upfront price you want to receive for them. Your Reserved Instance
listings then become available for purchase.
:type reserved_instances_id: string
:param reserved_instances_id: The ID of the Reserved Instance that
will be listed.
:type instance_count: int
:param instance_count: The number of instances that are a part of a
Reserved Instance account that will 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.
:type price_schedules: List of tuples
:param price_schedules: A list specifying the price of the Reserved
Instance for each month remaining in the Reserved Instance term.
Each tuple contains two elements, the price and the term. For
example, for an instance that 11 months remaining in its term,
we can have a price schedule with an upfront price of $2.50.
At 8 months remaining we can drop the price down to $2.00.
This would be expressed as::
price_schedules=[('2.50', 11), ('2.00', 8)]
:type client_token: string
:param client_token: Unique, case-sensitive identifier you provide
to ensure idempotency of the request. Maximum 64 ASCII characters.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of
:class:`boto.ec2.reservedinstance.ReservedInstanceListing`
)r� rc r� zPriceSchedules.%s.PricezPriceSchedules.%s.Termri rj � CreateReservedInstancesListingrl rm rn )r� r: rr r ) r= r� r� �price_schedulesr rv rS r_ �schedulerk �termrN rN rO �!create_reserved_instances_listings s 9� �z/EC2Connection.create_reserved_instances_listingc C �> i }|dur
| � ||d� |rd|d< | jd|dtfgdd�S ) a� Cancels the specified Reserved Instance listing.
:type reserved_instances_listing_ids: List of strings
:param reserved_instances_listing_ids: The ID of the
Reserved Instance listing to be cancelled.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of
:class:`boto.ec2.reservedinstance.ReservedInstanceListing`
N�ReservedInstancesListingIdri rj � CancelReservedInstancesListingrl rm rn )rq rr r )r= � reserved_instances_listing_idsrv rS rN rN rO �!cancel_reserved_instances_listing� s � �z/EC2Connection.cancel_reserved_instances_listingc C s~ t |�D ]8\}}d| }|jd ur|j||d < |jd ur$|j||d < |jd ur0|j||d < |jd ur<|j||d < qd S )Nz-ReservedInstancesConfigurationSetItemType.%d.rX �Platformrc r$ )r: r] �platformr� r )r= rS �target_configurations�offset�tcri rN rN rO � build_configurations_param_list� s
��z-EC2Connection.build_configurations_param_listc C sV i }|dur
||d< |dur| � ||d� |dur | �||� | jd|tdd�}|jS )a
Modifies the specified Reserved Instances.
:type client_token: string
:param client_token: A unique, case-sensitive, token you provide to
ensure idempotency of your modification request.
:type reserved_instance_ids: List of strings
:param reserved_instance_ids: The IDs of the Reserved Instances to
modify.
:type target_configurations: List of :class:`boto.ec2.reservedinstance.ReservedInstancesConfiguration`
:param target_configurations: The configuration settings for the
modified Reserved Instances.
:rtype: string
:return: The unique ID for the submitted modification request.
Nr� r� �ModifyReservedInstancesrm rn )rq r� r� r �modification_id)r= r �reserved_instance_idsr� rS �mrirrN rN rO �modify_reserved_instances� s � �z'EC2Connection.modify_reserved_instancesc C sJ i }|r | � ||d� |r||d< |r| �||� | jd|dtfgdd�S )a�
A request to describe the modifications made to Reserved Instances in
your account.
:type reserved_instances_modification_ids: list
:param reserved_instances_modification_ids: An optional list of
Reserved Instances modification IDs to describe.
:type next_token: str
:param next_token: A string specifying the next paginated set
of results to return.
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:rtype: list
:return: A list of :class:`boto.ec2.reservedinstance.ReservedInstance`
� ReservedInstancesModificationIdr� �&DescribeReservedInstancesModificationsrl rm rn )rq rd rr r )r= �#reserved_instances_modification_idsr� r^ rS rN rN rO �)describe_reserved_instances_modifications s �
�z7EC2Connection.describe_reserved_instances_modificationsc C �6 i }| � ||d� |rd|d< | jd|dtfgdd�S )at
Enable detailed CloudWatch monitoring for the supplied instances.
:type instance_id: list of strings
:param instance_id: The instance ids
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.instanceinfo.InstanceInfo`
r� ri rj �MonitorInstancesrl rm rn �rq rr r r rN rN rO �monitor_instances- �
�z EC2Connection.monitor_instancesc C � | j |g|d�S )a�
Deprecated Version, maintained for backward compatibility.
Enable detailed CloudWatch monitoring for the supplied instance.
:type instance_id: string
:param instance_id: The instance id
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.instanceinfo.InstanceInfo`
r� )r� �r= r� rv rN rN rO �monitor_instanceA � z EC2Connection.monitor_instancec C r� )ai
Disable CloudWatch monitoring for the supplied instance.
:type instance_id: list of string
:param instance_id: The instance id
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.instanceinfo.InstanceInfo`
r� ri rj �UnmonitorInstancesrl rm rn r� r rN rN rO �unmonitor_instancesQ r� z!EC2Connection.unmonitor_instancesc C r� )a�
Deprecated Version, maintained for backward compatibility.
Disable detailed CloudWatch monitoring for the supplied instance.
:type instance_id: string
:param instance_id: The instance id
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.instanceinfo.InstanceInfo`
r� )r� r� rN rN rO �unmonitor_instancee r� z EC2Connection.unmonitor_instancec C s` ||||d�}t j�dt j| jdg�}| j|d< |�|�}||d< |r'd|d< | jd|td d
�S ) a�
Bundle Windows instance.
:type instance_id: string
:param instance_id: The instance id
:type s3_bucket: string
:param s3_bucket: The bucket in which the AMI should be stored.
:type s3_prefix: string
:param s3_prefix: The beginning of the file name for the AMI.
:type s3_upload_policy: string
:param s3_upload_policy: Base64 encoded policy that specifies condition
and permissions for Amazon EC2 to upload the
user's image into Amazon S3.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
)r� zStorage.S3.BucketzStorage.S3.PrefixzStorage.S3.UploadPolicyN�s3zStorage.S3.AWSAccessKeyIdz Storage.S3.UploadPolicySignatureri rj �BundleInstancerm rn ) r �auth�get_auth_handler�config�providerr> � sign_stringr� r! ) r= r� � s3_bucket� s3_prefix�s3_upload_policyrv rS �s3auth� signaturerN rN rO �bundle_instancey s � �
�z EC2Connection.bundle_instancec C r� )a�
Retrieve current bundling tasks. If no bundle id is specified, all
tasks are retrieved.
:type bundle_ids: list
:param bundle_ids: A list of strings containing identifiers for
previously created bundling tasks.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
�BundleIdri rj �DescribeBundleTasksrl rm rn )rq rd rr r! )r= �
bundle_idsr^ rv rS rN rN rO �get_all_bundle_tasks� �
�z"EC2Connection.get_all_bundle_tasksc C r2 )a
Cancel a previously submitted bundle task
:type bundle_id: string
:param bundle_id: The identifier of the bundle task to cancel.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
r� ri rj �CancelBundleTaskrm rn )r� r! )r= � bundle_idrv rS rN rN rO �cancel_bundle_task� s �z EC2Connection.cancel_bundle_taskc C s, d|i}|r
d|d< | j d|tdd�}|jS )aR
Get encrypted administrator password for a Windows instance.
:type instance_id: string
:param instance_id: The identifier of the instance to retrieve the
password for.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
r� ri rj �GetPasswordDatarm rn )r� r � passwordData)r= r� rv rS r� rN rN rO �get_password_data� s
z EC2Connection.get_password_datac C r� )a
Get all placement groups associated with your account in a region.
:type groupnames: list
:param groupnames: A list of the names of placement groups to retrieve.
If not provided, all placement groups will be
returned.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.placementgroup.PlacementGroup`
r= ri rj �DescribePlacementGroupsrl rm rn )rq rd rr r" )r= r@ r^ rv rS rN rN rO �get_all_placement_groups� s
�z&EC2Connection.get_all_placement_groups�clusterc C s* ||d�}|r d|d< | j d|dd�}|S )aY
Create a new placement group for your account.
This will create the placement group within the region you
are currently connected to.
:type name: string
:param name: The name of the new placement group
:type strategy: string
:param strategy: The placement strategy of the new placement group.
Currently, the only acceptable value is "cluster".
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: bool
:return: True if successful
)r= �Strategyri rj �CreatePlacementGrouprm rn r� )r= rT �strategyrv rS r rN rN rO �create_placement_group s
z$EC2Connection.create_placement_groupc C r� )a
Delete a placement group from your account.
:type key_name: string
:param key_name: The name of the keypair to delete
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
r= ri rj �DeletePlacementGrouprm rn r� )r= rT rv rS rN rN rO �delete_placement_group' r8 z$EC2Connection.delete_placement_groupc C sN t |�� �}d}|D ]}|| }||d| < |d ur ||d| < |d7 }q
d S )NrV z
Tag.%d.Keyz Tag.%d.Value)r �keys)r= rS r� r� r_ r� ra rN rN rO �build_tag_param_list9 s
�z"EC2Connection.build_tag_param_listc C sH i }|r
| � ||� |rd|d< |dur||d< | jd|dtfgdd�S ) a�
Retrieve all the metadata tags associated with your account.
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:type max_results: int
:param max_results: The maximum number of paginated instance
items per response.
:rtype: list
:return: A list of :class:`boto.ec2.tag.Tag` objects
ri rj Nr� � DescribeTagsrl rm rn )rd rr r# )r= r^ rv r� rS rN rN rO � get_all_tagsC s
�zEC2Connection.get_all_tagsc C s: i }| � ||d� | �||� |rd|d< | jd|dd�S )a
Create new metadata tags for the specified resource ids.
:type resource_ids: list
:param resource_ids: List of strings
:type tags: dict
:param tags: A dictionary containing the name/value pairs.
If you want to create only a tag name, the
value for that tag should be the empty string
(e.g. '').
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
�
ResourceIdri rj �
CreateTagsrm rn )rq r� r� �r= � resource_idsr� rv rS rN rN rO � create_tagse s zEC2Connection.create_tagsc C sP t |t�r i �|d�}i }| �||d� | �||� |r d|d< | jd|dd�S )a�
Delete metadata tags for the specified resource ids.
:type resource_ids: list
:param resource_ids: List of strings
:type tags: dict or list
:param tags: Either a dictionary containing name/value pairs
or a list containing just tag names.
If you pass in a dictionary, the values must
match the actual tag values or the tag will
not be deleted. If you pass in a value of None
for the tag value, all tags with that name will
be deleted.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
Nr� ri rj �
DeleteTagsrm rn )rY r] �fromkeysrq r� r� r� rN rN rO � delete_tags} s
zEC2Connection.delete_tagsc C r� )a�
Retrieve all of the Elastic Network Interfaces (ENI's)
associated with your account.
:type network_interface_ids: list
:param network_interface_ids: a list of strings representing ENI IDs
:type filters: dict
:param filters: Optional filters that can be used to limit
the results returned. Filters are provided
in the form of a dictionary consisting of
filter names as the key and filter values
as the value. The set of allowable filter
names/values is dependent on the request
being performed. Check the EC2 API guide
for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: list
:return: A list of :class:`boto.ec2.networkinterface.NetworkInterface`
r4 ri rj �DescribeNetworkInterfacesrl rm rn )rq rd rr r' )r= �network_interface_idsr^ rv rS rN rN rO �get_all_network_interfaces� r� z(EC2Connection.get_all_network_interfacesc C s� d|i}|r
||d< |r||d< |r1g }|D ]}t |t�r$|�|j� q|�|� q| �||d� |r7d|d< | jd|tdd �S )
a�
Creates a network interface in the specified subnet.
:type subnet_id: str
:param subnet_id: The ID of the subnet to associate with the
network interface.
:type private_ip_address: str
:param private_ip_address: The private IP address of the
network interface. If not supplied, one will be chosen
for you.
:type description: str
:param description: The description of the network interface.
:type groups: list
:param groups: Lists the groups for use by the network interface.
This can be either a list of group ID's or a list of
:class:`boto.ec2.securitygroup.SecurityGroup` objects.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.networkinterface.NetworkInterface`
:return: The newly created network interface.
r� r� r� r� ri rj �CreateNetworkInterfacerm rn )rY r r� r� rq r� r' ) r= r r r� r� rv rS �idsr rN rN rO �create_network_interface� s"
�z&EC2Connection.create_network_interfacec C s( |||d�}|r d|d< | j d|dd�S )aJ
Attaches a network interface to an instance.
:type network_interface_id: str
:param network_interface_id: The ID of the network interface to attach.
:type instance_id: str
:param instance_id: The ID of the instance that will be attached
to the network interface.
:type device_index: int
:param device_index: The index of the device for the network
interface attachment on the instance.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
)r4 r� � DeviceIndexri rj �AttachNetworkInterfacerm rn r� )r= r� r� � device_indexrv rS rN rN rO �attach_network_interface� s �z&EC2Connection.attach_network_interfacec C s0 d|i}|r
d|d< |rd|d< | j d|dd�S )aZ
Detaches a network interface from an instance.
:type attachment_id: str
:param attachment_id: The ID of the attachment.
:type force: bool
:param force: Set to true to force a detachment.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
� AttachmentIdri r rj �DetachNetworkInterfacerm rn r� )r= r= r rv rS rN rN rO �detach_network_interface s z&EC2Connection.detach_network_interfacec C r� )a
Delete the specified network interface.
:type network_interface_id: str
:param network_interface_id: The ID of the network interface to delete.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
r4 ri rj �DeleteNetworkInterfacerm rn r� )r= r� rv rS rN rN rO �delete_network_interface r8 z&EC2Connection.delete_network_interfacec C s i }| j d|dtfgdd�S )z�
Get all instance_types available on this cloud (eucalyptus specific)
:rtype: list of :class:`boto.ec2.instancetype.InstanceType`
:return: The requested InstanceType objects
�DescribeInstanceTypesrl rm rn )rr r$ )r= rS rN rN rO �get_all_instance_types- s z$EC2Connection.get_all_instance_typesc
C s� ||d�} |dur
|| d< |dur|| d< |dur || d< |dur)|r%dnd| d< |dur1|| d < |r7d| d
< | j d | td d
�S )z�
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:rtype: :class:`boto.ec2.image.CopyImage`
:return: Object containing the image_id of the copied image.
)r� �
SourceImageIdNr� r� r� ri r3 r� r� rj r rm rn )r� r )
r= r� �source_image_idrT r� r rv r� r� rS rN rN rO �
copy_image7 s$
�
�zEC2Connection.copy_imagec C r� ) r' N�
AttributeNameri rj �DescribeAccountAttributesrl rm rn )rq rr r( )r= �attribute_namesrv rS rN rN rO �describe_account_attributesS s
�z)EC2Connection.describe_account_attributesc C s6 d|i}|dur ||d< |rd|d< | j d|tdd�S ) r' rD Nr� ri rj �DescribeVpcAttributerm rn )r� r) )r= rF r� rv rS rN rN rO �describe_vpc_attributea s ��z$EC2Connection.describe_vpc_attributec C sT d|i}|dur|r dnd|d< |dur |rdnd|d< |r"d|d< | j d|d d
�S ) r' rD Nri r3 zEnableDnsSupport.ValuezEnableDnsHostnames.Valuerj �ModifyVpcAttributerm rn r� )r= rF �enable_dns_support�enable_dns_hostnamesrv rS rN rN rO �modify_vpc_attributeq s �
�
�z"EC2Connection.modify_vpc_attributec C sf i }|r | � ||d� |r| �||� |rd|d< |dur!||d< |r'||d< | jd|dtfgd d
�S ) aG
Get all of your linked EC2-Classic instances. This request only
returns information about EC2-Classic instances linked to
a VPC through ClassicLink
:type instance_ids: list
:param instance_ids: A list of strings of instance IDs. Must be
instances linked to a VPC through ClassicLink.
:type filters: dict
:param filters: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a
dictionary consisting of filter names as the key and
filter values as the value. The set of allowable filter
names/values is dependent on the request being performed.
Check the EC2 API guide for details.
:type dry_run: bool
:param dry_run: Set to True if the operation should not actually run.
:type max_results: int
:param max_results: The maximum number of paginated instance
items per response.
:rtype: list
:return: A list of :class:`boto.ec2.instance.Instance`
r� ri rj Nr� r� � DescribeClassicLinkInstancesrl rm rn )rq rd rr r )r= r� r^ rv r� r� rS rN rN rO � get_all_classic_link_instances� s
�z,EC2Connection.get_all_classic_link_instances)NNTNNNNNNr NNr3 NNTN)NNNNF)NNF)F)
NNNNNNNNFNNNF)FF)NFNF)r� F)r� r� NNNF)NNFN)NNFNN)NNNNFF)rV rV NNNNr� NNNFNNFNNNNNNNNNFNF)NF)NFF) NNNNNFNNN)rV r_ NNNNNNNNr� NNNFNNNNNNFNF)NNNF)NNNFF)NNNNNFF)r� F)NNNFNF)NNFF)r� r� r� T)r" F)r" r� NNF)NNNNNNF)
NNNNNNNNNF)NNNNNNNNNNNNNF)rV NF)NNN)r� F)NFN)NNNFNN)|�__name__�
__module__� __qualname__r r� r� r< r6 r7 r, r- r: rP rU rd rw r} r� r� r� r� r� r� r� r� r� r� r� r� r r r r" r$ r& r, r0 rA rM rO rT r^ rs ru ry r~ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r! r% r' r) r, r1 r5 r7 r< rB rG rJ r[ re rj rl rm ro ru r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r �
__classcell__rN rN rL rO r. I s�
��
�
.
�
a$
�1
� �,
� �) �, �4 �7 � r
�
) �I
�
B
�) �P �
`
% � * �4 � �0 �0
�
�'
�
%#
�
/ �
� �
9
�-
� 6
�' � � �) �
, �* �
( �; �b
�' �A �Y
�
@) �z
�% �*
�G � % �
*
�(
�
"
� $
"
" �/
�
�
�
��r. )M�__doc__r� r� r r r � boto.authr �boto.connectionr �boto.resultsetr �boto.ec2.imager r r �boto.ec2.instancer
r r r
�boto.ec2.keypairr �boto.ec2.addressr �boto.ec2.volumer r �boto.ec2.snapshotr r �
boto.ec2.zoner �boto.ec2.securitygroupr �boto.ec2.regioninfor �boto.ec2.instanceinfor �boto.ec2.reservedinstancer r r r r r � boto.ec2.spotinstancerequestr �boto.ec2.spotpricehistoryr �!boto.ec2.spotdatafeedsubscriptionr �boto.ec2.bundleinstancer! �boto.ec2.placementgroupr" � boto.ec2.tagr# �boto.ec2.instancetyper$ �boto.ec2.instancestatusr% �boto.ec2.volumestatusr& �boto.ec2.networkinterfacer' �boto.ec2.attributesr( r) �boto.ec2.blockdevicemappingr* r+ �boto.exceptionr, � boto.compatr- r. rN rN rN rO �<module> sT