ec2objects, represents all aws ec2 services as objects, hiding all those horrible api calls.
Project description
ec2 objects (pip3 install ec2objects)
everyone: I wish, for once, to just have a simple object oriented experience with the api.
ec2objects:
Please visit GitHub page for documentation that has navigation that works.
Table of Contents
How to install
Here are your options.
Install from pypi repository
The most popular way is to install the latest package available on pypi.
You can install ec2objects using pip3
pip3 install -U ec2objects
You can uninstall if you like using,
pip3 uninstall ec2objects
Install from the cloned git hub repo
There are a few ways to install this python package from a clone of its github repo. Check out a copy and try the following...
Build a .tar.gz install package
From the root of the repo build a repo, and check the repo.
python3 setup.py sdist
twine check dist/*
Check the newly created dist directory for newly created .tar.gz files. This is your .tar.gz package and you can install using...
pip3 install ./dist/ec2objects-0.0.17.tar.gz
You can still uninstall using the same commands,
pip3 uninstall ec2objects
Install using the setup.py file
!WARNING! Install does not track which files, and where they are placed. So, you need to keep a record of there python3 does this.
This is how... from the github repo root directory.
sudo python3 setup.py install --record files.txt
You can uninstall using by playing back that files.txt file,
sudo xargs rm -rf < files.txt
Local interactive install
Using this method you can modify this packages code and have changes immediately available. Perfect for if you want to tinker with the library, poke around and contribute to the project.
From the cloned repository root directory.
pip3 install -e ./
You can uninstall using the usual command,
pip3 uninstall ec2objects
Configurations
BOTO 3
ec2objects uses boto3 to interact with the amazon api. Decided to go with boto3 as it gives nice json responses instead of the xml mess direct interaction with the api gives.
You can find further token requirements and details at the above link.
Here is are the quick start requirements for ec2objects.
Token: Required
Set the AWS_ACCESS_KEY_ID, and the AWS_SECRET_ACCESS_KEY environment variables with your amazon aws access credentials.
export AWS_ACCESS_KEY_ID='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
export AWS_SECRET_ACCESS_KEY='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Default Region: Required
Please set the AWS_DEFAULT_REGION environment variable to a region you know you have enabled for your credentials.
For example:
export AWS_DEFAULT_REGION='us-east-1'
For relivent commands you can specify a completely different region if you need to act on a different region.
Regions
An AWS Region is a collection of AWS resources in a geographic area.
Each AWS Region is isolated and independent of the other Regions.
Regions provide fault tolerance, stability, and resilience, and can also reduce latency. They enable you to create redundant resources that remain available and unaffected by a Regional outage.
Import the ec2object Region and RegionManger to interact with Regions.
from ec2objects import Region, RegionManager
Region Manager
Create a region manager.
region_manager = RegionManager()
Retrieve All Regions
Retrieve a list of region objects.
list_of_all_region_objects = region_manager.retrieve_all_regions()
Retrieve Regions Enabled For Your Account
Retrieve a list of region objects enabled for your account.
list_of_enabled_region_objects = region_manager.retrieve_regions_enabled_for_my_account()
Region Object
Region objects contains an attributes data class with the standard ec2 region attributes.
Region objects also contain a list of availability zones data classes for that region.
class Region:
def __init__(self):
self.attributes = RegionAttributes()
self.availabilityzones = []
...
@dataclass
class RegionAttributes:
RegionName: str = None
Endpoint: str = None
OptInStatus: str = None
class AvailabilityZones:
State: str = None
OptInStatus: str = None
Messages: list = field(default_factory=list)
RegionName: str = None
ZoneName: str = None
ZoneId: str = None
GroupName: str = None
NetworkBorderGroup: str = None
ZoneType: str = None
ParentZoneName: str = None
ParentZoneId: str = None
Images
An Amazon Machine Image (AMI User Guide) provides the information required to launch an instance.
AMI BOTO3 API GUIDE details at this link.
An AMI includes the following:
-
One or more Amazon Elastic Block Store (Amazon EBS) snapshots, or, for instance-store-backed AMIs, a template for the root volume of the instance (for example, an operating system, an application server, and applications).
-
Launch permissions that control which AWS accounts can use the AMI to launch instances.
-
A block device mapping that specifies the volumes to attach to the instance when it's launched.
Import the ec2object Image and ImageManger to interact with Regions.
from ec2objects import Image, ImageManager
Image Manager
Create an image manager.
image_manager = ImageManager()
Retrieve All Amazon Public Images
Retrieve a list of image objects.
list_of_all_amazon_public_image_objects = image_manager.retrieve_all_regions()
Retrieve Image By ImageId
Retrieve an image object by ImageId.
image_object = image_manager.retrieve_image("ami-fd534b97")
Image Object
Image objects contains an attributes data class with the standard ec2 image attributes, descriptions available at this link.
Each object also contains a list of ebsblockdevices, and a list of virtuablockdevices - empty if none exists.
ebsblockdevices holds a list of BlockDeviceMappingEBS if they exist.
virtualblockdevices holds a list of BlockDeviceMappingVirtual if they exist.
class Image:
def __init__(self):
self.attributes = ImageAttributes()
self.ebsblockdevices = []
self.virtualblockdevices = []
@dataclass
class ImageAttributes:
Architecture: str = None
CreationDate: str = None
ImageId: str = None
ImageLocation: str = None
ImageType: str = None
Public: bool = None
KernelId: str = None
OwnerId: str = None
Platform: str = None
PlatformDetails: str = None
UsageOperation: str = None
RamdiskId: str = None
State: str = None
Description: str = None
EnaSupport: bool = None
Hypervisor: str = None
ImageOwnerAlias: str = None
Name: str = None
RootDeviceName: str = None
RootDeviceType: str = None
SriovNetSupport: str = None
VirtualizationType: str = None
BootMode: str = None
DepricationTime: str = None
@dataclass
class BlockDeviceMappingEBS:
DeviceName: str = None
SnapshotId: str = None
VolumeSize: str = None
DeleteOnTermination: bool = None
VolumeType: str = None
Encrypted: bool = None
@dataclass
class BlockDeviceMappingVirtual:
DeviceName: str = None
VirtualName: str = None
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.