# mypy-boto3-ec2
[![PyPI - mypy-boto3-ec2](https://img.shields.io/pypi/v/mypy-boto3-ec2.svg?color=blue)](https://pypi.org/project/mypy-boto3-ec2)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ec2.svg?color=blue)](https://pypi.org/project/mypy-boto3-ec2)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.EC2 1.17.23](https://boto3.amazonaws.com/v1/documentation/api/1.17.23/reference/services/ec2.html#EC2) service
compatible with
[VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright)
and other tools.
Generated by [mypy-boto3-buider 4.4.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-ec2](#mypy-boto3-ec2)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Service Resource annotations](#service-resource-annotations)
- [Other resources annotations](#other-resources-annotations)
- [Collections annotations](#collections-annotations)
- [Typed dictionations](#typed-dictionations)
## How to install
Install `boto3-stubs` for `EC2` service.
```bash
python -m pip install boto3-stubs[ec2]
```
## Usage
### VSCode
- Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[ec2]` in your environment: `python -m pip install 'boto3-stubs[ec2]'`
Both type checking and auto-complete should work for `EC2` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[ec2]` in your environment: `python -m pip install 'boto3-stubs[ec2]'`
Both type checking and auto-complete should work for `EC2` service.
No explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules.
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[ec2]` in your environment: `python -m pip install 'boto3-stubs[ec2]'`
- Run `mypy` as usual
Type checking should work for `EC2` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[ec2]` in your environment: `python -m pip install 'boto3-stubs[ec2]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `EC2` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`EC2Client` provides annotations for `boto3.client("ec2")`.
```python
import boto3
from mypy_boto3_ec2 import EC2Client
client: EC2Client = boto3.client("ec2")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: EC2Client = session.client("ec2")
```
### Paginators annotations
`mypy_boto3_ec2.paginator` module contains type annotations for all paginators.
```python
from mypy_boto3_ec2 import EC2Client
from mypy_boto3_ec2.paginator import (
DescribeAddressesAttributePaginator,
DescribeByoipCidrsPaginator,
DescribeCapacityReservationsPaginator,
DescribeCarrierGatewaysPaginator,
DescribeClassicLinkInstancesPaginator,
DescribeClientVpnAuthorizationRulesPaginator,
DescribeClientVpnConnectionsPaginator,
DescribeClientVpnEndpointsPaginator,
DescribeClientVpnRoutesPaginator,
DescribeClientVpnTargetNetworksPaginator,
DescribeCoipPoolsPaginator,
DescribeDhcpOptionsPaginator,
DescribeEgressOnlyInternetGatewaysPaginator,
DescribeExportImageTasksPaginator,
DescribeFastSnapshotRestoresPaginator,
DescribeFleetsPaginator,
DescribeFlowLogsPaginator,
DescribeFpgaImagesPaginator,
DescribeHostReservationOfferingsPaginator,
DescribeHostReservationsPaginator,
DescribeHostsPaginator,
DescribeIamInstanceProfileAssociationsPaginator,
DescribeImportImageTasksPaginator,
DescribeImportSnapshotTasksPaginator,
DescribeInstanceCreditSpecificationsPaginator,
DescribeInstanceStatusPaginator,
DescribeInstanceTypeOfferingsPaginator,
DescribeInstanceTypesPaginator,
DescribeInstancesPaginator,
DescribeInternetGatewaysPaginator,
DescribeIpv6PoolsPaginator,
DescribeLaunchTemplateVersionsPaginator,
DescribeLaunchTemplatesPaginator,
DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsPaginator,
DescribeLocalGatewayRouteTableVpcAssociationsPaginator,
DescribeLocalGatewayRouteTablesPaginator,
DescribeLocalGatewayVirtualInterfaceGroupsPaginator,
DescribeLocalGatewayVirtualInterfacesPaginator,
DescribeLocalGatewaysPaginator,
DescribeManagedPrefixListsPaginator,
DescribeMovingAddressesPaginator,
DescribeNatGatewaysPaginator,
DescribeNetworkAclsPaginator,
DescribeNetworkInsightsAnalysesPaginator,
DescribeNetworkInsightsPathsPaginator,
DescribeNetworkInterfacePermissionsPaginator,
DescribeNetworkInterfacesPaginator,
DescribePrefixListsPaginator,
DescribePrincipalIdFormatPaginator,
DescribePublicIpv4PoolsPaginator,
DescribeReservedInstancesModificationsPaginator,
DescribeReservedInstancesOfferingsPaginator,
DescribeRouteTablesPaginator,
DescribeScheduledInstanceAvailabilityPaginator,
DescribeScheduledInstancesPaginator,
DescribeSecurityGroupsPaginator,
DescribeSnapshotsPaginator,
DescribeSpotFleetInstancesPaginator,
DescribeSpotFleetRequestsPaginator,
DescribeSpotInstanceRequestsPaginator,
DescribeSpotPriceHistoryPaginator,
DescribeStaleSecurityGroupsPaginator,
DescribeSubnetsPaginator,
DescribeTagsPaginator,
DescribeTrafficMirrorFiltersPaginator,
DescribeTrafficMirrorSessionsPaginator,
DescribeTrafficMirrorTargetsPaginator,
DescribeTransitGatewayAttachmentsPaginator,
DescribeTransitGatewayConnectPeersPaginator,
DescribeTransitGatewayConnectsPaginator,
DescribeTransitGatewayMulticastDomainsPaginator,
DescribeTransitGatewayPeeringAttachmentsPaginator,
DescribeTransitGatewayRouteTablesPaginator,
DescribeTransitGatewayVpcAttachmentsPaginator,
DescribeTransitGatewaysPaginator,
DescribeVolumeStatusPaginator,
DescribeVolumesPaginator,
DescribeVolumesModificationsPaginator,
DescribeVpcClassicLinkDnsSupportPaginator,
DescribeVpcEndpointConnectionNotificationsPaginator,
DescribeVpcEndpointConnectionsPaginator,
DescribeVpcEndpointServiceConfigurationsPaginator,
DescribeVpcEndpointServicePermissionsPaginator,
DescribeVpcEndpointServicesPaginator,
DescribeVpcEndpointsPaginator,
DescribeVpcPeeringConnectionsPaginator,
DescribeVpcsPaginator,
GetAssociatedIpv6PoolCidrsPaginator,
GetGroupsForCapacityReservat